O conteúdo introdutório serve como ponto de partida para usar os produtos e recursos do GitHub. Esta seção deve conter apenas as informações essenciais mínimas de que um usuário precisa antes de passar para conceitos e instruções. Fazemos isso para ser concisos e também para que não pareça complicado apenas começar a usar um recurso.
Considerações sobre introdução
Introdução é um conjunto de artigos que deve ser fácil e rápido de examinar. Ele deve conter menos de cinco artigos e, idealmente, apenas dois:
- Início Rápido
- Sobre [PRODUCT] (ou "O que é [PRODUTO]")
A única exceção a isso pode ser com planos disponíveis e informações de cobrança, em que essas informações são necessárias para usar o produto ou o recurso.
Para obter mais informações sobre o conteúdo de início rápido, consulte Tipo de conteúdo de início rápido.
Especificamente, os artigos com essas informações não pertencem a Primeiros passos:
- Artigos que se enquadram no tipo de conteúdo de instruções.
- Etapas de configuração ou de cadastro: estas também são instruções passo a passo. Eles documentam como fazer algo na interface do usuário.
- Conteúdo útil para começar a usar um recurso específico, mas não toda a área do produto. Esse tipo de conteúdo pertence mais adequadamente aos Conceitos.
- Práticas recomendadas, em geral. Os usuários novos em um recurso não têm o contexto necessário para aproveitar ao máximo esses recursos.