O conteúdo de procedimentos ajuda as pessoas a concluir uma tarefa do início ao fim enquanto usam o GitHub.
Criamos artigos e seções de procedimentos em artigos maiores.
Como escrever artigos de procedimentos
Para o modelo de conteúdo de procedimentos, confira Modelos.
- Siga as diretrizes de estilo para as etapas de procedimentos em Guia de estilo.
- O conteúdo de procedimentos pode ficar repetitivo. Busque oportunidades de agrupar o conteúdo relacionado em um artigo mais longo.
- Agrupe vários procedimentos relacionados em um só artigo, a menos que haja um motivo para não fazer isso.
- Se desabilitar uma configuração ou desfazer uma tarefa exigir as mesmas etapas e não tiver implicações especiais, não escreva um procedimento separado.
- Se desabilitar uma configuração ou desfazer uma tarefa exigir etapas diferentes ou tiver implicações importantes ou especiais, crie um artigo mais longo para conter ambos os procedimentos. Use um título neutro.
- Informe aos leitores o resultado esperado do procedimento.
- Inclua dicas de solução de problemas com a maior frequência possível.
Títulos para conteúdo de procedimentos
- Os artigos ou as seções de procedimentos em artigos são baseados em tarefas e começam com a estrutura Como + verbo.
- Use: "Como solicitar um pacote de desenvolvedor para estudantes"
- Use verbos ativos e específicos (faça um brainstorming ou use um dicionário de sinônimos quando necessário).
- Os títulos descrevem especificamente a tarefa contida no artigo ou no cabeçalho, mas são gerais o suficiente para refletir todo o conteúdo.
- Tamanho do título do artigo: no máximo, 80 caracteres, 60, se possível.