A redação técnica geralmente requer dois tipos de conhecimento: o grupo demográfico pelo qual sua redação será lida e alguma compreensão do assunto técnico em questão.
A redação técnica geralmente requer dois tipos de conhecimento: o grupo demográfico pelo qual sua redação será lida e alguma compreensão do assunto técnico em questão.
Entenda seu público. Você pode receber um relatório de quem será o público para a escrita, ou você pode ter que descobrir por conta própria. De qualquer forma, você deve saber a demografia básica dos leitores, incluindo quanto conhecimento técnico eles têm do assunto em questão. Um público de novos usuários para um determinado software terá de ser escrito de maneira muito diferente do que um grupo de programadores avançados. O uso de jargão técnico terá de ser ajustado em conformidade. Coloque-se no lugar do leitor e escreva o mais claramente possível.
Conheça o seu assunto. Se você for um redator técnico regular, pode não ser possível saber tudo sobre todos os assuntos sobre os quais escreve. Mas você terá que saber o suficiente sobre isso para ter certeza de que pode se comunicar com precisão.
Use o tempo presente. A menos que você tenha recebido instruções específicas para usar um tempo verbal diferente, a redação técnica deve sempre ser feita no presente.
Seja objetivo. A redação técnica deve ser feita de maneira objetiva, sem conclusões tiradas e sem uso de pronomes pessoais.
Escreva um índice. Um índice é necessário em praticamente qualquer forma de redação técnica e ajudará os leitores a encontrar as informações de que mais precisam.
Percorra listas de etapas. As etapas que devem ser executadas para realizar a tarefa, utilizar o equipamento, executar o software, etc., devem ser escritas uma a uma. Certifique-se de cobrir todas as perguntas que possam surgir sobre cada etapa. As etapas devem ser numeradas em ordem e ser acessíveis por meio do índice para referência rápida.
A redação técnica deve ser feita de maneira objetiva, sem conclusões tiradas e sem uso de pronomes pessoais.
Use ferramentas e tabelas. A redação técnica extensa geralmente possui um conhecimento que se baseia em si mesmo - as informações principais devem ser compreendidas antes que o resto possa ser. Às vezes, pode ser útil incluir imagens, gráficos e tabelas de informações rotuladas para obter ideias complexas que são difíceis de descrever em palavras ou que terão de ser mencionadas posteriormente no documento.
Use avisos especiais. Além das instruções, haverá casos em que o uso de avisos especiais no texto será útil para o leitor. Os avisos serão avisos, precauções de situações possivelmente perigosas, etc. Avisos especiais podem incluir idéias de proteção, como recomendar o uso de óculos de segurança ou um espaço de trabalho ventilado. Também pode haver avisos sobre o que fazer no caso de uma etapa ter sido executada incorretamente, como corrigir erros, etc.
Teste o documento. Muitas vezes, é uma boa ideia testar o documento em alguém próximo ao grupo demográfico-alvo, que pode dizer se há informações faltando. Se o documento for para usuários iniciantes das informações, deve ser fácil encontrar alguém em uma posição semelhante. Se ele conseguir ler o documento sem mais perguntas sobre como usar as informações, o documento está completo.
