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

<p>- Revisão: ao escrever um texto, pensar várias vezes para corrigir e lapidar. Ou o próprio ato de fazer isso<br /> - Por que a revisão é necessária<br /> - Dicas de revisão<br /> → Tornar seu próprio texto "estranho": ler em voz alta, reler depois de algum tempo, imprimir no papel e ler<br /> → Revisão por pares <br /> → Uso de checklist <br /> → Dicas de edição para melhorar a legibilidade <br /> ① Revisar organizando em frases curtas<br /> ② Remover expressões desnecessárias<br /> ③ Transformar em um texto lógico</p>

[budlebee]

<p>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:<br /> <br /> - Use frases curtas e simples.<br /> - Depois de escrever o rascunho inicial, eu o guardo na gaveta e o releio seis meses depois.<br /> - A versão revisada remove 10% do rascunho inicial. <br /> - Ler o texto em voz alta ajuda a identificar trechos estranhos nas frases. <br /> - Escrevo definindo de forma concreta quem vai ler o texto. No meu caso, é minha esposa. </p>

[xguru]

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