Práticas recomendadas do tipo de artigo "Sobre"

Os artigos "Sobre" servem como a camada fundamental do SUMO. O seu objetivo é responder a perguntas do tipo "O que é…", ajudando os utilizadores a compreenderem a informação essencial sobre os nossos produtos, funcionalidades, ou serviços. Estes artigos fornecem uma visão geral ampla ou introduzem conceitos sem entrar em detalhes de procedimentos ou de solução de problemas.

Quando escrever um artigo "Sobre"

Deveria considerar escrever um artigo "Sobre" quando:

• Apresenta um novo produto, funcionalidade, ou serviço.
• É necessário explicar um conceito ou funcionalidade essencial para entender como utilizar um produto de maneira eficaz.
• Há uma atualização ou alteração significativa num produto, funcionalidade, ou serviço existente que requer uma nova explicação.

As melhores práticas para escrever artigos "Sobre"

• Conheça o seu público: saber que os artigos "Sobre" são frequentemente lidos por pessoas que podem não estar familiarizadas com o jargão técnico ou com as complexidades dos produtos da Mozilla. Procure escrever numa linguagem clara, simples e acessível para todos.
• Comece com uma definição clara: comece o seu artigo com uma definição clara e concisa do produto, funcionalidade, ou conceito que está a explicar. Evite utilizar termos técnicos sem explicações.
• Explique o significado: depois de definir o assunto, explique por que é importante. Como isto beneficia o utilizador? Qual o problema que este resolve? Por que foi desenvolvido?
• Forneça contexto: ajude o leitor a entender onde este produto, funcionalidade, ou serviço se enquadra no ecossistema da Mozilla.
• Utilize exemplos: os exemplos podem ajudar a esclarecer conceitos complexos. Se possível, inclua exemplos práticos que ilustrem a utilização ou impacto do assunto.

Estrutura dos artigos

• Título: o título deve corresponder ao assunto do artigo e ao que o utilizador está a procurar. Utilize letras maiúsculas no estilo de frase para os títulos de artigos. Limite o seu título a cerca de 60 carateres, já que o Google normalmente exibe os primeiros 50 a 60 carateres de uma etiqueta de título. Seja conciso, mas focado no utilizador.
• Resumo: o resumo dá uma ideia do que o artigo trata para ajudar o utilizador a decidir se está no lugar certo. Deve ser uma visão geral textual ou definição do conceito e focar no motivo pelo qual o utilizador deve preocupar-se com o conceito. Limite o resumo a 140 carateres, pois os mecanismos de pesquisa podem interromper qualquer coisa maior.
• Conteúdo essencial: evite criar parágrafos longos e texto denso. Utilize H2 para os títulos de secção. Divida o corpo nas seguintes secções para organizar o conteúdo em agrupamentos lógicos:
  • Parágrafos
  • Listas não ordenadas (reserve a utilização de listas ordenadas para artigos de “Tarefa”)
  • Tabelas
  • Gráficos (capturas de ecrã/GIFs)
• Hiperligações de "Saber mais": utilize H3 para o cabeçalho da secção de "Saber mais". Este não deve ser incluído no índice. Adicione listas não ordenadas às hiperligações de "Saber mais" e não adicione mais de quatro hiperligações a esta secção.

Exemplos

• Página do «Novo Separador» no Firefox