Examinando o mundo do escritor técnico

As pessoas que escrevem documentos técnicos vêm de todas as esferas da vida - ea maioria não são escritores técnicos per se. Aqui estão algumas situações reais de pessoas que foram chamados para escrever documentos técnicos no exercício das suas profissões:

• programador de computador: Pat se formou em ciência da computação e foi contratado como um desenvolvedor de software para uma empresa na via rápida. Vários meses depois, a empresa sentiu um aperto financeiro e demitiu os escritores técnicos. Pat teve uma grande entrega, devido em poucos meses, e seu supervisor lhe disse que ela tinha para escrever um manual do usuário. Sophomore Inglês (que Pat lutado por e detestava) não prepará-la para este tipo de tarefa. Afinal, Shakespeare não era uma espécie técnica de cara. Pobre Pat teve que sair de alguma maneira de escrever o manual do usuário e tem cabelos grisalhos prematuramente.
• especialista Manufacturing: Bill trabalhou para uma empresa de fabricação por muitos anos e desenvolveu um equipamento que era esperado para revolucionar a indústria. O equipamento fez a sua estreia na Alemanha na maior conferência da indústria. supervisor de Bill pediu-lhe para entregar um documento (o termo da indústria para uma apresentação técnica fazendo) na conferência. A audiência seria composta por mais de 200 profissionais de topo da indústria. Não só Bill temer o pódio mais de broca do dentista, ele não sabia para preparar ou entregar um documento técnico - especialmente em um país estrangeiro para um público deste calibre.
• Cientista maluco: Enquanto trabalhava em uma empresa farmacêutica, Nathaniel tinha um grande avanço em um tratamento que prometeu prevenir a calvície. O presidente da empresa, pediu-lhe para escrever um artigo para uma importante revista médica. Embora Nathaniel estava lisonjeado com o pedido do presidente, ele não sabia a primeira coisa sobre como escrever ou enviar um artigo técnico.
• Representante de vendas: Lynette era um representante de vendas para um distribuidor mundial de computadores. Ela muitas vezes estar longe de casa por semanas de cada vez. Depois de 15 anos como um guerreiro da estrada, Lynette sofria de burnout. (Ela costumava deixar a foto dela na lareira para que sua família não iria esquecê-la.) Lynette estava lendo sobre o florescente campo da escrita tecnologia. Ela chamou uma faculdade local, tem toda a literatura, e decidiu perseguir um mestrado em escrita técnica.

Embora os nomes foram alterados para proteger os inocentes (Lynette, por exemplo, não se transformou em sua demissão ainda), cenários como esses são típicos. Os técnicos que não são treinados escritores estão constantemente pediu para escrever documentos técnicos. Sua educação e experiência de trabalho raramente prepará-los para este tipo de desafio.

Documentos do tipo técnica

Pessoas em campos especializados escrever documentos que se relacionam com assuntos técnicos e complexos. Ao contrário de documentos de negócios que geralmente são escritos por uma pessoa, documentos técnicos são muitas vezes um esforço de colaboração entre um escritor, especialista no assunto (SME), editor, e outros. documentos técnicos são geralmente destinados para os lotes de leitores. Aqui estão alguns documentos técnicos comumente escritos - papel e eletrônica:

• Abstracts
• Artigos para publicação
• treinamento baseado em computador (CBT)
• formulários de avaliação
• Os resumos executivos
• especificações funcionais e detalhe
• Ajuda online
• apresentações
• questionários
• Relatórios
• material de treinamento (em papel ou eletrônico)
• manuais do usuário
• treinamento baseado na Web (WBT)

Atribuir a responsabilidade de documentos técnicos

A responsabilidade pela elaboração de documentos técnicos depende da estrutura e os recursos de uma empresa. Aqui estão três maneiras que as empresas normalmente geram documentos técnicos:

1. gurus técnicos (engenheiros, programadores de software, e outros) escrever os seus próprios documentos. Algumas dessas pessoas podem ter tomado cursos de escrita, mas a maioria não tem formação em escrever um documento coeso. Estes "escritores técnicos" muitas vezes ignoram passos para compartilhar com seus leitores, porque estas etapas são óbvias para eles. E eles provavelmente não identificaram as necessidades de seus leitores. Eles escrevem o que é importante para eles.

2. Estes mesmos gurus pode elaborar documentos e, em seguida, virar as correntes de ar sobre a escritores técnicos para editar, formato e polonês. A menos que o escritor técnico tem a oportunidade de aprender o assunto intimamente, muitos dos passos que podem ter sido negligenciados pelo guru não são identificados pelo escritor ou editor. Este processo, no entanto, produzir um documento que pode ser mais agradável aos olhos - para o que que vale a pena.

