Redação Técnica 101 Parte 2

Na Parte 1 eu compartilhei alguns dos meus pensamentos sobre a definição de seu público, criando um esboço, definindo o seu objectivo e os estágios de escrita. Agora eu gostaria de ter um momento e expandir a área de definir o seu público. Por exemplo, o que você precisa saber sobre eles e por quê.

O primeiro passo é descobrir o seu nível de conhecimento sobre o assunto. Eles são …
nível de peritos? – em um nível avançado sobre o assunto nível
Semi-especialista? – em um nível intermediário sobre o assunto
nível não especializado? – não têm conhecimento prévio do assunto

O segundo passo é descobrir o seu papel na organização. Eles são …
• Superiores? – o mais alto de figuras de autoridade dentro da organização, como o presidente ou o vice-presidente ou diretor. Aqueles que tomam decisões que afetam toda a organização
• Subordinados? – leitores a um nível dentro da organização menor do que o escritor técnico. Tudo o que importa é a forma como o documento afeta o seu trabalho
• Pares? – leitores sobre o mesmo nível que o escritor técnica, mas não necessariamente o mesmo departamento ou campo.

E o terceiro passo é descobrir por que eles estarão lendo o documento técnico em primeiro lugar. Será que é porque …
• eles tem que? ou que tenham sido ordenados pelo seu técnico
&bull?; eles são verdadeiramente interessados ​​no tema
&bull?; eles só poderá usá-lo como uma referência ao completar suas tarefas diárias?

Você pode estar se perguntando por que essas medidas são ainda importante para um escritor técnico. Bem, a razão é porque se você escrever ou desenhar o seu documento no contexto errado, a cor ou o layout que poderia fazer ou quebrar o projeto inteiro.

Por exemplo, você não quer escrever um documento aos superiores sem nenhum conhecimento do assunto em termos altamente técnicos, nem você quer escrever de uma forma condescendente quer. Tem de haver um equilíbrio profissional entre os dois que vai envolver o aluno e ajudá-los a assimilar a informação de forma eficiente e utilizar o documento técnico efetivamente

Let &';. S olhada em outro exemplo. Você está escrevendo para uma equipa de pares que têm um intermediário ao nível de conhecimento avançado. O que você acha que seria a resposta dos leitores, se você criou um documento que explica mesmo o menor termo técnico, como o que é um &'; rato &'; ou como a “ &" ;? clique Eles provavelmente seria aborrecido e ofendido, ao mesmo tempo, don &'; t você acha

Então, novamente, é a chave para definir o seu público, perguntando tantas perguntas quanto possível?. Se você acabar com muitos níveis e funções organizacionais dentro de seu público, você pode precisar criar 3 documentos distintos, como um guia para iniciantes, intermediário e Guia do Usuário Guia Avançado do Usuário.

Na Parte 3 Eu quero se concentrar em como reunir recursos e de onde, e quais são ajudas gráficas ou pistas dentro de documentação técnica e como criá-los. Até a próxima vez …

Resource: Redação Técnica:. Princípios, estratégias e Leituras por Diana C. Reep (. 5º ed) Pearson Education, Inc. 2003. Art