O conteúdo conceitual ajuda as pessoas a entender um recurso ou um tópico fornecendo uma visão geral clara e de alto nível, uma explicação de como o recurso ou o tópico pode ajudá-las no percurso e um contexto, como casos de uso ou exemplos.
Criamos artigos de conceitos e seções conceituais em outros artigos. A maioria dos principais produtos, recursos ou assuntos tem seu próprio artigo de conceitos.
Decidir entre um artigo ou uma seção
Instruções ou tutoriais podem ter 1 a 2 breves frases introdutórias antes das etapas. Se mais explicações além de algumas frases forem necessárias, é quando devemos considerar se ela merece um lugar em um artigo de conceitos.
No entanto, devemos ser seletivos. Nem todo conceito ou seção "Sobre X" precisa de seu próprio artigo. Geralmente, isso se resume à quantidade de informações que serão úteis para o usuário que precisamos incluir.
Como escrever um conteúdo conceitual
Para ver o modelo de conteúdo conceitual, confira Modelos.
- Descreva em linguagem simples qual é o recurso, o produto ou o tópico.
- Descreva a finalidade dele e por que ele é útil para o leitor.
- Compartilhe casos de uso ou exemplos.
Títulos para conteúdo conceitual
Títulos curtos para artigos devem ser uma palavra ou uma frase substantiva. Se os artigos aparecerem em Conceitos na barra lateral, evite usar "Sobre", a menos que o artigo apareça em um título com o mesmo nome. Por exemplo: "Agente de codificação" e "Sobre o agente de codificação".
Cabeçalhos de seções conceituais em artigos começam com "Sobre [assunto]".
- Use um substantivo para descrever o assunto.
- Use: "Sobre code scanning"
- Evite: "Sobre a verificação de código em busca de vulnerabilidades"
Exemplos de conteúdo conceitual
- Artigos conceituais
- Seções conceituais em outros artigos
- "Sobre políticas de segurança" em Adicionar uma política de segurança a um repositório
- "Sobre o modo de manutenção" em Habilitar e programar o modo de manutenção