Blog

Como escrever títulos e notas de passos que as pessoas leem

Publicado em · guias, escrita, documentação, dicas

Como escrever títulos e notas de passos que as pessoas leem

Os guias gravados criam o rascunho do título de cada passo. Transforme esses títulos em instruções, acrescente o motivo e o aviso, e mantenha cada passo curto.

Um guia gravado chega com a maior parte da estrutura pronta: capturas em ordem, marcas no clique, um título para cada passo. O que não chega pronto é o julgamento. Os títulos são descrições do que foi clicado, não instruções para quem está seguindo. Uma passada curta de edição resolve isso.

O rascunho já está lá

O InSnap monta o título de cada passo a partir do elemento que você clicou — "Abrir Ajustes", "Selecionar Notificações", "Ativar alertas por e-mail". É um padrão útil porque se baseia na interface real, não na sua memória dela.

Também não é uma instrução. "Selecionar Notificações" diz ao leitor o que aconteceu; "Abra a página Notificações" diz o que fazer. A diferença é pequena em um passo e óbvia em vinte.

EDITANDO O TÍTULO E A DESCRIÇÃO DE UM PASSO · 1280 × 800

Transforme o título em uma instrução

Três hábitos:

  • Comece pelo verbo. "Clique em Salvar alterações", não "Botão Salvar alterações". "Abra", "Escolha", "Digite", "Confirme" são claros; "o", "este" e "aqui" não são.
  • Mantenha uma ação por passo. Se o título precisa de "e", o passo provavelmente precisa ser dividido. Passos gravados já são pequenos; os editados devem continuar pequenos.
  • Nomeie o que o leitor vê. Use o rótulo da interface, não o nome interno que você usa. Se o botão diz "Publicar", escreva "Publicar", mesmo que a equipe chame de "entrar no ar".

Um teste útil de tamanho: o título deve caber em uma linha na lista de passos sem ser truncado. Se não couber, provavelmente é uma frase, não um passo.

Acrescente o motivo, não o óbvio

O campo de descrição é onde um guia deixa de ser um monte de capturas e começa a ser útil. O texto de exemplo diz bem: "por que este passo, com o que tomar cuidado".

Boas descrições respondem a uma de três perguntas:

  • Por que este passo existe? ("Isso evita que a alteração afete o catálogo publicado.")
  • O que muda depois dele? ("O status passa para Pendente até a próxima sincronização.")
  • O que dá errado se ele for pulado? ("A alteração é salva, mas nunca é publicada.")

Descrições ruins repetem o título com mais palavras. Se a descrição não mudaria o que o leitor faz, apague.

Use blocos de destaque para avisos

Nem toda nota pertence a um parágrafo. O editor de guias do InSnap tem três tipos de bloco de destaque — Dica, Aviso e Observação — que aparecem como caixas coloridas em todos os formatos de exportação.

  • Aviso para algo que pode causar perda de dados ou um estado quebrado.
  • Dica para um atalho ou um caminho mais rápido.
  • Observação para contexto útil, mas não obrigatório.

Blocos de destaque não são passos numerados, então não interrompem a sequência. Isso os torna o lugar certo para aquilo que você acabaria espremendo no título de um passo entre parênteses.

Divida passos longos em subpassos

Se um passo tem várias ações pequenas na mesma tela — abrir um menu, escolher um submenu, confirmar — faça da primeira ação um passo de nível superior e do resto subpassos. Eles aparecem como N.1, N.2 e recuados nas exportações, então o leitor enxerga a estrutura sem a numeração recomeçar.

Subpassos também mantêm a lista principal fácil de escanear: dez passos de nível superior com alguns subpassos leem melhor do que vinte passos planos.

Passos ocultos e notas no editor de guias

Oculte o que não ajuda

As gravações capturam coisas que não fazem parte do processo: um clique em uma notificação, uma troca de aba acidental, um desvio que você fez ao gravar. Selecione o passo e oculte-o. Passos ocultos são ignorados na exportação e a numeração continua contínua.

Ocultar é melhor do que apagar quando o passo contém uma captura útil que você pode querer depois, e melhor do que deixar quando ele confundiria o leitor.

Uma lista de verificação antes de exportar

VerificaçãoPor quê
Cada título começa com um verbo?Ele vira uma instrução
Cada passo é uma ação?Os subpassos cuidam do resto
Cada descrição acrescenta algo?Caso contrário, apague
Os avisos estão em blocos de destaque?Eles se destacam e não são numerados
Os passos irrelevantes estão ocultos?Menos ruído, a mesma numeração
Nomes e IDs foram ocultados?O guia pode ser compartilhado fora da equipe

Perguntas frequentes

Os títulos de passo gerados podem ser editados?

Sim. Clique no campo de título abaixo da tela e reescreva. A descrição abaixo aceita texto formatado, listas e links, e as alterações são salvas com o guia.

Qual é a diferença entre um subpasso e um bloco de destaque?

Um subpasso faz parte da sequência numerada (N.1, N.2) e geralmente tem a própria captura. Um bloco de destaque é um bloco Dica, Aviso ou Observação sem numeração que acrescenta contexto sem ser um passo.

Passos ocultos ainda aparecem na exportação?

Não. Passos ocultos são ignorados e os restantes são renumerados, então o guia exportado continua contínuo. O passo permanece no editor caso você queira trazê-lo de volta.

Sua próxima captura está a um atalho de distância.

macOS 14.4+ (Apple Silicon e Intel) · Windows 10+ (64 bits)