Os 4 princípios da redação técnica
(tech.kakaoenterprise.com)<p>"Escreva de forma breve, escreva com clareza, escreva de forma vívida e, acima de tudo, escreva com precisão - Joseph Pulitzer"<br />
① 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<br />
② 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<br />
③ Precisão (Accuracy): fornecer com exatidão as informações de que o leitor precisa, sem erros técnicos<br />
④ Consistência (Coherence): usar de forma consistente a terminologia, as expressões e o tom ao longo do documento</p>
2 comentários
Obrigado.