A Polysh para agentes está em acesso antecipado. Seu agente de programação grava a demo, e a Polysh finaliza. Entrar na lista de espera →

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.

Um briefing simples: um administrador do espaço de trabalho quer convidar um colega. Ele precisa de permissão para convidar e do e-mail do colega. A tarefa está concluída quando o convite aparece como pendente.

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.

Publique uma referência que as pessoas possam usar.

Baixe o guia revisado em PDF ou compartilhe-o com o público certo. Para um guia que acompanha um vídeo, mantenha o mesmo propósito mesmo que o texto seja diferente: o vídeo explica o caminho; o guia ajuda a pessoa a percorrê-lo.

Quando o fluxo de trabalho mudar, atualize o roteiro e revise o guia de novo. Gerar o guia outra vez substitui as edições dele nos idiomas selecionados, então preserve as alterações manuais importantes antes de gerar novamente.

Uma explicação mais clara começa aqui.

Veja o exemplo

Acompanhe um convite de equipe fictício, da explicação crua ao guia útil.

Explorar um exemplo

Mais guias práticos

Ideias úteis sobre narração, documentação e compartilhamento.

Navegar pelo blog

Ferramentas gratuitas relacionadas

Adicionar passos numerados à captura de tela

Coloque selos de passos numerados que seguem a ordem das suas instruções escritas.

Abrir ferramenta

Recortador de capturas de tela

Corte uma captura de tela ou foto exatamente na área que você quer mostrar.

Abrir ferramenta

Gerador de listas numeradas

Transforme linhas de passos numa lista numerada com subpassos numerados.

Abrir ferramenta

Pré-visualizador de Markdown

Veja o Markdown renderizado como página formatada enquanto digita e copie o HTML.

Abrir ferramenta