Documentação do produto
Ajude os usuários a concluir as tarefas que seu aplicativo suporta
Ofereça aos usuários guias práticos que expliquem as jornadas do aplicativo e os ajudem a concluir suas tarefas.
Transforme as funcionalidades do produto em instruções práticas
- Prepare o escopo dos guias
Revise as seções da documentação e o público a que se destinam.
- Responda às perguntas de conteúdo
Esclareça os fluxos de trabalho e as informações que um guia deve explicar.
- Acompanhe o serviço público
Examine o progresso da construção e o endereço do site de documentação.
Explique como usar o aplicativo
A documentação complementa a apresentação de um produto com instruções práticas. Comece pelos primeiros passos e depois oriente os usuários pelos fluxos de trabalho que o aplicativo realmente suporta.
A configuração da documentação mostra as definições das seções e as perguntas. Forneça um contexto que ajude a explicar uma tarefa na linguagem do usuário.
Mantenha o guia ligado ao aplicativo em funcionamento
Apoie uma primeira ação útil. Um guia de primeiros passos oferece aos novos usuários um caminho curto até o produto. Ele deve explicar por onde começar, quais informações são exigidas e qual resultado confirma que a tarefa foi concluída.
Explique um fluxo de trabalho recorrente. Um guia detalhado segue os rótulos e as ações reais do aplicativo. Pré-requisitos, etapas numeradas e um resultado esperado ajudam alguém a repetir uma tarefa de negócio sem interpretar uma descrição genérica da tela.
Responda a uma pergunta transversal. Algumas perguntas tratam de contas, custos ou publicação, e não de uma única tela. Uma FAQ oferece uma resposta concisa e leva ao guia correspondente, mantendo o procedimento em um só lugar em vez de duplicá-lo pelo site.
Mantenha os guias ligados ao produto
Revise a documentação depois de uma mudança significativa no aplicativo. Um guia deve usar os rótulos e o comportamento que os usuários realmente veem.
A documentação funciona em seu próprio serviço público. Coloque um link para ela no site e verifique os guias nos idiomas que seu projeto publica.
Ajude um usuário a concluir a próxima tarefa
Um guia prático explica por onde começar, quais informações são necessárias e como verificar o resultado. Seu valor está em ajudar o leitor a agir no aplicativo.
Use guias relacionados para continuar a jornada quando a tarefa abrange várias áreas. Revise a documentação quando uma tela mudar, para que as instruções continuem úteis depois de uma evolução.
Da funcionalidade acordada a uma ajuda útil
Prepare o escopo dos guias. Revise as seções da documentação e as tarefas que elas devem explicar. Mantenha claros o usuário pretendido e o comportamento do aplicativo.
Forneça o contexto que falta. Responda às perguntas sobre pré-requisitos, regras e resultados. O texto deve usar a interface real, e não controles inventados.
Revise depois da publicação e das mudanças. Siga um guia no aplicativo, verifique seus idiomas e links relacionados e volte a ele quando a tarefa subjacente mudar.
Facilite o uso do produto depois da primeira visita
Ofereça instruções que levem a um resultado, junto com a apresentação pública do que o aplicativo faz.
Perguntas sobre a documentação do produto
Uma página de recurso ajuda um potencial cliente a entender a funcionalidade e seu valor. Um guia ajuda um usuário a realizar a tarefa, com os controles reais, os pré-requisitos e o resultado. Eles se complementam.
As ferramentas de documentação mostram as definições das seções e as perguntas. Revise as tarefas que o aplicativo suporta, forneça o contexto que falta e acompanhe o progresso da redação.
O projeto publica os guias localizados disponíveis para o seu escopo. Revise cada idioma publicado para que ele mantenha o procedimento completo e os rótulos corretos da interface.
Depois de uma mudança que afete a tarefa, seus controles ou o resultado esperado. Compare o texto com o aplicativo em funcionamento, em vez de supor que as instruções originais continuam válidas.
Uma referência de endpoints pertence a um projeto com uma API ativa e em funcionamento. Use suas operações ativas e a referência real; rotas planejadas não bastam para documentar uma integração utilizável.