Skip to main content

Como escrever para o GitHub Docs

Saiba mais sobre como escrever para GitHub Docs.

Melhores práticas para documentos do GitHub

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

Sobre a filosofia de documentação do GitHub

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

Princípios de design de conteúdo

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

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.

Tornar o conteúdo localizável na pesquisa

Siga estas práticas recomendadas de SEO para ajudar os usuários a encontrar a documentação da GitHub usando mecanismos de pesquisa.

Documentação de controle de versão

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

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.

Usar front matter YAML

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

Como usar vídeos no GitHub Docs

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

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 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.

Criando diagramas para o GitHub Docs

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

Como criar alternadores de ferramentas em artigos

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

Configurar os redirecionamentos

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.

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.

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.

Modelos

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