Escrita técnica - Technical writing

Redação técnica é redação ou redação de comunicação técnica usada em campos técnicos e ocupacionais, como hardware e software de computador , engenharia , química , aeronáutica , robótica , finanças , medicina , eletrônica de consumo , biotecnologia e silvicultura . A redação técnica abrange o maior subcampo da comunicação técnica.

A Society for Technical Communication define comunicação técnica como qualquer forma de comunicação que exibe uma ou mais das seguintes características: "(1) comunicação sobre tópicos técnicos ou especializados, como aplicativos de computador, procedimentos médicos ou regulamentos ambientais; (2) comunicação usando tecnologia, como páginas da web, arquivos de ajuda ou sites de mídia social; ou (3) fornecendo instruções sobre como fazer algo, independentemente de quão técnica a tarefa seja ".

Visão geral

A redação técnica é realizada por um redator técnico (ou autor técnico) e é o processo de redação e compartilhamento de informações técnicas em um ambiente profissional. A principal tarefa de um redator técnico é comunicar informações técnicas a outra pessoa ou parte da maneira mais clara e eficaz possível. As informações que os redatores técnicos comunicam costumam ser complexas, portanto, habilidades fortes de redação e comunicação são essenciais. Os redatores técnicos não apenas transmitem informações por meio de texto, mas também devem ser proficientes com computadores. Os escritores técnicos usam uma ampla gama de programas para criar e editar ilustrações , diagramar programas para criar recursos visuais e processadores de documentos para projetar, criar e formatar documentos.

Embora a redação técnica seja comumente associada à ajuda online e aos manuais do usuário , o termo documentação técnica pode abranger uma ampla gama de gêneros e tecnologias. Comunicados à imprensa , memorandos , relatórios , propostas comerciais , fichas técnicas , descrições e especificações de produtos , white papers , currículos e formulários de emprego são apenas alguns exemplos de redação que podem ser considerados documentação técnica. Alguns tipos de documentação técnica normalmente não são tratados por escritores técnicos. Por exemplo, um comunicado à imprensa é geralmente escrito por um redator de relações públicas, embora um redator técnico possa contribuir com qualquer informação técnica incluída no comunicado à imprensa.

História

Embora a escrita técnica só tenha sido reconhecida como profissão desde a Segunda Guerra Mundial , suas raízes podem ser rastreadas até a antiguidade clássica . Os críticos citam as obras de escritores como Aristóteles como as primeiras formas de redação técnica. O trabalho de Geoffrey Chaucer , Tratado sobre o Astrolábio, é um dos primeiros exemplos de documento técnico . Os primeiros exemplos de redação técnica datam do período do inglês antigo.

Com a invenção da imprensa mecânica , o início da Renascença e a ascensão da Idade da Razão , documentar as descobertas tornou-se uma necessidade. Inventores e cientistas como Isaac Newton e Leonardo da Vinci prepararam documentos que narram suas invenções e descobertas. Embora nunca tenham sido chamados de documentos técnicos durante o período de publicação, esses documentos desempenharam um papel crucial no desenvolvimento de formas modernas de comunicação e redação técnica.

O campo da comunicação técnica cresceu durante a Revolução Industrial . Havia uma necessidade crescente de fornecer às pessoas instruções sobre como usar as máquinas cada vez mais complexas que estavam sendo inventadas. No entanto, ao contrário do passado, onde as habilidades eram transmitidas por meio de tradições orais, ninguém além dos inventores sabia como usar esses novos dispositivos. Escrever, portanto, tornou-se a maneira mais rápida e eficaz de disseminar informações, e escritores que pudessem documentar esses dispositivos eram desejados.

Durante o século 20, a necessidade de redação técnica disparou e a profissão tornou-se oficialmente reconhecida. Os eventos da Primeira Guerra Mundial e da Segunda Guerra Mundial levaram a avanços na medicina, hardware militar, tecnologia de computadores e tecnologias aeroespaciais. Esse rápido crescimento, juntamente com a urgência da guerra, criou uma necessidade imediata de documentação bem projetada para apoiar o uso dessas tecnologias. A redação técnica estava em alta demanda durante esse tempo, e "redator técnico" tornou-se um cargo oficial durante a Segunda Guerra Mundial .

