Os guias de início rápido permitem que as pessoas realizem rapidamente uma tarefa discreta e concentrada ilustrando um fluxo de trabalho com apenas as etapas essenciais, em cerca de cinco minutos ou 600 palavras. Os guias de início rápido podem ser usados para configurar rapidamente uma nova ferramenta ou para realizar rapidamente outra tarefa. Para tarefas mais complexas, use um tutorial.
Os inícios rápidos são úteis quando alguém já entende o recurso ou o produto e está pronto para experimentá-lo.
Em conjunto, nós nos referimos aos tutoriais e aos guias de início rápido como "guias" em todo o site. Nas páginas de aterrissagem de /guides, incluímos tutoriais, guias de início rápido e alguns artigos de procedimentos na lista de guias de um conjunto de documentação.
Como escrever um guia de início rápido
Para ver o modelo de início rápido, confira Modelos.
Conteúdo dos guias de início rápido:
- Introdução
- Destaca que este guia é rápido e pontual usando frases como:
- Adicionar rapidamente o [RECURSO] ao seu projeto
- Informações básicas para começar a usar o [PRODUTO]
- Um guia abreviado para as pessoas que estão familiarizadas com o [RECURSO]
- Esclarece o público-alvo
- Indica claramente os pré-requisitos e o conhecimento prévio necessário
- Indica o que alguém realizará ou criará
- Destaca que este guia é rápido e pontual usando frases como:
- Seções de procedimentos
- Com base no público-alvo do guia de início rápido, as etapas podem ser menos explícitas e formais do que aquelas usadas no conteúdo de procedimentos. Você não precisa usar reutilizáveis existentes para formar essas etapas se o público-alvo não necessita desse nível de detalhes.
- Forneça links para outros artigos ou recursos em vez de replicá-los, a fim de evitar interromper o fluxo de informações.
- Forneça indicações visuais. Use amplamente blocos de código e capturas de tela para ajudar a tranquilizar as pessoas de que elas estão executando as ações corretas.
- Solução de problemas (opcional)
- Se houver um conteúdo de solução de problemas relevante para o guia de início rápido, forneça links para ele.
- Próximas etapas
- Forneça uma recapitulação rápida do que foi realizado no guia de início rápido como um meio de fazer a transição para as próximas etapas.
- Inclua duas a três próximas etapas práticas que alguém possa realizar depois de concluir o guia de início rápido. Sempre forneça links para o conteúdo conceitual no recurso ou no produto. Vincule também outras informações relacionadas no docs.github.com ou no GitHub Skills.
Diretrizes para títulos de guias de início rápido
- Quando o guia ajudar alguém a começar a usar uma nova ferramenta, antes do título, coloque "Guia de Início Rápido", por exemplo, "Guia de Início Rápido do GitHub Actions" ou "Guia de Início Rápido: Título de procedimentos".
- Para outros casos de uso, siga as diretrizes de título para procedimentos e omita a palavra "Guia de Início Rápido".