Como escrever para o GitHub Docs

Siga estas melhores práticas para criar uma documentação fácil de usar e de entender.

Nossa filosofia de documentação orienta qual conteúdo criamos e como o criamos.

Nossa documentação é traduzida para vários idiomas. A forma como abordamos a escrita da documentação em inglês pode aprimorar muito a qualidade dessas traduções.

Compartilhamos esses princípios para projetar e criar o melhor conteúdo para as pessoas que usam o GitHub.

GitHub Docs usa operadores YAML frontmatter e liquid para dar suporte a várias versões do GitHub com uma abordagem de origem única.

Você pode usar Markdown e Liquid para formatar conteúdo, criar conteúdo reutilizável e escrever conteúdo para diferentes versões em GitHub Docs.

Você pode usar o front matter YAML para definir o controle de versão, adicionar metadados e controlar o layout dos artigos.

Este guia explica como criar vídeos que dão suporte às necessidades do usuário no GitHub Docs.

Você pode criar um conteúdo reutilizável que pode ser referenciado em vários arquivos de conteúdo.

Você pode ajudar os usuários a localizar elementos de interface do usuário que são difíceis de encontrar adicionando capturas de tela ao GitHub Docs.

Este guia explica quando e como criar diagramas para o GitHub Docs.

Use um alternador de ferramentas para mostrar como realizar tarefas usando ferramentas específicas.

Se o título, a versão ou o local de um artigo forem alterados, você poderá criar um redirecionamento para o conteúdo atual.

Quando é necessário alterar o título de um artigo, talvez seja preciso atualizar o nome em vários locais.

Você pode anotar exemplos de código mais longos para explicar como eles funcionam e como as pessoas podem personalizá-los para outros usos.

Este artigo contém modelos iniciais para os diferentes tipos de conteúdo usados no GitHub Docs.