Contribuir para a documentação do GitHub Docs
Saiba mais sobre como a equipe do GitHub Docs cria a documentação e como você pode contribuir.
Recomendado
Sobre a contribuição com o GitHub Docs
Você pode contribuir com o conteúdo do GitHub Docs de várias maneiras.
Melhores práticas para documentos do GitHub
Siga estas melhores práticas para criar uma documentação fácil de usar e de entender.
Guia de estilo
Siga este guia para garantir que a documentação do GitHub permaneça consistente e siga padrões claros que nossos leitores possam entender.
Artigos
Anotar exemplos de código
Você pode anotar exemplos de código mais longos para explicar como eles funcionam e como as pessoas podem personalizá-los para outros usos.
Como alterar o título de um artigo
Quando é necessário alterar o título de um artigo, talvez seja preciso atualizar o nome em vários locais.
Como criar alternadores de ferramentas em artigos
Use um alternador de ferramentas para mostrar como realizar tarefas usando ferramentas específicas.
Como criar capturas de tela
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.
Como criar um ambiente local
Você pode executar o aplicativo do GitHub Docs localmente no computador.
Como criar um conteúdo reutilizável
Você pode criar um conteúdo reutilizável que pode ser referenciado em vários arquivos de conteúdo.
Como escrever um conteúdo para tradução
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.
Como trabalhar no GitHub Docs em um codespace
Use o GitHub Codespaces para trabalhar na documentação do GitHub Docs.
Como usar Markdown e Liquid no GitHub Docs
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.