a redação técnica é a prática de processar documentos e visuais, informações verbais e demonstrações para material de treinamento instrucional. O objetivo da redação técnica é fornecer material que explique um processo ou torne um conceito complexo mais fácil de entender para um público específico. Através da escrita técnica eficiente e eficaz, o escritor será capaz de explicar e ajudar o leitor a entender as informações e realizar tarefas específicas. Existem cinco princípios éticos universais da escrita técnica. Os princípios são conteúdo de qualidade, público e propósito, acessibilidade, gramática e estilo de escrita.
conteúdo de qualidade
o conteúdo de qualidade é subjetivo. A definição de conteúdo de alta qualidade da MATC é um produto que atende aos padrões de um cliente ou vai além do escopo inicial do projeto. Para produzir um projeto de alta qualidade, você precisa escrever com o público-alvo em mente. O escritor deve pesquisar conhecimentos adicionais necessários antes que o documento ou material seja concluído. O escritor precisa saber qual formato ou plataforma será usada para representar as informações. O escritor deve determinar informações específicas que vão desde saber quais são os prazos até saber por que as informações precisam ser escritas.
público e propósito
o escritor precisa entender o propósito e o público para criar uma peça técnica excepcional. O público de redação técnica varia de acordo com o setor e o cliente em particular. Por exemplo, o público de um relatório de volta seria a fabricação do produto que nos contratou como escritores. O público de um módulo de treinamento de eLearning pode ser um banco ou provedor de hipotecas que precisa de treinamento de Conformidade. O escritor tem que saber o quanto os leitores saberão e quais as responsabilidades que o escritor deve cumprir quando se trata de se comunicar com os leitores.
acessibilidade
é essencial que o público possa acessar as informações que o escritor criou com facilidade. A acessibilidade inclui qualquer coisa que esteja em um documento, como cabeçalhos e rodapés, ou em módulos iLearn de computador, que melhoram a formatação de acessibilidade para serem mais universais e mais claros. O escritor técnico precisa descobrir o melhor método para ajudar os leitores a navegar na documentação com anotações de uma bibliografia para um número de página para um índice. O escritor poderia até adicionar visuais, como gráficos e figuras, para explicar mais informações.
Gramática
escrever claro, conciso e direto com o uso adequado da gramática é vital para escrever qualquer peça técnica. O escritor também deve revisar e editar qualquer peça técnica que esteja sendo escrita para corrigir quaisquer erros ou inconsistências com a gramática, estilo e layout. Um escritor técnico deve sempre escrever no tempo presente, a menos que o cliente indique sua preferência de outra forma. O leitor da peça técnica deve estar fazendo exatamente o que você está dando instruções. O escritor deve sempre escrever em frases simples que incluam substantivos neutros de gênero. Frases simples ajudam os leitores a entender de forma clara e eficiente as tarefas que eles têm que realizar para completar seus objetivos.
estilo de Escrita
o estilo de escrita difere para cada peça técnica porque depende muito de quem é o público e do cenário para o qual a peça técnica está sendo escrita. O tom de uma peça de escrita técnica é essencial porque ajuda o leitor a entender que tipo de tom é necessário para concluir a tarefa. A escolha de palavras também é uma parte essencial do estilo em ajudar a fornecer as necessidades do público, pois se conecta de volta a quem seu público é. Ao fazer referência a seções de informações ou sites, é essencial fornecer maneiras claras e visíveis de acessar as informações usando ferramentas, como figuras e tabelas.
outras dicas de Redação Técnica
faça pesquisas extras e saiba mais
saber o mínimo pode não obter a melhor Peça técnica para ajudar o público a entender as informações. Pode haver muita terminologia que o escritor e o leitor podem não entender. Como regra geral, se você, como leitor, não entende um conceito ou termo, defina-o. Muita informação sempre pode ser reduzida em revisões posteriores. Essa informação deve ser pesquisada para entender como funciona com o que o escritor está escrevendo como um todo. Pesquise um pai pequeno e descubra quais outras informações poderiam ser usadas para aprimorar a peça técnica que está sendo escrita.
torne-se o público e subestime o público
Coloque-se no lugar do público. Você pode entender e seguir claramente as instruções ou informações que escreveu para o público? Se sim, você pode fornecer mais informações se achar que precisa de um pouco mais de Ajuda. Caso contrário, você precisa encontrar as peças que não estão claras e encontrar uma maneira de fornecer as informações corretamente. Um grande problema que os escritores técnicos costumam ter é que eles superestimam o conhecimento de seu público. O público pode ser várias pessoas em diferentes níveis de conhecimento. É perfeitamente aceitável fornecer brevemente informações que possam ser assumidas ou já declaradas como uma atualização para o público.
peça uma segunda e terceira opinião e revisão por pares
os escritores técnicos são engenhosos. O maior recurso que você tem são seus especialistas no assunto. Certifique-se de perguntar a sua PME se eles vêem quaisquer lacunas de conhecimento ou erros. Escritores verificar com seus clientes para ver se há quaisquer lacunas de conhecimento ou erros que o escritor pode ignorar. Ter um supervisor ou colega olhando e dando uma opinião também pode ajudar a melhorar uma peça técnica. A revisão por pares é quando um grupo de pessoas se reúne para ler, comentar e recomendar melhorias no trabalho um do outro. Mais pontos cegos são descobertos quando mais pessoas revisam um documento, o que garante informações precisas e concisas.
escritores técnicos aprendem novas informações para cada projeto em que trabalham. Os escritores obtêm uma melhor compreensão do que os clientes precisam porque começam abaixo do nível de conhecimento de seus leitores antes de todas as pesquisas e discussões com os especialistas do assunto. Isso se torna um grande trunfo para as empresas porque menos suposições se abrem para um treinamento mais eficaz. A combinação dos escritores que aprendem o material e esses princípios éticos dos padrões técnicos de redação leva a funcionários mais confiantes e eficientes.