3. Um escritor técnico é chamado a partir do início de um projeto. O escritor trabalha com o desenvolvedor quem é o especialista no assunto (SME). Eles funcionam como uma equipe colaborativa, cada um adicionando seus conhecimentos para o projeto. Esta abordagem é geralmente a melhor de todos os mundos possíveis.

Estratégia, e não software

Qualquer pessoa que escreve documentos técnicos devem entender como é crítico para tomar uma abordagem estratégica. Por exemplo, se você projetar uma casa personalizada, você primeiro chamar alguém para empunhar um martelo? Claro que não. Um martelo é simplesmente uma ferramenta. Para projetar uma casa personalizada, você chama um arquiteto - um profissional treinado que projeta layout- torna planos para a canalização, electricidade e aquecimento Systems-e fornece a estrutura. Então você chama alguém que sabe martelos.

O mesmo é válido em redação técnica. documentos técnicos eficazes requerem um arquiteto de informação - um escritor técnico. Se essa pessoa é um escritor técnico profissional ou um engenheiro ou desenvolvedor de software que escreve documentos técnicos, ela deve planejar, projetar e fornecer a estrutura lógica. Qualquer um pode aprender a usar o software para criar o documento. Bem como o martelo, o software é simplesmente uma ferramenta. A chave para escrever um grande documento é estratégia, não software.

Muito poucas pessoas têm essa ampla base de conhecimento. redação técnica é sobre como usar estratégia e os recursos para escrever documentos claros, precisos e lógicas. Se você aplicar uma estratégia lógica e aproveitar-se de recursos, você pode escrever apenas sobre qualquer coisa - desde ligar o computador para a montagem de um avião a jato.

O que você precisa para ter sucesso

Aqui está um instantâneo do que é preciso para escrever documentos técnicos claros e compreensíveis:

• Mostrar respeito para o seu leitor. Você deve escrever sempre com respeito para o seu leitor. Escrever com uma atitude positiva, não com arrogância. Escritores técnicos muitas vezes falam de seus leitores arrogantemente com observações como, "Nós não escrevemos estes documentos para idiotas. Se eles são tão estúpidos, eles não devem estar usando este produto." (Bem, me excuuuuse!) Mesmo o humanóide mais brilhante pode experimentar confusão quando apresentados com algo inteiramente novo.
• Preste atenção interessada em detalhes. Você mostra seu olho afiado para o detalhe na maneira de pensar sobre o que você escreve. Aqui estão alguns itens com marcadores extraídos de um currículo de alguém que estava aplicando para uma posição como um escritor técnico:

# 8226; "Contribuindo escritor para o jornal semanal da cidade." (Que jornal? O que ele escreve? O jornal é semanal, mas é seu programa semanal de contribuição? Bimestral? Mensal?)

# 8226; "Criação de relatórios técnicos." (O que ele quer dizer com "gerado"? Será que ele escrever o relatório ou simplesmente clique no botão Imprimir e vomitar-los?)

# 8226; Este escritor não foi capaz de identificar os detalhes que um potencial empregador quer respondido. Portanto, era óbvio que ele não conseguiu identificar os detalhes que seu público precisa. Você deve ser capaz de antecipar as perguntas que seus leitores vão perguntar, e você deve respondê-las.

• Conheça os seus leitores e seus requisitos. Ao contrário de uma carta que você pode escrever para um leitor específico, muitas vezes você escrever um documento técnico para um grupo diversificado de leitores. Você deve compreender as suas necessidades, a fim de determinar como você escrever o documento e se mídia impressa ou eletrônica é apropriado.
• Os esforços de colaboração. Para ajustar famosa citação de John Donne: Nenhum escritor de tecnologia é uma ilha. Mesmo se você é o único escritor de tecnologia em seu projeto, você vai trabalhar com pessoas dentro ou fora da organização: as PME, editores, especialistas publicação / eletrônicos, e usuários finais.
• Demonstrar a capacidade de perna-o seu ego. Por último, mas não menos importante, você deve ser capaz de deixar o seu ego na porta. Seu documento final, muitas vezes, ser muito diferente do seu projecto inicial. Todo mundo que revê o documento se sente obrigado a pegar uma caneta e marcá-lo para cima. É tudo parte do processo - a necessidade de fazer uma contribuição. Então, estar preparado para ter seu trabalho editado, re-editado, e talvez rasgado em pedaços.