Documentação / guia prático
Transforme uma gravação de tela em um guia passo a passo.
Use a mesma gravação para criar um tutorial fácil de ler. Comece pela tarefa, revise o texto e faça cada passo terminar em algo que o leitor possa conferir.
Comece com uma tarefa completa.
Um bom guia tem um ponto de partida claro e um resultado visível. “Convide um colega” dá ao leitor uma tarefa para concluir. “Um tour pelas nossas configurações” entrega um conjunto de telas sem motivo para usá-las.
Antes de gravar, anote para quem é o guia, de que permissão a pessoa precisa e o que ela deve ver ao terminar. Mantenha essas respostas por perto enquanto captura o fluxo de trabalho.
Revise a narração antes de gerar o guia.
A fala explica uma tarefa de um jeito diferente das instruções escritas. Ela pode incluir um comentário à parte, uma correção ou uma referência como “clica naquele ali”. O roteiro revisado deve nomear os controles e explicar a ação em ordem.
Na Polysh, corrija nomes de produtos e rótulos de botões antes de gerar o guia. Mantenha o contexto útil, mas separe-o das ações que o leitor de fato precisa executar.
Confira a ação, a captura de tela e o resultado.
A Polysh transforma a narração revisada em passos agrupados, pré-requisitos, observações e resultados esperados. Trate o guia gerado como um rascunho a ser revisado.
- Ação: o passo diz o que fazer usando o nome do controle visível?
- Captura de tela: ela mostra a tela de que o leitor precisa naquele momento?
- Resultado: o leitor consegue saber se a ação funcionou?
Um passo com a captura de tela errada confunde. Se o guia gerado não tiver uma imagem adequada, escolha entre as candidatas capturadas ou deixe sem imagem até ter a certa. Verifique se há informações sensíveis antes de compartilhar.