A arte da revisão — como desenvolvedores escrevem documentação técnica

• Revisão: ao escrever um texto, pensar várias vezes para corrigir e lapidar. Ou o próprio ato de fazer isso

• Por que a revisão é necessária

• Dicas de revisão

→ Tornar seu próprio texto "estranho": ler em voz alta, reler depois de algum tempo, imprimir no papel e ler

→ Revisão por pares

→ Uso de checklist

→ Dicas de edição para melhorar a legibilidade

① Revisar organizando em frases curtas

② Remover expressões desnecessárias

③ Transformar em um texto lógico

[budlebee]

Isso me faz lembrar dos princípios de escrita do Stephen King. Por ser ficção, há diferenças em relação à redação técnica, mas, escrevendo o que me vem à mente:

• Use frases curtas e simples.

• Depois de escrever o rascunho inicial, eu o guardo na gaveta e o releio seis meses depois.

• A versão revisada remove 10% do rascunho inicial.

• Ler o texto em voz alta ajuda a identificar trechos estranhos nas frases.

• Escrevo definindo de forma concreta quem vai ler o texto. No meu caso, é minha esposa.

[xguru]

Ultimamente, o pessoal de technical writing da Kakao Enterprise tem publicado muitos textos bons. Recomendo assinar o blog!