Anatomia de um artigo da Base de Conhecimento

Esta é a introdução onde te dar um contexto para este artigo e um breve resumo do que está nele. Ao fazer isso, você pode rapidamente determinar se este é o artigo certo para você.

Neste caso, você quer aprender a escrever artigos de ajuda para o Suporte Mozilla. Portanto, neste artigo, vou mostrar-lhe exemplos de técnicas de escrita mais comuns e marcações wiki que usamos. Você pode usar tanto o artigo e sua wiki source como um guia quando você escreve.

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

  • Tutorial ou Como fazer: Um breve resumo do recurso ou tarefa e o que pode ser aprendido (exemplo).
  • Solução de problemas: Um breve resumo dos sintomas e a solução (exemplo).

Como estruturar um artigo

A idéia geral aqui é tentar construir habilidades do simples ao complexo, enquanto tenta manter as informações necessárias para a maioria das pessoas perto do topo. Então, uma solução simples e comum que geralmente vêm antes de uma solução complexa.

Por exemplo, no artigo grupo de abas vamos começar com, porque você deve usar o recurso, em seguida, passar para como fazer um grupo e acabar com as tarefas mais complicadas, como a busca e organização.

Escrever títulos das seções descritivas que os leitores possam verificar rapidamente

Ao nomear a seção após a tarefa ou a solução permite que as pessoas procurarem rapidamente o artigo e efetuar uma varredura do índice para ver o alcance do artigo. Em alguns casos essas informações são suficiente para alguns usuários e eles nem sequer precisam ler o resto do artigo.

Criar instruções passo-a-passo

Não há nada mais frustrante do que finalmente encontrar as instruções que você precisa e, em seguida, ficar preso ao tentar segui-las porque o escritor assumiu que você sabia algo que não fez. É por isso que nós dividimos nossas instruções em passos numerados. Até se tem que clicar em "OK" em algum momento, fazemos um passo.

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

  1. Abra uma aba com a página web que deseja usar como sua página inicial.
  2. Arraste a aba para o botão Home Home Button e solte-a.
    Home Page 29 - WinXPHome Page 29 - Win8Home Page 29 - MacHome Page 29 - Linux
  3. Clique em sim para definir esta página como sua página inicial.

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

Muitas vezes, as instruções do Firefox são diferentes para diferentes sistemas operacionais. Temos marcações wiki especiais que nos permite mostrar as instruções do Windows para usuários de Windows e instruções do Mac para usuários de Mac. Se você trocar o sistema operacional no topo deste artigo os passos abaixo vão mudar.

Dica: Olhe para o wiki source para ver como ele é feito (Por favor, não mude o artigo).

  1. Clique no menu New Fx Menu e depois em Opções.
  2. Selecione o painel Geral.
  3. Na caixa iniciar, clique em Restaurar Padrão.
    HomePage-Fx34Win
  4. Clique em OK para fechar a janela Opções.

  1. Clique no menu New Fx Menu e depois em Preferências
  2. Selecione o painel Geral.
  3. Na caixa iniciar, clique em Restaurar Padrão.
    HomePage-Fx34Mac
  4. feche a janela preferências.

  1. Clique no menu New Fx Menu e depois em Preferências
  2. Selecione o painel Geral.
  3. Na caixa iniciar, clique em Restaurar Padrão.
    HomePage-Fx34Lin
  4. Clique fechar parafechar a janela de preferências.

Use templates em suas instruções passo-a-passo

Há uma série de passos comuns em artigos do Firefox. Para estes nós criamos "templates" de modo que não temos que escrever (e traduzir) mais uma outra vez. Normalmente templates têm instruções para todos os sistemas operacionais neles, o que torna escrever os passos ainda mais fácil. Aqui estão os mesmos passos mostrados acima, mas escrito usando.

Dica: Certifique-se de olhar para o wiki source para ver como ele é feito (por favor não edite qualquer coisa).
  1. Na barra de menu no alto da tela, clique em Firefox e selecione Preferências.Clique no menu Fx57Menu e selecione OpçõesPreferências.Clique no menu Fx89menuButton e selecione Configurações.
  2. Selecione o painel Geral.
  3. Na caixa Iniciar, clique Restaurar Padrão
    HomePage-Fx34WinHomePage-Fx34MacHomePage-Fx34Lin
  4. Feche a página about:preferences. Quaisquer alterações feitas são salvas automaticamente.

Nota: Esta é uma lista de todos os nossos templates. E você pode aprender mais sobre como usar a marcação {for} neste artigo.

Este artigo foi útil?

Por favor, aguarde...

Essas pessoas ajudaram a escrever este artigo:

Illustration of hands

Torne-se um voluntário

Desenvolva e compartilhe sua especialidade com outras pessoas. Responda perguntas e aprimore nossa base de conhecimento.

Saiba mais