Os 4 princípios da redação técnica

"Escreva de forma breve, escreva com clareza, escreva de forma vívida e, acima de tudo, escreva com precisão - Joseph Pulitzer"

① Clareza (Clarity): usar termos-chave ou frases-chave sem ambiguidade, para que, ao ler a documentação técnica, o conteúdo seja compreendido de uma vez, sem ambiguidades nem confusão

② Concisão (Conciseness): para que o conteúdo técnico possa ser entendido com rapidez e precisão, não usar floreios nem interjeições, e empregar palavras simples e fáceis, além de frases concisas

③ Precisão (Accuracy): fornecer com exatidão as informações de que o leitor precisa, sem erros técnicos

④ Consistência (Coherence): usar de forma consistente a terminologia, as expressões e o tom ao longo do documento

[junghan0611]

Obrigado.

[xguru]

• Technical Writing para engenheiros, do Google [em inglês] https://pt.news.hada.io/topic?id=1642