Português · How-to guide

Um guia prático em português, do jeito que se segue de verdade

Só há uma medida de qualidade em texto instrucional: o leitor consegue fazer depois. Tudo o mais é consequência disso.

Comece pelo ponto de partida do leitor

Escreva três coisas e deixe à vista: o que ele já sabe fazer, o que tem à mão e como é "pronto" — um resultado concreto, não um sentimento. "Um pão com miolo aberto", não "confiança para assar".

Analise a tarefa antes de escrever

Liste toda ação na ordem, inclusive as óbvias demais para mencionar: são exatamente onde o iniciante trava. Para cada uma, anote o que precisa estar pronto antes, o que ele faz, como sabe que deu certo e o que costuma dar errado.

Como escrever um passo

• Uma ação por passo. Se tem "e", provavelmente são dois.
• Comece pelo verbo: "Abra o arquivo", não "Você vai querer abrir o arquivo".
• Condição primeiro: "Se a massa grudar, acrescente farinha" — quem procura a própria situação acha no começo da linha.
• Diga o que ele deve estar vendo. Sem pontos de checagem, quem errou no passo quatro descobre no dezenove.
• Ponha o erro junto do passo, não num apêndice no fim que ninguém lê na hora.

Verifique tudo que é específico

Um modelo descreve com absoluta confiança um menu que não existe. Confira nomes de botões, versões, preços e limites legais contra a coisa real. Se o guia envolve eletricidade, gás, comida, remédio ou dinheiro, peça para alguém competente ler antes de publicar.

Teste com uma pessoa de verdade

A única verificação real é ver alguém seguir o guia sem a sua ajuda. Três leitores do público-alvo encontram quase tudo. Observe onde a pessoa hesita (o passo está ambíguo), onde volta atrás (você trocou a ordem) e o que ela pergunta — a resposta vira texto, naquele passo, com as palavras dela.

Resolvendo problemas, do jeito que se procura

Organize a seção de problemas pelo que a pessoa vê, nunca pela causa: ela não consegue procurar uma causa que ainda não identificou. "O pão espalhou no forno" primeiro; "fermentou demais" depois; o que tentar antes; e o que fazer se aquilo não resolver.

Perguntas frequentes