Padrões e modelo de redação de artigos

Este modelo descreve os padrões para escrever artigos com conhecimento. Use os artigos da base de conhecimento da Apple como exemplo: https://support.apple.com/en-ca/HT207935

Título

O título do artigo deve refletir o conteúdo do artigo para facilitar o reconhecimento e facilitar a pesquisa.

Exemplos: "Como faço para excluir uma música?", "Bem-vindo ao Anytune iPhone / iPad"

Diretrizes

1. Evite criar artigos duplicados. Pesquise cuidadosamente antes de criar.
2. Comece com "Título 2" para títulos. O título do artigo é Título 1 e deve haver apenas um.
3. Coloque em letras maiúsculas os nomes dos produtos e os nomes dos botões de texto:
   Toque no botão Editar. Não use comandos em negrito.
4. Use a imagem da tabela de botões (svg) dimensionada para 22 pixels de altura quando o botão usa um ícone:
   Toque em Restaurar
5. Use aspas para selecionar as opções:
   3. Escolha "Música sintonizada" e "E-mail"
6. Para seguir uma hierarquias, use:
   Vá para o menu Anytune> Arquivos> Exportação de configuração> Exportar para arquivo ...
7. Use listas numeradas para as etapas de um procedimento.
   As etapas terminam em um período.
8. Os títulos dos procedimentos são H @ e terminam em dois pontos. Exemplo: "Título do procedimento:"
9. Quando as etapas são diferentes para as versões do produto, crie várias seções com cabeçalhos de descrição 3 títulos
10. Use marcadores para listas.
11. Mantenha o contexto do cliente
12. Lembre-se do público
13. Não faça referência a um cliente
14. Evite abreviações e acrônimos
15. Certifique-se de que todos os links funcionem

Etiquetas

Inclua rótulos apropriados nos artigos. Os rótulos influenciam a relevância da pesquisa do artigo e respondem aos resultados do bot. Eles também podem ser usados para criar listas de artigos.

Use uma única palavra sempre que possível e não use variações da mesma palavra. Use rótulos com moderação.
Exemplos: macOS, import, bluetooth, ReFrame

Modelo

---

---

Declaração resumida do que este artigo irá lhe dizer.

Use o Título 3 para o processo e para distinguir plataformas

1. Etapas do processo
2. Toque em Botão de ajuda
3. Escolha "Email"
4. Toque em Editar

No Mac, o processo para isso é

Nota: forneça notas em <p class = "anytune-note"> nota </p>

Aviso: forneça notas em <p class = "anytune-warning"> nota </p>

Enfatize destacando com <p class = "anytune-highlight"> nota </p>

Saiba mais (H3)

Diga ao usuário onde mais informações estão por meio dos links .

---

---

Como corrigir problemas

Quando o artigo descreve como resolver um problema, inclua estas seções

• Problema: descreva o problema e tente usar as palavras do cliente.
• Ambiente: descreva a instalação e configuração a que esta correção se aplica (opcional)
• Resolução: Estas são as etapas para resolver
• Causa: qual cenário causou ou pode ter causado o problema
• Rótulos: inclua palavras relacionadas ao artigo em questão para ajudar

Veja também

• Formatação de Artigo