Esta introdução em vídeo te dá algum contexto sobre o artigo a seguir e uma breve visão geral do que há nele. Ao assistir o vídeo, você pode determinar rapidamente se este é o artigo certo para você.

Você quer aprender a escrever artigos de ajuda para o Mozilla Support? Este artigo mostra exemplos de nossas técnicas de escrita mais comuns e marcações wiki importantes. Você pode usar tanto o artigo quanto sua wiki source como um guia quando escrever um artigo.

Em geral, temos dois tipos básicos de artigos com dois tipos de introduções:

• Artigos de tutorial ou "como fazer": Um breve resumo do recurso ou tarefa e o que pode ser aprendido (exemplo).
• Artigos de solução de problemas: Um breve resumo dos sintomas e possíveis soluções (exemplo).

Como estruturar um artigo

A ideia geral aqui é tentar desenvolver habilidades do simples ao complexo, procurando manter as informações que a maioria das pessoas precisa perto do topo. Assim, uma solução simples e comum geralmente vem antes de uma solução complexa ou de um caso específico.

Escreva títulos de seção descritivos para que os leitores possam escanear rapidamente

Nomear o cabeçalho da seção com a tarefa ou a solução permite ao leitor navegar rapidamente pelo artigo ou escanear o índice para ver o escopo do artigo. Em alguns casos, isso já pode fornecer informações suficientes para alguns usuários e eles nem precisariam ler o resto do artigo.

Crie instruções passo a passo

Não há nada mais frustrante do que finalmente encontrar as instruções de que você precisa e ficar perdido ao tentar segui-las porque o autor presumiu que você sabia algo que não sabia. É por isso que dividimos nossas instruções em passos completos e numerados. Se você tiver que clicar em "OK" em algum momento, nós até definimos isso como um passo.

Aqui está um exemplo do artigo Como definir a página inicial:

1. Abra a página web que você quer usar como sua página inicial.
2. Arraste e solte essa aba no botão Home na sua barra de ferramentas.

   

3. Clique em Yes na solicitação para definir esta página como sua página inicial.

Crie instruções para diferentes sistemas operacionais ou versões do Firefox

Muitas vezes, as instruções do Firefox são diferentes para os diferentes sistemas operacionais. Temos uma marcação wiki especial que mostra instruções do Windows para usuários do Windows, instruções do Linux para usuários do Linux e instruções do Mac para usuários do Mac. Se você mudar o sistema operacional na caixa "Personalize este artigo" à direita, as instruções abaixo mudarão de acordo com o sistema operacional selecionado. Este exemplo é do artigo Saiba qual versão do Firefox você está usando.

Clique no botão de menu , clique em Help e selecione About Firefox.Na barra de menus, clique no menu Firefox e selecione About Firefox. A janela Sobre o Firefox aparecerá. O número da versão é listado abaixo do nome Firefox.

Use templates em suas instruções

Existem muitos passos comuns em artigos do Firefox. Para eles, criamos "templates" para que não tenhamos que escrevê-los (e traduzi-los) repetidamente. Geralmente, os templates incluem instruções para todos os sistemas operacionais, o que simplifica e acelera muito a escrita dos passos.

Este exemplo do artigo Como definir a página inicial inclui um template que dá instruções para abrir o painel de configurações do Firefox.

1. Na barra de menu no alto da tela, clique em Firefox e selecione Settings (selecione Preferences em versões mais antigas do macOS).Clique no menu e selecione Configurações.
2. Clique no painel Home.
   
3. Clique no menu ao lado de Homepage and new windows e escolha mostrar a página inicial padrão do Firefox, URLs personalizados ou uma página em branco.

Diretrizes da Base de Conhecimento

Para mais diretrizes sobre contribuição na Base de Conhecimento, consulte esta página.