Após a Segunda Guerra Mundial , os avanços tecnológicos levaram a um aumento nos bens de consumo e no padrão de vida. Durante o boom do pós-guerra, serviços públicos como bibliotecas e universidades, bem como sistemas de transporte como ônibus e rodovias, tiveram um crescimento substancial. A necessidade de escritores para fazer crônicas desses processos aumentou. Foi também nesse período que grandes empresas e universidades começaram a usar computadores. Notavelmente, em 1949, Joseph D. Chapline foi o autor do primeiro documento técnico computacional, um manual de instruções para o computador BINAC .

A invenção do transistor em 1947 permitiu que os computadores fossem produzidos de forma mais barata e ao alcance de pessoas físicas e pequenas empresas. À medida que o mercado para esses " computadores pessoais " crescia, também crescia a necessidade de escritores que pudessem explicar e fornecer documentação de usuário para esses dispositivos. A profissão de redação técnica teve uma expansão ainda maior durante as décadas de 1970 e 1980, à medida que os eletrônicos de consumo chegaram às casas de mais e mais pessoas.

Nos últimos anos, a proeminência dos computadores na sociedade levou a muitos avanços no campo das comunicações digitais, levando a mudanças nas ferramentas de uso dos escritores técnicos. Hipertexto , processadores de texto , programas de edição de gráficos e software de layout de página tornaram a criação de documentos técnicos mais rápida e fácil, e os escritores técnicos de hoje devem ser proficientes nesses programas.

Técnicas

Uma boa redação técnica é concisa, focada, fácil de entender, livre de erros e baseada no público. Os redatores técnicos se concentram em tornar seus documentos o mais claros possível, evitando frases excessivamente técnicas e escolhas estilísticas, como voz passiva e nominalizações. Como os documentos técnicos são usados ​​em situações do mundo real, sempre deve ser explicitamente claro qual é o assunto de um documento técnico e como usar as informações apresentadas. Seria desastroso se, por exemplo, as instruções de um redator técnico sobre como usar uma máquina de raios-X de alta potência fossem difíceis de decifrar.

A redação técnica requer que um escritor examine extensivamente seu público. Um redator técnico precisa estar ciente do conhecimento existente de seu público sobre o material que está discutindo, pois a base de conhecimento do público do redator determina o conteúdo e o foco de um documento. Por exemplo, um relatório de avaliação discutindo as descobertas de um estudo científico escrito para um grupo de cientistas altamente qualificados será construído de maneira muito diferente do que um destinado ao público em geral. Os redatores técnicos não precisam ser especialistas no assunto (PMEs). Freqüentemente, colaboram com PMEs para concluir tarefas que exigem mais conhecimento sobre um assunto do que possuem.

A redação técnica deve ser precisa. Um redator técnico, depois de analisar seu público, sabe o que precisa comunicar e, então, precisa transmitir a mensagem de maneira precisa e ética. Podem ocorrer repercussões físicas, ambientais ou financeiras se um escritor fizer isso incorretamente. Conhecer o público é essencial para a precisão porque a linguagem será adaptada de acordo com o que eles já entendem sobre o assunto em questão. Por exemplo, as instruções sobre como montar uma estante de livros de maneira correta e segura estão incluídas na compra. Essas instruções são elaboradas para que qualquer pessoa possa acompanhá-las, incluindo detalhes precisos sobre onde cada fixador vai. Se essas instruções forem imprecisas, a estante pode ficar instável e falhar.

O design e o layout do documento também são componentes vitais da redação técnica. Os redatores técnicos gastam muito tempo garantindo que seus documentos sejam legíveis, porque um documento mal projetado dificulta a compreensão do leitor. O design do documento técnico enfatiza o uso adequado das opções de design do documento, como marcadores, tamanho da fonte e texto em negrito. Imagens, diagramas e vídeos também são comumente empregados por escritores técnicos porque essas mídias podem transmitir informações complexas, como o lucro anual de uma empresa ou os recursos de design de um produto, com muito mais eficiência do que texto.

Documentos técnicos

