Guia de estilo e modelo de conteúdo

Siga este guia para garantir que a documentação do GitHub permaneça consistente e siga padrões claros que nossos leitores possam entender.

O modelo de conteúdo descreve a estrutura e os tipos de conteúdo que publicamos.

Cada artigo inclui alguns elementos padrão e pode incluir elementos condicionais ou opcionais. Também usamos uma ordem padrão para o conteúdo de um artigo.

Use tópicos para tornar os artigos pesquisáveis.

As pessoas costumam usar um conteúdo conceitual quando estão aprendendo sobre algo novo para elas.

O conteúdo referencial fornece informações detalhadas de que as pessoas precisam enquanto estão usando ativamente um recurso.

O conteúdo de procedimento fornece contexto sobre como uma tarefa se encaixa no objetivo maior de alguém.

A solução de problemas de conteúdo inclui erros internos que esperamos que as pessoas encontrem, problemas comuns relatados ao suporte e situações que as pessoas podem encontrar ao realizar as tarefas.

As notas de versão permitem que os leitores entendam e se preparem para as alterações voltadas para os usuários em cada versão dos produtos empresariais com controle de versão do GitHub.

Os inícios rápidos são melhores para pessoas que querem instruções rapidamente, sem longas explicações sobre como algo funciona ou por que gostariam de usá-lo.

Os tutoriais são úteis quando alguém tem uma compreensão básica do produto e tem interesse em ampliar a compreensão para resolver um problema específico

Você pode combinar vários tipos de conteúdo em um único artigo para ajudar as pessoas a concluir tarefas complexas.