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 conceituais e seções conceituais dentro de outros artigos. A maioria dos principais produtos, recursos ou assuntos tem um artigo conceitual próprio.
Como escrever um conteúdo conceitual
Para o modelo de conteúdo conceitual, consulte "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.
- Se for relevante, descreva como o recurso ou o tópico funciona (esteja atento ao público-alvo e ao local certo para aprofundamento nos detalhes técnicos).
- Destaque todos os detalhes que o leitor precisa saber para usar o recurso.
- Inclua as próximas etapas para começar a usar o recurso (seja por meio de links de leitura adicional ou de conteúdo no próprio artigo).
Títulos para conteúdo conceitual
- Os artigos conceituais ou os cabeçalhos de seções conceituais começam com "Sobre [assunto]".
- Use um substantivo para descrever o assunto.
- Use: "Sobre a 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