A redação técnica cobre muitos gêneros e estilos de redação, dependendo das informações e do público. Os documentos técnicos não são produzidos apenas por redatores técnicos. Quase qualquer pessoa que trabalha em um ambiente profissional produz documentos técnicos de alguma variedade. Alguns exemplos de documentação técnica incluem:

  • Instruções e procedimentos são documentos que ajudam os desenvolvedores ou usuários finais a operar ou configurar um dispositivo ou programa. Exemplos de documentos de instrução incluem manuais do usuário e guias de solução de problemas para programas de computador, hardware de computador, produtos domésticos, equipamentos médicos, produtos mecânicos e automóveis.
  • Propostas . A maioria dos projetos começa com uma proposta - um documento que descreve a finalidade de um projeto, as tarefas que serão realizadas no projeto, os métodos usados ​​para concluir o projeto e, finalmente, o custo do projeto. As propostas cobrem uma ampla gama de assuntos. Por exemplo, um redator técnico pode escrever uma proposta que descreve quanto custará para instalar um novo sistema de computador, um profissional de marketing pode escrever uma proposta com as ofertas do produto e um professor pode escrever uma proposta que descreve como uma nova aula de biologia será estruturado.
  • E-mails , cartas e memorandos são alguns dos documentos escritos com mais frequência em uma empresa. Cartas e e-mails podem ser elaborados com uma variedade de objetivos - alguns geralmente visam simplesmente comunicar informações, enquanto outros são projetados para persuadir o destinatário a realizar uma determinada tarefa. Embora as cartas geralmente sejam escritas para pessoas de fora da empresa, os memorandos (memorandos) são documentos escritos para outros funcionários da empresa.
  • Comunicados de imprensa . Quando uma empresa deseja revelar publicamente um novo produto ou serviço, ela pede a um escritor que crie um comunicado à imprensa . Este é um documento que descreve as funções e o valor do produto para o público.
  • As especificações são esboços de projeto que descrevem a estrutura, peças, embalagem e entrega de um objeto ou processo em detalhes suficientes para que outra parte possa reconstruí-lo. Por exemplo, um redator técnico pode diagramar e escrever as especificações de um smartphone ou bicicleta para que um fabricante possa produzir o objeto.
  • As descrições são explicações mais curtas de procedimentos e processos que ajudam os leitores a entender como algo funciona. Por exemplo, um redator técnico pode criar um documento que mostre os efeitos dos gases de efeito estufa ou demonstre como funciona o sistema de freios de uma bicicleta.
  • Currículos e formulários de emprego são outro exemplo de documentos técnicos. São documentos usados ​​em um ambiente profissional para informar os leitores sobre as credenciais do autor.
  • Os relatórios técnicos são escritos para fornecer aos leitores informações, instruções e análises para as tarefas. Os relatórios vêm em várias formas. Por exemplo, um redator técnico pode avaliar um edifício que está à venda e produzir um relatório de viagem que destaca suas descobertas e se ele acredita que o edifício deve ser comprado. Outro redator que trabalha para uma empresa sem fins lucrativos pode publicar um relatório de avaliação que mostre os resultados da pesquisa da empresa sobre a poluição do ar.
  • O estudo de caso é um relatório publicado sobre uma pessoa, grupo ou situação que foi estudado ao longo do tempo; também  : uma situação na vida real que pode ser examinada ou estudada para aprender sobre algo. Por exemplo, a situação desafiadora de um indivíduo em seu local de trabalho e como ele a resolveu é um estudo de caso.
  • White papers são documentos escritos para especialistas em uma área e geralmente descrevem uma solução para um desafio ou problema tecnológico ou comercial. Exemplos de white papers incluem um artigo que detalha como fazer uma empresa se destacar no mercado ou um artigo que explica como evitar ataques cibernéticos a empresas.
  • Sites . O advento do hipertexto mudou a maneira como os documentos são lidos, organizados e acessados. Os escritores técnicos de hoje são frequentemente responsáveis ​​pela criação de páginas em sites como páginas "Sobre nós" ou páginas de produtos. Espera-se que eles sejam proficientes em ferramentas de desenvolvimento web.
  • Folhas de dados são os documentos que resumem os recursos, especificações principais, características técnicas, circuitos de aplicativos e algumas outras informações importantes sobre o produto, máquina, equipamento, software, aplicativo ou sistema em resumo.
  • Guias de API são escritos para a comunidade de desenvolvedores e são usados ​​para explicar as interfaces de programação de aplicativos .
  • Os sistemas de ajuda são centros de ajuda online que fornecem aos usuários informações técnicas sobre produtos e serviços. Eles fornecem conteúdo como páginas da web que são visualizadas em um navegador. O conteúdo pode ser criado em um software de centro de ajuda, como Zendesk , ou em ferramentas de autoria de ajuda ou sistemas de gerenciamento de conteúdo de componente que podem criar um centro de ajuda como uma saída HTML.

