Templates
Onboarding
Onboarding
Os artigos de onboarding apresentam aos novos usuários uma tecnologia, ferramenta ou sistema específico para facilitar a curva de aprendizado e permitir que eles se tornem mais eficientes e produtivos.
Neste guia, você verá o modelo de onboarding, as diretrizes gerais e exemplos de artigos de onboarding.
Este tipo de conteúdo é publicado apenas em inglês.
Certifique-se de revisar as diretrizes das Melhores práticas para escrever documentação.
Como escrever um artigo de onboarding
| Tema | Descrição |
|---|---|
| Foco nos aspectos fundamentais | Dê ênfase aos elementos essenciais que o usuário precisa entender para começar, como dependências críticas, configurações iniciais e etapas importantes de configuração. Evite sobrecarregar os usuários com configurações avançadas, a menos que sejam necessárias para o uso inicial. |
| Recursos visuais | Sempre que possível, inclua recursos visuais, como diagramas, capturas de tela ou fluxogramas. Eles ajudam a esclarecer processos complexos e proporcionam aos usuários uma referência rápida. Na seção de arquitetura, um diagrama bem identificado ajuda a ilustrar os componentes e as interações do sistema. |
| Instruções | Para seções como Quickstart, certifique-se de que cada etapa possa ser executada e, se necessário, inclua links para recursos adicionais que permitam aprofundar o entendimento. |
| Links para pré-requisitos e aprendizagem adicional | Use links para redirecionar os usuários para tecnologias, documentação e guias relacionados. Por exemplo, na seção Próximos passos, sugira configurações ou personalizações associadas e inclua links para recursos que ampliem ou complementem o conteúdo básico de onboarding. |
Modelo de onboarding
Modelo de onboarding
# Título[Indica qual a tecnologia usada nesta seção.]Ex.: Para trabalhar com {nome da tecnologia}, é necessário conhecer as seguintes tecnologias:[Adicione aqui as tecnologias que o usuário deve conhecer antes de começar a trabalhar.][Tecnologia 1](#)[Tecnologia 2](#)[Tecnologia 3](#)… ## Arquitetura da {nome da tecnologia}[Adicione aqui um diagrama que ilustre a arquitetura da tecnologia e a explique.]## Quickstart[Descreva as instruções para desenvolver um projeto usando a tecnologia, desde a instalação dos requisitos até a execução do projeto localmente. As etapas abaixo podem variar dependendo da tecnologia utilizada.]### 1. Configurações iniciais[Descreva os requisitos e a configuração inicial necessários antes de desenvolver o projeto.]### 2. Configurar o projeto[Dê instruções para configurar o ambiente de desenvolvimento e iniciar o projeto para executá-lo localmente.]### 3. Personalizar o storefront[Após executar o projeto localmente, descreva as opções de personalização disponíveis.]## Próximos passos[Sugira configurações ou etapas adicionais para quem concluiu a seção de quickstart e inclua o componente do card com links para as sugestões.]