Redação Técnica 101 Parte I

Redação Técnica tem sido uma paixão minha por anos. Eu, na verdade, começou como uma pessoa de suporte de Help Desk documentar instruções técnicas para os funcionários e novas contratações, e, em seguida, mudou-se para o trabalho do projeto documentar o código de programação e especificações técnicas para projetos maiores. I &'; ve também escrito um curso para um colégio da comunidade local na minha área e ensinou-lo também. Eu queria compartilhar algumas das minhas idéias a partir deste curso uma vez que muitos participantes considerou útil. Eles até mesmo fez um comentário no jornal US1 Princeton! :-D

De qualquer forma, eu discordo … na minha opinião existem 4 chaves para a redação técnica e eu se referem a ele como o método DOPS. Let &'; s avaliar cada ponto

D é para Definindo seu Audiência – Não só você precisa saber que você está escrevendo para, mas você precisa saber o seu nível de conhecimento e conscientização sobre o tema definido. Por exemplo, se você está ensinando o MS Word para executivos de topo e eles nem sequer sabem como usar o Outlook ou navegar no Windows, você pode precisar de re-avaliar o seu conteúdo e da língua que você está escrevendo. Tente ficar longe do complexo termos técnicos e começar com uma avaliação básica das barras de ferramentas ou até mesmo como para abrir o aplicativo.

O é para a estrutura de tópicos. Pessoalmente, eu acredito que esta é a chave para o sucesso. Eu vejo tantos escritores simplesmente sentar-se e começar a escrever sem nenhuma direção e você pode dizer que o fluxo de seu documento. Você simplesmente não pode seguir o seu “ linha de pensamento &" ;. Aproveite o tempo para delinear todo o documento a partir do conteúdo da página de rosto e até mesmo notas gráficas, nos títulos de seção e de conteúdo, todo o caminho para o apêndice, deixando o TOC (Índice) para ser concluída passado. Confie em mim, você verá uma grande diferença no fluxo de seus documentos

P é para Definindo seu Purpose – Eu odeio usar siglas dentro de siglas, mas eu gosto de me referir a isso como a teoria triip. Seu propósito para criar o documento poderia ser ensinar, recomendar, Informar, interesse, ou persuadir. Por exemplo, se você é o escritor técnico para uma nova aplicação de software para o departamento de Recursos Humanos, e seu trabalho é escrever um documento para os funcionários que irão utilizar esta nova aplicação, qual é o seu propósito? Neste caso, é para ensinar. Here &'; s outra: Se você está contratado como um escritor técnico para criar um documento concebido para permitir que os funcionários sabem sobre novas políticas e procedimentos, o que é o seu propósito? Neste caso, a resposta é informar. Você &'; re não fazer uma recomendação que sigam os procedimentos ou a tentar interessá-los ou persuadi-los a seguir as políticas e procedimentos; você precisa simplesmente para informá-los.

S é para os Estágios de escrita. Creio que existem 3 passos para os estágios, por assim dizer, e não, eu não tenho um acrônimo para este. LOL Os 3 passos são plano, elaborar e revisar. Depois de concluir o seu plano inteiro para o documento, incluindo a avaliação do seu público e a descrição pormenorizada, com talvez alguns esboços, você pode começar a criar o seu projecto de documento. Se você não é novo para a escrita técnica você está bem ciente de que o seu primeiro documento criado é sempre um projecto. Você vai ter muitas, muitas revisões por várias pessoas antes de o documento final é aprovado. Espero que eu não &'; t assustar ninguém fora ainda!

Então, aí temos que, o método DOPS por Cheryl McNeil. Há muito mais a Redação Técnica, mas eu pensei que eu iria apenas fornecer uma prévia do que está por vir no meu próximo artigo, Parte II de Redação Técnica 101. Até a próxima vez …

Recursos para a criação de outlines:

http://owl.english.purdue.edu/handouts/general/gl_outlin.html
http://www.albany.edu/eas/170/outline.htm
http://wiki.ehow.com/Write-an-Outline
.