Conheça o Technical Writing e a relação com o usuário

A redação técnica (também chamado Technical Writing no mercado digital brasileiro) abrange toda a documentação de processos técnicos complexos. Inclui relatórios, resumos executivos, apresentações de resultados. No sentido amplo, sempre que a informação técnica é transmitida por escrito num ambiente de trabalho, é utilizada, por definição, a escrita técnica. Isso pode incluir produtos de alta tecnologia, engenharia, biotecnologia, energia, aeroespacial, finanças, TI e da cadeia de suprimentos global.

Numa definição tradicional de redação técnica ela é considerada a prática de documentar processos, como manuais de software ou materiais instrucionais. Tradicionalmente, era limitado a manuais de usuário de algum tipo.

E o Technical writing hoje?

Mas hoje o formato não está mais vinculado a longos manuais do usuário. As informações técnicas devem ser distribuídas e apresentadas de forma inequívoca no momento que se precisa. Isso pode vir na forma de relatórios técnicos, e-mails, políticas, resumos e comunicados à imprensa. A conclusão, neste caso, é que, se você trabalha em um campo técnico, provavelmente está realizando uma redação técnica.

A definição mais atualizada começa a parecer muito com a definição de escrita de negócios. Mas a redação técnica não é exatamente o mesmo que redação comercial. A escrita de negócios é uma categoria mais ampla. Pode-se argumentar que a escrita técnica se enquadra na escrita de negócios. Ele lida com muitos dos mesmos tópicos e documentos. No entanto, o processo e os resultados da redação técnica são únicos. 

O que faz o redator técnico (o writer, no caso)?

O trabalho de um redator técnico será diferente dependendo do setor e da empresa em que eles trabalham. Frequentemente trabalham em equipes multidisciplinares (e respondem a diversos stakeholders) e que funcionam como mediadores entre o corpo técnico aplicado e o leitor menos técnico. O redator aqui atua em colaboração com as equipes de produção para desenvolver uma estratégia de comunicação, assim, devem entender todo o projeto, desde as metas de alto nível até os meandros da implementação.

Logo, a escrita técnica é a arte de fornecer instruções detalhadas para ajudar os usuários a entender uma habilidade ou produto específico.  E um redator técnico é alguém que escreve essas instruções, seja a documentação técnica ou tutoriais. Para atender este objetivo, isso pode incluir a redação de manuais do usuário, artigos de suporte online, FAQ ou documentos internos para codificadores/desenvolvedores de API.

Como falar com o usuário se o conteúdo é técnico?

Um redator técnico se comunica de uma maneira que apresenta informações técnicas para que o leitor possa usar essas informações para um propósito pretendido. Uma boa pessoa redatora técnica escreve com base no contexto de quem é leitor. Como exemplo, se estiver escrevendo um artigo direcionado a iniciantes, é importante não assumir que eles já conhecem certos conceitos. Explique tudo!

Você pode começar seu artigo descrevendo todos os pré-requisitos necessários. Isso garantirá que seus leitores tenham (ou possam adquirir) o conhecimento de que precisam antes de mergulhar direto no seu artigo.  Você também pode incluir links para recursos úteis para que seus leitores possam obter as informações de que precisam com apenas um clique.

Para saber para quem você está escrevendo, é preciso reunir o máximo de informações possíveis sobre quem usará o documento (e, portanto, o produto). É importante saber se o seu público tem experiência na área, se o tópico é totalmente novo para eles ou se eles tem alguma base.

Para entender seu leitor, faça a si mesmo as seguintes perguntas antes de começar a escrever:

  • Quem são meus leitores/usuários?
  • O que eles precisam?
  • Onde eles vão ler?
  • Quando eles vão ler?
  • Por que eles estarão lendo?
  • Como eles vão ler?

E outra sugestão é você fazer o curso de Technical Writing na ESPM (Escola Superior de Propaganda e Marketing),que  acontece agora em fevereiro de 2022. Onde eu (que vos escrevo) o Magerson Bilibio e o André Sato (o é head techwriter num banco) vamos mostrar os segredos da área e as metodologias que você pode conhecer e se aprofundar . Saiba mais sobre nosso curso aqui.

Tags:, , ,