Ferramentas

As seguintes ferramentas são usadas por escritores técnicos para criar e apresentar documentos:

  • Ferramentas de editoração eletrônica ou processadores de texto . Escritores técnicos usam processadores de texto como Scrivener, Microsoft Word , Apple Pages e LibreOffice Writer para criar, editar, projetar e imprimir documentos. Uma vez que a redação técnica envolve tanto o layout da página quanto a linguagem escrita, ferramentas aprimoradas de editoração eletrônica, como Adobe InDesign e LyX, também são usadas. Esses programas funcionam de forma semelhante aos processadores de texto, mas fornecem aos usuários mais opções e recursos para o design do documento e automatizam grande parte da formatação.
  • Ferramentas de autoria de ajuda . Eles são usados ​​por escritores técnicos para criar os sistemas de ajuda que são empacotados com produtos de software, entregues por meio de navegadores da web ou fornecidos como arquivos que os usuários podem visualizar em seus computadores. Ao escrever procedimentos instrucionais para descrever programas mecânicos, elétricos ou de software, os escritores técnicos usam essas ferramentas para ajudá-los a simplificar os processos de montagem, operação ou instalação.
  • Sistemas de gerenciamento de conteúdo de componentes . Eles também são usados ​​por escritores técnicos para criar sistemas de ajuda e documentos. Os sistemas de gerenciamento de conteúdo de componentes (CCMS) permitem que os escritores criem resultados semelhantes como ferramentas de criação de ajuda, mas também fornecem recursos de gerenciamento de conteúdo, como gerenciamento de versão e fluxos de trabalho integrados.
  • Software de edição de imagens . Freqüentemente, imagens e outros elementos visuais podem comunicar informações melhor do que parágrafos de texto. Nesses casos, softwares de edição de imagem como Adobe Photoshop e GIMP são usados ​​por escritores técnicos para criar e editar os aspectos visuais de documentos como fotos, ícones e diagramas.
  • Programas de software colaborativos. Como a redação técnica geralmente envolve a comunicação entre vários indivíduos que trabalham para empresas diferentes, pode ser um assunto colaborativo. Os escritores técnicos usam Sistemas Wiki e espaços de trabalho de documentos compartilhados para trabalhar com outros escritores e partes na construção de documentos técnicos.
  • Ferramentas de desenvolvimento web . Os trabalhos de redator técnico não estão mais limitados apenas à produção de documentos. Às vezes, eles também produzem conteúdo para sites corporativos e outros sites profissionais da empresa. Portanto, pode-se esperar que escritores técnicos sejam proficientes em ferramentas de desenvolvimento da Web como o Adobe Dreamweaver .
  • Editores de texto . Programas como o Microsoft Notepad , TextEdit ou Wordstar permitem que escritores técnicos editem texto simples . Os editores de texto podem ser usados ​​para alterar o conteúdo, como arquivos de configuração , arquivos de documentação e código-fonte da linguagem de programação . Editores de texto são amplamente usados ​​por escritores técnicos que trabalham com conteúdo online.
  • Software de representação gráfica. Para comunicar informações estatísticas, como o número de visitas a um restaurante ou a quantidade de dinheiro que uma universidade gasta em seus programas esportivos, os redatores técnicos usam gráficos e fluxogramas. Embora programas como o Microsoft Excel e o Word possam criar gráficos e tabelas básicos, às vezes os escritores técnicos devem produzir gráficos mais complexos e detalhados que requerem funções não disponíveis nesses programas e podem precisar recorrer a ferramentas de gráficos e diagramação (por exemplo, Microsoft Visio ).
  • Ferramentas de captura de tela. Os escritores técnicos freqüentemente usam ferramentas de captura de tela como Camtasia e Snagit . Ao criar instruções para um software de computador, pode ser mais fácil para um redator técnico simplesmente gravar um pequeno vídeo de seus desktops enquanto completam uma tarefa do que escrever uma longa série de instruções que descrevem como a tarefa deve ser executada. As ferramentas de captura de tela também são usadas para fazer capturas de tela de programas e softwares em execução nos computadores do usuário e, em seguida, para criar diagramas de acompanhamento.

Lista de associações

Referências

links externos