O Que é Comunicação Técnica

A comunicação técnica é um outro nome para a área conhecida como escrita técnica. Infelizmente esta área praticamente não existe e não é conhecida no Brasil. A comunicação técnica abrange tantas especialidades que fica difícil explicar o que significa o termo. Basicamente a comunicação técnica é uma forma de comunicar assuntos técnicos.

A área de comunicação técnica abrange outras áreas, porque para fazer a comunicação além de escrever e editar documentos é necessário criar gráficos, sites web, ilustrações e muitos outros materiais para que a comunicação seja eficiente.

Definição da comunicação técnica

A comunicação técnica é uma área abrangente que se refere a elaboração de material técnico com o intuito de instruir e auxiliar às pessoas na forma de utilizar produtos, serviços e equipamentos. Podemos usar o termo comunicação técnica nas seguintes situações:

• Comunicação sobre assuntos técnicos como aplicativos para computador, manuais de equipamentos, procedimentos e relatórios técnicos.
• Material elaborado utilizando tecnologia como páginas web, arquivos de ajuda online, ou páginas de redes sociais.
• Elaboração de instruções de procedimentos de como executar uma tarefa independente da dificuldade ou da ferramenta utilizada.

Na área de comunicação técnica existem muitas subáreas distintas que usam profissionais de várias áreas como por exemplo, redator ou escritor técnico, ilustrador, web designer, desenvolvedor, instrutor entre outros.

O profissional que trabalha com comunicação técnica conhecido como Technical Writer é o responsável por produzir materiais tais:

• Instruções de ajuda para software e equipamentos
• Manuais de operação e de usuários
• Especificações funcionais
• Propostas
• Relatórios
• Apostilas para treinamento
• Descrição de produtos e serviços
• Documentação para API

 O objetivo da comunicação técnica é transmitir a informação da forma mais eficiente possível, de modo a facilitar o trabalho das pessoas.

Um pouco da história da comunicação técnica

Desde muito tempo atrás a humanidade utilizou alguma forma de comunicação para entregar a informação. Para explicar o funcionamento de alguma ferramenta por exemplo, podíamos utilizar a conversação, juntamente com uma demonstração, para passar a informação da forma correta de se utilizar a ferramenta.

Com o passar do tempo o desenho e um texto teórico começaram a ser usados para explicar o funcionamento de um equipamento. Veja como exemplo os desenhos famosos de Leonardo da Vinci com detalhes de algumas de suas invenções, onde tínhamos várias vistas de como produzir e utilizar o equipamento.

Helicóptero e Asa de Levantamento
Fonte: https://commons.wikimedia.org/wiki/File:Leonardo_da_Vinci_helicopter_and_lifting_wing.jpg

Mas somente a comunicação conversacional não é suficiente a fim de mostrar todas as informações necessárias para utilizar de forma segura um equipamento. Tornou-se necessário utilizar outras formas. Com a tecnologia atual de criação e distribuição podemos usar além do texto e desenhos, o vídeo.

A comunicação técnica nos dias de hoje está integrada ao produto, é entregue com o produto ou publicada em algum outro local, como na internet. A forma preferida é a mídia eletrônica que pode ser exibida em um dispositivo de fácil acesso como celulares e tablets, mas ainda se utiliza a forma impressa, seja por requisito do cliente ou até mesmo por requisitos legais, dependendo da área de utilização do produto.

Cada vez mais precisamos da comunicação técnica nas formas de manual de operação, instrução de como fazer, manual de processos, relatórios, material para treinamento. O que mudou com a evolução da tecnologia foi a forma de apresentar esses materiais. A necessidade por material de boa qualidade e com conteúdo continua existindo.

Recursos Extras

Vídeo sobre a origem e desenvolvimento da comunicação técnica - The origins and development of technical communication

Contrate um Technical Writer na Romar Consultoria.

Unificando Marketing e Conteúdo Técnico

As empresas preparam o material sobre o produto em vários departamentos, cada um voltado para uma fase da venda do produto. A estratégia de conteúdo geralmente funciona da seguinte forma: assim que o produto está pronto para comercialização ou em fase final prepara-se o material de marketing e propaganda, depois um material mais técnico para que o cliente verifique se o produto atende às suas necessidades, e para o pós-venda tem o material de treinamento ou suporte para auxiliar o cliente na utilização do produto. 

Mas será que apresentar o conteúdo técnico elaborado por departamentos diferentes é uma boa solução para a venda. Vamos conhecer uma opção para melhorar a experiência do cliente na escolha e aquisição de um produto.

Como os Clientes Procuram Conteúdo Técnico

A apresentação e entrega do conteúdo técnico sofreu uma grande mudança com a evolução da tecnologia digital. As empresas criavam o seu conteúdo técnico e distribuía em formato de manuais, panfletos e material de marketing, todos na forma impressa.

Com a evolução do conteúdo digital o cliente escolhe o conteúdo que quer receber, não é o produtor de conteúdo que decide qual informação o cliente utiliza. As informações estão disponíveis em mídia na internet. As organizações se vêm sendo forçadas a produzir o conteúdo técnico e disponibilizar o máximo de informação possível antes da venda, porque hoje o cliente em prospecção vai fazer uma pesquisa antes de adquirir o produto. Ele vai procurar por fontes confiáveis de informação e opiniões de outras pessoas.

Como o cliente é quem decide o conteúdo que ele quer obter as empresas passaram a competir pela atenção e não simplesmente pela venda de produtos. Um cliente pode buscar uma especificação técnica para decidir se vai adquirir um produto ao invés do material de marketing, assim como ele pode usar o material de marketing para decidir fazer uma atualização de seu produto. Como consequência a distinção entre conteúdo para marketing e conteúdo técnico ficou confusa.

Mas as empresas continuam a trabalhar de forma a separar os conteúdos de marketing do técnico. O material técnico muitas vezes está em algum local de difícil acesso, em arquivos PDF simples e que requerem que o visitante do site faça um cadastro para poder ter acesso ao material. Isso dificulta o acesso do cliente que tem interesse em adquirir o produto.

Temos que reconhecer que os clientes nos dias de hoje não seguem em uma linha reta para decidir por uma compra. Eles podem utilizar as redes sociais e discussões em fóruns para tomar uma decisão. As empresas não podem controlar o conteúdo fornecido pelas redes sociais. Elas devem estar atentas para a conteúdo não oficial.

Os clientes tendem a confiar na informação oficial, mas também levam em conta ou confiam mais nas recomendações de amigos.

Como as empresas desenvolvem o conteúdo de marketing e o conteúdo técnico de forma separada o cliente pode encontrar inconsistências nas informações e ficar confuso durante uma compra ou mesmo na utilização do produto.

Como as Empresas Podem Melhorar a Experiência do Cliente

As empresas costumam separar a forma de produzir o material de marketing do conteúdo técnico, apesar de que o material de marketing precisa possuir um pouco do conteúdo técnico. Esse material normalmente possui um estilo e um design mais elaborado do que o conteúdo técnico, que na maioria das vezes é fornecido em arquivos PDF com uma formatação simples, bem diferente da apresentação do material de marketing. O melhor nesse caso é procurar elaborar ambos os materiais com uma apresentação similar de forma a melhorar a experiência do cliente.

Naturalmente as informações de visão geral não precisam ser idênticas ao manual de usuário e nem podem ser, mas poderia ter uma aparência similar em termos de estilo. A experiência do usuário na utilização do conteúdo sobre um produto deveria ser parecida tanto na leitura do material de marketing, como no manual de usuário. Poderia se criar um padrão de design a ser utilizado em todos os conteúdos para o produto.

Os termos técnicos precisam ser padronizados. Como os materiais geralmente são elaborados por setores diferentes dentro da empresa, alguns termos técnicos acabam ficando inconsistentes entre o material de marketing e um manual de referência, por exemplo. Nesse caso seria interessante criar um guia de estilos não só para definir padrões de formatação, como também um dicionário dos termos técnicos para que toda a empresa use os mesmos estilos e termos.

A classificação do conteúdo do produto precisa ser padronizada entre todos os departamentos para facilitar a busca e a navegação. Se cada departamento faz uma classificação de conteúdo diferente dificulta a busca e navegação de informações sobre o produto. Quando o cliente faz uma busca no site da empresa sobre um determinado produto, ele não deve encontrar informações diferentes se estiver procurando pelo mesmo termo na área de visão geral do produto ou na área de suporte. O recomendado é que se faça uma classificação única no conteúdo do produto de forma que, em qualquer busca os resultados sejam os mesmos.

A unificação do material de marketing com o conteúdo técnico pode ser uma estratégia que vai melhorar a experiência do usuário, e como consequência as vendas do produto. O cuidado com a elaboração de um conteúdo unificado facilita a utilização em vários departamentos distintos, além de facilitar a busca e navegação das informações. Cada departamento pode utilizar as partes adequadas da informação no formato mais apropriado para marketing, vendas, treinamento e suporte.

Referências:

The age of accountability: Unifying marketing and technical content with Adobe Experience Manager

Why you need a unified customer experience strategy

5 Boas Práticas para Escrever um Documento

Para tornar um documento claro, objetivo e de fácil entendimento podemos aplicar algumas práticas de escrita que irão transforma-lo em um documento de qualidade. Você não precisa usar todas as práticas de uma só vez, pode usar de acordo com a necessidade e o contexto do documento. Se for um contrato não vai ter gráficos, agora se for um manual é interessante ter figuras ou mesmo gráficos para ilustrar a informação.

Conheça agora cinco boas práticas de escrita para aumentar a qualidade e fazer um documento claro, objetivo e que passe a informação de forma compreensível ou tire a dúvida que o leitor possui.

1. Defina uma Hierarquia

Se você está escrevendo um documento tipo carta, memorando ou um e-mail não é necessário colocar título, porque são documentos com normalmente somente uma página. Agora se você for escrever um documento mais longo tipo relatório ou manual torna-se necessário incluir títulos para dividir os tópicos, e tornar o documento compreensível para o leitor.

Sem uma hierarquia os leitores vão achar o documento confuso e de difícil localização das informações. Uma hierarquia de título clara e lógica é essencial para qualquer documento longo.

O recomendado é construir uma hierarquia lógica com o título principal e algumas subseções, 3 ou 4 subseções no máximo, para não confundir o leitor. Veja um exemplo na Figura 1.

Figura 1 - Exemplo de Hierarquia de Títulos

Seguem algumas regras para montar uma hierarquia lógica:

• Evite título único dentro de uma seção, coloque dois ou mais títulos.
• Evite colocar um título seguido de outro título sem um texto no meio.
• Evite pular níveis de títulos para manter um padrão no estilo dos títulos por exemplo, o título1 deve ser seguido pelo título2 e assim sucessivamente.

2. Escreva Parágrafos Curtos

Os parágrafos são utilizados para organizar o texto em blocos e podem ser divididos em tópicos. Quando mudar de tópico crie um parágrafo novo.

Geralmente o parágrafo é composto de 3 ou 4 sentenças em documentos. Evite parágrafos muito longos para não intimidar o leitor.

Comece cada parágrafo com uma sentença sobre o tópico. Coloque o assunto geral do tópico na primeira sentença e somente depois detalhe o tópico nas demais sentenças.

Não tem problema “quebrar” o parágrafo entre páginas, somente evite deixar uma linha única no começo ou no final de uma página.

3. Use Títulos Informativos

Os títulos são importantes para descrever a informação detalhada do texto logo abaixo do título. É importante colocar um título informativo para auxiliar o leitor a decidir qual parte do documento possui a informação desejada, principalmente em documentos longos como manuais.

Como boa prática na construção de títulos:

• Use títulos que descrevam o tópico, não o tipo de informação. Evite títulos como por exemplo, “Mais Informações”, “Resultados”, “Procedimentos”, “Diversos”. Se o título for para uma tarefa utilize o verbo no gerúndio por exemplo, “Salvando o Arquivo”.
• Mantenha o título curto com no máximo quatro ou cinco palavras, se possível.
• Evite numerar os títulos. A numeração de título é importante somente se for necessário fazer uma referência exata da seção como por exemplo, em documentos de especificação.
• Use títulos similares por exemplo, se você utilizar verbo no imperativo, então faça com que todos os títulos sejam do mesmo padrão.
• Escolha uma forma única de utilizar os títulos em letra maiúscula. Escolha entre colocar a primeira letra maiúscula em todas as palavras com exceção dos artigos e preposições, ou utilizar o formato jornalístico, somente a primeira letra da primeira palavra em maiúsculo.

4. Mostre a Informação Através de Gráficos

Dependendo do tipo de informação fica mais fácil para o leitor entender se for apresentado como uma figura ou gráfico. Veja exemplos de informação representada em gráficos no post O Que é Visualização de Dados. 

Quando você está escrevendo o texto analise se a informação vai ser mais fácil de entender em formato de parágrafos ou através de:

• Lista de marcadores,
• Caixa de texto,
• Textos laterais,
• Tabelas,
• Listas numeradas,
• Imagens,
• Diagramas,
• Captura de telas,
• Gráficos.

Exibir a informação em outros formatos além de blocos de parágrafos facilita o entendimento e auxilia o leitor a localizar a informação de forma mais rápida.

5. Escreva de Forma Clara

Os documentos utilizados para os negócios são documentos com o propósito de comunicar a informação de forma rápida e de maneira clara.

Evite utilizar palavras complicadas e sentenças longas. Escreva objetivamente utilizando palavras do dia a dia e sentenças curtas, dando preferência ao formato sujeito-verbo-objeto.

As boas práticas para escrever um documento podem ser utilizadas em vários tipos de documentos como manuais, relatórios, especificações, guias e muitos outros tipos. Para melhorar a qualidade de seus documentos vá inserindo aos poucos as boas práticas, com o tempo você já vai estar habituado a usar as boas práticas de escrita.

Posts Relacionados:

7 Dicas de Como Planejar um Documento
5 Estratégias para Escrever um Documento

5 Estratégias para Escrever um Documento

Escrever bem não é uma atividade fácil. Muitos escritores têm dificuldade para escrever, inclusive os escritores profissionais. Em algum momento ou mesmo com uma certa frequência o escritor sofre bloqueios, tem dificuldade em organizar o documento, comete erros simples ou demora muito tempo para conseguir escrever.

Conheça 5 estratégias que podem fazer com que você seja mais produtivo quando for escrever um documento.

1. Prepare um Esboço

Antes de iniciar a escrita de qualquer tipo de documento faça um esboço dos tópicos que você quer escrever. Estude o assunto e organize-o de modo que você possa apresentar o conteúdo de uma forma simples, organizada e lógica.

Uma boa forma de organizar o conteúdo é fazer um esboço da tabela de conteúdo do documento. Com o esboço da tabela você tem uma visão do que precisa escrever e qual a ordem.

2. Escreva e Edite

Não tente escrever e editar ao mesmo tempo. Essas são duas atividades que devem ser feitas separadamente e em momentos diferentes.

Se você editar enquanto escreve o texto, o seu raciocínio é interrompido a cada momento que edita algum erro. Essa interrupção atrapalha o fluxo do seu raciocínio e diminui a sua produtividade.

Muitos escritores acham que é mais rápido e produtivo escrever primeiro e somente depois editar o que produziu, sem ficar tentando tornar o texto perfeito na primeira vez e ficar interrompendo o raciocínio a todo momento.

3. Escreva, Revise e Edite

Planeje passar pelo documento pelo menos três vezes. A primeira vez escreva, faça um rascunho, pesquise, obtenha a informação que você precisa, e comece a escrever. Alguns escritores acham que escrevem melhor quando escrevem rápido. Não se preocupe nesse momento em tornar o documento perfeito.

Na segunda vez revise, verifique os problemas maiores como a organização da informação, se existe informação incorreta ou faltante, se o texto está claro. Nesse passo você pode ter que reescrever algumas seções.

Na terceira vez edite, nesse momento verifique a gramática, a pontuação e o estilo da escrita. Se tudo estiver correto essa pode ser a verificação final.

4. Espere Dois ou Três Dias antes de Reescrever

Você deve achar difícil revisar e editar um texto que acabou de escrever. Este problema tem a ver com a memória-curta, ou seja aquela memória que armazenamos por um curto período de tempo.

Como acabamos de escrever o texto ele ainda está armazenado na memória. Fica difícil visualizar os problemas. Após uns dois ou três dias você já não se lembra totalmente do texto, esse é um bom momento para revisar e editar.

Quando você ler o texto novamente vai ser um texto novo para você, então fica mais fácil encontrar os problemas e até mesmo rever algumas sentenças.

5. Leia o Texto em Voz Alta

Quando você finalizar leia em voz alta e escute atentamente o texto. Nesse passo você vai conseguir identificar se ainda existe algum problema e se o texto está em um formato conversacional. Esse é um bom formato para deixar o texto claro para quem está lendo.

Essas cinco estratégias para escrever ajudam bastante em qualquer modalidade de escrita que você precisa fazer, seja um material de ficção, de não ficção ou até mesmo um documento técnico.

Posts Relacionados

7 Dicas de Como Escrever um Manual

7 Dicas de Como Planejar um Documento
5 Boas Práticas para Escrever um Documento
5 Estratégias para Escrever um Documento

7 Dicas de Como Planejar um Documento

Muitos escritores começam a escrever sem ter a menor ideia de qual caminho tomar. Isso se aplica a várias áreas de escrita como por exemplo, ficção, negócios ou até mesmo acadêmica. Se você for escrever em e-mail tudo bem não planejar antes, porque você já sabe o que vai escrever. Agora se você for escrever um manual ou um relatório é necessário fazer um planejamento antes de iniciar a escrita.

O planejamento vai auxiliar nas tomadas de decisões sobre quais tópicos e níveis de detalhamento que você deve colocar no documento, além de apresentar uma visão clara e organizada que o documento deve possuir na apresentação final. Com esta visão fica mais fácil e rápido elaborar o documento.

Antes de iniciar um documento devemos nos fazer algumas perguntas:

1. Porque estou escrevendo este documento?
2. Qual o objetivo?
3. Quem vai ler e qual informação a pessoa necessita.

Conheça neste post 7 dicas que você pode utilizar para auxiliar no planejamento de um documento e tornar a escrita mais rápida.

1. Defina qual o Propósito

Defina o motivo de escrever o documento. Sem uma definição clara do propósito do documento fica difícil escrever. Como você vai saber qual informação incluir e o nível de detalhamento necessário. Alguns exemplos de propósito podem ser:

• Interpretar resultados de laboratório
• Fornecer instruções
• Descrever serviços disponíveis para o cliente
• Reportar a solução para um problema
• Iniciar um novo procedimento
• Estabelecer sua credibilidade profissional
• Gerar Negócios

2. Defina seus Objetivos

Antes de iniciar a escrita de qualquer tipo de documento precisamos definir qual o objetivo do documento, por exemplo fazer com que um usuário consiga utilizar um software, um técnico consiga instalar um equipamento, um cliente consiga montar um equipamento.

Definir o objetivo é importante porque além de guiar o curso da escrita do documento, auxilia a verificar se atingiu o objetivo desejado após a finalização do documento.

3. Defina sua Audiência

Conhecer a audiência é importante para escrever um documento. Se você conhece a audiência fica mais fácil definir como escrever e o grau de dificuldade do texto. Se a audiência é um grupo de pessoas por exemplo, técnicos especializados de uma área específica, o documento pode ter mais termos técnicos da área e você não precisa se preocupar em definir todos os termos, porque a audiência já conhece o assunto.

Se for um grupo de pessoas com conhecimento variado e você precisa escrever um documento técnico, vai ser necessário explicar com mais detalhes os termos técnicos, porque nem todas as pessoas da audiência conhecem o assunto. Escrever um documento desse tipo é um pouco mais complicado.

Procure conhecer a sua audiência, pesquise quais são os interesses, quais são as informações que a audiência necessita. Somente após conhecer a sua audiência é que você deve escrever o documento.

4. Entenda o Tipo de Documento

A forma que as pessoas leem depende do tipo de material. Se for um livro para distração, tipo uma aventura ou um romance, as pessoas leem do começo ao fim. Se for uma apostila ou livro didático o leitor normalmente lê os capítulos de interesse e antes de ler o próximo capítulo procuram entender o capítulo anterior, porque normalmente existe uma dependência no entendimento dos capítulos anteriores para entender o próximo.

Se for um manual ou um relatório o leitor procura diretamente a informação desejada. Os manuais são destinados principalmente para procurar informações, para resolver um problema, responder uma dúvida ou para completar uma tarefa.

Para esse tipo de documento você pode seguir alguns passos que facilitam a procura da informação pelo usuário, por exemplo:

• Organize as informações relacionadas no mesmo local. 
• Divida o texto em partes lógicas. 
• Crie uma tabela de conteúdo com a relação dos tópicos. Se o documento possuir mais de 50 páginas crie também um índice alfabético. 
• Utilize técnica de apresentação, tipo listas numeradas, tabelas e diagramas. 
• Realce as palavras chaves e ideias.

Somente após definir o tipo de documento por exemplo, se livro, manual, apostila, relatório, você pode definir a organização e como vão ser apresentados os tópicos do documento.

5. Organize suas Ideias

Uma vez definido os tópicos que compõem o documento precisamos organizar, por isso considere:

• Como a informação será utilizada. 
• Como normalmente esse tipo de informação é organizada. Pesquise material semelhante. 
• Os leitores estão familiarizados com as informações ou é necessário fazer a introdução e detalhar cada informação. 
• Qual a relação lógica entre as diferentes partes da informação.

6. Organize seu Documento

A organização das informações não precisa ser idêntica em todo o documento, depende do tipo de informação. Uma seção pode estar em ordem de tópicos outra em ordem alfabética.

Pode-se organizar uma seção com a sequência de informações de forma a explicar os detalhes mais facilmente ou por ordem de tarefas.

A organização do documento vai depender do tipo de informação e como apresentar de forma a ficar clara, objetiva e lógica para o leitor.

7. Faça um Esboço Antes de Escrever

Antes de iniciar a escrita do documento faça um esboço das ideias principais. Se for um documento longo como um manual, faça antes um esboço da tabela de conteúdo com os tópicos principais e pelo menos um subtópico. Se o documento for mais complexo inclua vários níveis na tabela de conteúdo.

Um exemplo que posso citar é o Ebook Introdução ao Scrum que escrevi recentemente. Antes de iniciar o ebook fiz primeiro um esboço do que é atualmente a tabela de conteúdo. Este processo me ajudou a ter uma visão clara da organização que eu queria apresentar no documento.

O esboço serve para você visualizar o conteúdo necessário para o documento e para ajudar em uma reunião com as outras pessoas envolvidas no projeto.

Sem um planejamento anterior fica muito difícil escrever qualquer tipo de documento. Pode dar um pouco de trabalho fazer o planejamento antes, mas a recompensa vem depois. Esse tempo que você gasta fazendo o planejamento você ganha lá na frente, porque o rendimento no momento de escrever vai ser muito maior. Você já sabe exatamente que passos seguir, o que escrever e a organização da informação, isso faz com que o processo de escrever seja mais rápido. 

Post Relacionado

Template Plano de Documentação
5 Estratégias para Escrever um Documento
5 Boas Práticas para Escrever um Documento

As Dificuldades para Avaliar um Redator Técnico

A avaliação de um redator técnico para contratação não é muito fácil, assim como a avaliação de profissionais de qualquer área. No caso do redator técnico o comum é solicitar uma amostra de trabalhos anteriores para avaliar a qualidade de escrita, a gramática, a organização, o cuidado com o design, a clareza no texto, e mais alguns itens que cada contratante verifica de acordo com a necessidade de sua empresa.

A análise da amostra nem sempre pode ser um fator decisivo na contratação do profissional, porque apesar do profissional apresentar uma amostra do trabalho que ele executou, esta amostra pode conter também o trabalho de outros profissionais envolvidos no projeto.

A elaboração de um documento técnico pode ter várias etapas como elaboração do template, organização do documento, elaboração de desenhos, figuras e gráficos, de forma que seja necessária a participação de diversos profissionais, além do redator.

Portanto o redator técnico pode ter uma participação grande na elaboração do documento, mas o documento pronto pode ter a participação de outras pessoas, o que significa que a amostra não pode ser utilizada como um fator determinante da definição da qualificação do profissional.

Para auxiliar na avaliação além da análise da amostra de trabalho, a entrevista é um passo importante para entender a participação do redator na elaboração do trabalho apresentado como amostra.

Na contratação de um redator técnico alguns profissionais da empresa estão envolvidos na decisão final, e nem sempre todos possuem a mesma opinião na forma de avaliar a amostra e as respostas obtidas na entrevista. Neste caso uma ideia seria montar uma estratégia padrão que definisse os critérios de qualificação da amostra, e um questionário para a entrevista do redator.

Critérios para Avaliação da Amostra de um Documento Técnico

Os critérios para avaliação da amostra podem ser:

• Organização do Documento
• Design e Aparência do Documento
• Clareza do Texto
• Qualidade dos Exemplos
• Gramática

Estes critérios são genéricos e podem ser aplicados em uma grande variedade de documentação técnica. Cada critério pode ter uma nota com peso para definir quais são mais importantes para o trabalho desejado.

Questionário para Entrevista de um Redator Técnico

Algumas perguntas para avaliar o redator técnico:

• Você foi o único autor do documento ou existiram outros autores?
• Você elaborou o Template do documento ou utilizou um Template pré-definido?
• O design e organização foram elaborados por você ou foi pré-definido?
• Quais as ferramentas você utiliza para escrever o documento?
• Os exemplos exibidos no documento foram elaborados por você ou por outra pessoa técnica da equipe?
• Você elabora conteúdo técnico para web ou somente para documentos off-line, tipo impressos ou arquivo PDF?

A avaliação de um redator técnico é uma tarefa difícil, porque além dos critérios que podem ser utilizados de uma forma geral, cada negócio exige uma especialidade diferente e pelo menos conhecimento básico da área. Com os critérios de avaliação pré-definidos fica mais fácil para comparar e avaliar a qualificação do profissional.

Referência

Evaluating Writing Samples: Strategies for TechComm Hiring Managers

Template Plano de Documentação

Quando vamos escrever um documento técnico, seja ele um manual, uma especificação técnica ou um guia rápido, precisamos planejar o que este documento deve conter, ou seja, é necessário fazer um planejamento do documento para definirmos todo o escopo que o documento deve abranger, além de detalhes sobre recursos, prazos, requisitos só para citar alguns.

Neste post apresento um Plano de Documentação que pode ser utilizado antes do início da elaboração do documento técnico para alocar recursos e planejar a criação e manutenção do conteúdo técnico do documento. Além disto, forneço no final do post um Template do Plano de Documentação, que pode ser utilizado livremente como sugestão para a criação de seu próprio Plano de Documentação.

A elaboração do Plano de Documentação é tão importante quanto o próprio documento, porque ele vai auxiliar, facilitar e guiar a elaboração de seu documento durante toda a fase do projeto. Ele acaba sendo uma referência para toda a equipe com os detalhes para a elaboração do documento.

Um Plano de Documentação pode ser composto pelos tópicos:

Tópicos Plano de Documentação

• Propósito: Descreve para que serve o documento, qual o objetivo e o que se espera alcançar com o documento pronto.
• Entregas: Descreve quais são os documentos que devem ser produzidos com detalhes dos responsáveis pelas várias fases e datas previstas de início e publicação.
• Requisitos Gerais e Legais: Descreve quais são os requisitos gerais que o documento deve obedecer e os requisitos legais quando necessário como, por exemplo, normas que deve atender dependendo da área onde vai ser utilizado.
• Audiência: Descreve quais são os tipos de pessoas que utilizarão o documento como, por exemplo, pessoas com conhecimento técnico do assunto, com algum conhecimento técnico, mas não conhecem o assunto propriamente dito, que são totalmente leigas ao assunto. Esta etapa é importante porque vai definir o tipo de terminologia e grau de dificuldade que o documento pode conter.
• Premissas, Restrições e Dependências: Descreve o fato inicial que prevê a geração do documento, as dependências e restrições de utilização do documento.
• Processo: Descreve os passos que devem ser executados na preparação do documento.
• Prazos de Entrega: Determina os prazos de entrega de cada fase do documento.
• Funções e Responsabilidades: Define as funções e responsabilidades de cada membro da equipe de comunicação técnica.
• Recursos: Determina os recursos que serão utilizados na preparação do documento como, por exemplo, o software de editoração e publicação, ferramentas de desenho, uma versão do aplicativo (se software) ou um produto para utilizar durante a elaboração do documento, uma especificação de requisitos, ou um manual antigo.

Download Template Plano de Documentação

O Plano de Documentação é uma etapa importante no processo de elaboração de qualquer tipo de documento técnico, seja ele, um manual, um guia, uma apostila, um help online, etc., porque permite planejar e alocar recursos para criar ou manter o conteúdo técnico do projeto ou produto.

Referência

Documentation Plan Template

7 Dicas de Como Escrever um Manual

Recentemente li um Manual de Escrita Técnica bem interessante que detalha os passos de como escrever um Manual, independentemente do tipo de manual ou de produto. São dicas genéricas que podem ser seguidas para qualquer tipo de Manual. Neste post apresento um resumo dos principais passos mencionados. Você pode acessar o Manual completo ou fazer o download através do link Tech Writing Handbook.

Para escrever um manual existem duas leis básicas, a primeira é que é necessário ter o conhecimento sobre o assunto que o Manual vai abordar, se for um produto, é necessário conhecer o produto, se for um software é necessário utilizar o software, se for instruções para montar ou consertar algum produto é necessário executar a montagem ou conserto, antes de escrever sobre o assunto.

A segunda lei é conversar com os especialistas que desenvolveram o produto ou o software, perguntar, consultar tentar obter o maior número de informações possíveis sobre o assunto que o Manual deve abordar.

Além de obedecer as duas leis básicas podemos seguir alguns passos para que o Manual seja claro, objetivo e fácil de entender.

1. Seja coerente

• Comece o parágrafo com a informação mais importante.
• Escreva os fatos, as informações que não forem relevantes não precisam ser incluídas.
• Escreva sentenças curtas com no máximo 24 palavras.
• Não utilize palavras vazias por exemplo, no evento de, substitua por se.
• Utilize voz ativa, elimine o verbo Ser. Elimine seria, deveria ser,  tinha sido.
• Utilize voz passiva estrategicamente, mas se puder substituir por voz ativa, substitua.
• Quando der direções comece a frase com o Verbo.

2. Escreva com Clareza

• Utilize linguagem simples.
• Não utilize jargões.
• Não transforme verbos em substantivos.
• Utilize as palavras um, uma, o, a, sem problemas. A omissão dessas palavras faz o texto parecer que foi escrito por um robô.
• Faça testes com pessoas que não conhecem o assunto do Manual. Peça para que elas leiam o conteúdo e verifique se está claro e não existe nenhuma dúvida. Se existir significa que o Manual não está claro.
• Não use as palavras, bastante, principalmente, um pouco,  parece, espécie de,  bonito.
• No caso de siglas explique o significado a primeira vez que aparece no texto e coloque a sigla entre parênteses.

3. Comunique-se com Clareza

Cada autor tem um estilo de escrita que deve ser seguido do começo ao fim do Manual. O recomendado é que o autor seja espontâneo.

A utilização da segunda pessoa você ou seu, sua, pode ser utilizado sem problemas. Inclusive o texto fica mais claro. Naturalmente não deve ser utilizado em textos científicos que devem demonstrar imparcialidade.

Os parágrafos devem ser curtos. A regra de parágrafos com cinco sentenças não é aplicada em escrita técnica. Um parágrafo pode ser iniciado quando se inicia um novo pensamento. Uma recomendação é utilizar os marcadores para dar uma "quebrada" no texto.

4. Verifique a Audiência

Para escrever um bom Manual, o ideal é conhecer a audiência que vai utilizar o Manual. Um Manual para cliente não técnico deve ter termos simples e fáceis de entender. Um Manual para uma audiência mais técnica pode utilizar os termos técnicos já conhecidos.

Dependendo da audiência verifique a possibilidade e necessidade de incluir um glossário em seu Manual.

5. Fotografe o Processo

Não devemos somente explicar como fazer, é necessário mostrar como fazer. Utilize outras formas de figuras, além de fotos devemos utilizar outras formas de imagem para explicar como fazer determinado procedimento, portanto utilize gráficos, diagramas,  ilustrações, vídeos.

6. Organize o Conteúdo

• Faça um esboço do conteúdo do manual.
• As pessoas vão ler o Manual para procurar como fazer uma determinada tarefa se for o caso, portanto organize o Manual por tarefas nestas situações.
• Utilize listas, numeradas ou não.
• Escreva instruções úteis, e quando possível peça feedback das pessoas que leram o Manual.
• Se a tarefa for um passo a passo, explique em sentenças curtas com fotos ou diagramas o que deve ser feito na sequência correta.
• Faça reuso de conteúdo de forma inteligente. Se uma determinada tarefa for um pré-requisito que pode ser reutilizado, descreva o pré-requisito no Guia de Pré-Requisitos, depois somente mencione a página do pré-requisito, quando for necessário utilizá-lo novamente.

7. Requisitos Legais

As informações de perigos e riscos de utilização de determinado produto devem aparecer no manual de forma clara e chamativa por exemplo, com ícones, cores, letra em negrito. O texto também deve ser fácil de entender.

Muitas empresas para se protegerem legalmente iniciam o manual com páginas de recomendações e cuidados.  O manual deve ter as recomendações, mas devemos ser coerentes e manter um bom senso na quantidade e no tipo de recomendação.

Antes de iniciar a elaboração do Manual verifique se é necessário seguir alguma norma da empresa ou do local.

A elaboração de um bom Manual não é uma tarefa fácil, requer pesquisa, planejamento, conhecimento do assunto que será abordado, entre outros detalhes como apresentação e distribuição, mas sempre é bom conhecermos algumas dicas que podem ser seguidas durante a elaboração do Manual, para termos um bom resultado junto ao cliente.

Posts Relacionados
10 Cuidados ao Utilizar Imagens em Documento Técnico

A Importância do Manual de Usuário

10 Cuidados ao Utilizar Imagens em Documento Técnico

A utilização de imagens em documentos técnicos apresenta grandes desafios independentemente do formato de apresentação do documento, seja impresso, em arquivo, em um site, em um celular ou tablet.

Na grande maioria dos documentos técnicos existem várias imagens para facilitar a compreensão do texto. Uma imagem pode simplificar o entendimento de determinado processo ou mesmo facilitar a localização de algum recurso.

Neste post vamos listar alguns desafios e cuidados que devemos ter ao utilizar imagens em documento técnico.

1. Armazenamento dos Arquivos de Imagem

Quando escrevemos um documento técnico, por exemplo, um manual de usuário de um aplicativo, podemos capturar as imagens das telas e ir “colando” diretamente no documento, sem se preocupar em armazenar estas imagens para edição posterior. Se o aplicativo sofrer alterações podemos capturar a imagem novamente e refazer o processo, por isto às vezes não pensamos em armazenar a imagem em um local separado.

Mas e se precisarmos da imagem novamente para utilizar em outro documento, ou se precisarmos de partes da imagem para fazer um passo a passo. Este é somente um exemplo que indica a importância de armazenar em um local separado todas as imagens utilizadas no documento.

2. Utilizar Imagens Vetoriais x Não Vetoriais

Podemos dividir os tipos de imagens utilizados em documentos técnicos como vetoriais e não vetoriais.

As imagens vetoriais são compostas por pontos, linhas, formas, polígonos entre outros elementos os quais são baseados em expressões matemáticas. Este tipo de imagem por ser baseada em vetores são mais leve e podem ser ampliadas e reduzidas sem perder a qualidade. Um exemplo de imagem vetorial utilizada em navegadores e recomendada pela W3C é o formato SVG (Scalable Vector Graphics). O formato SVG utiliza a linguagem XML para descrever de forma vetorial desenhos e gráficos.

As imagens não vetoriais são compostas por pontos diferenciados por sua cor. Podemos citar como imagens não vetoriais mais comuns as imagens com formato JPG, BMP, PNG, GIF entre outras. Estas imagens possuem um tamanho de arquivo maior e perdem a qualidade quando redimensionadas.

Uma situação comum que acontece em documentos técnicos são as atualizações do produto, processo ou aplicativo. Nestes casos a imagem precisa ser atualizada. É neste momento que vemos a importância de utilizar imagens vetoriais, quando possível. Nem sempre é possível utilizar imagens vetoriais como, por exemplo, em manuais de software. Nestes casos as imagens são capturas das telas do aplicativo, que são gravadas em formato não vetorial.

Para as imagens não vetoriais a substituição é o mais comum, às vezes é possível alterar a imagem dependendo das modificações do aplicativo, mas redimensionamento da imagem pode ser um problema, já que a cada vez que redimensionamos a imagem, ela perde a qualidade, principalmente o formato JPG.

Para as imagens vetoriais podemos fazer as alterações necessárias diretamente na imagem e gerar a imagem final alterada em diversos formatos e dimensões, sem a perda da qualidade da imagem.

Portanto um cuidado que podemos ter é utilizar, quando possível, imagem vetorial e a partir destas imagens gerar o não vetorial para os diversos tipos de publicações.

3. Imagens Utilizadas como Referência

Em alguns tipos de plataformas onde são apresentados os documentos técnicos, como navegadores que utilizam HTML ou documentos desenvolvidos com DITA, não permitem a inserção direta da imagem e sim uma referência do local onde está a imagem.

Neste formato de documentação é necessário ter muito cuidado para controlar o local das imagens. As atualizações das imagens não são feitas no documento e sim diretamente no arquivo da imagem, por este motivo o controle da localização da imagem é muito importante para evitar problemas como exibir a imagem correta, ou não exibir nenhuma imagem, porque o arquivo foi retirado ou alterado de sua localização original.

4. Publicação das Imagens

Cada plataforma de publicação de documento com imagens pode aceitar somente alguns formatos específicos de imagem, por exemplo, o formato SVG é relativamente novo e, por exemplo, no caso do Internet Explorer funciona somente a partir de versão 9. Se você precisa publicar em plataformas mais antigas ou mesmo plataformas que não aceitam este formato, é necessário converter a imagem em outros formatos como, por exemplo, JPG ou PNG.

Portanto é sempre bom ter a mesma imagem em vários formatos para o caso de publicar o documento em diferentes plataformas.

5. Reuso da Mesma Imagem

Utilizar a mesma imagem para explicar situações diferentes é tentador, mas o usuário pode ficar confuso se a imagem possuir muitos detalhes que não são relevantes ao contexto em questão. Mesmo que existam setas ou outras indicações o usuário pode não entender. Nestes casos o melhor é cortar a imagem e exibir somente a parte relevante ao assunto. Os usuários estão mais propensos a perdoar um detalhe irrelevante que está faltando, do que visualizar muitos detalhes que não existem em sua aplicação e causar dúvidas na utilização.

6. Controle de Versão de Imagem

Em um documento técnico que possui controle de versão, as imagens existentes no documento não são controladas da mesma forma como o texto, portanto não dá para saber qual a versão de imagem está no documento.

Para controlar a versão da imagem pode-se utilizar um aplicativo de controle de versão normal, mas as imagens vão ter que ter o seu próprio controle de versão, independente do documento. No caso de imagens de manual de usuário possuir as várias versões das imagens pode ser útil para identificar as diferentes versões do aplicativo e possível evolução do mesmo.

7. Tamanho da Imagem

O tamanho e resolução da imagem são importantes tanto no documento como no ambiente de publicação. Quando estamos trabalhando com a ferramenta de criação e edição de imagem não existe uma preocupação com o tamanho final da imagem, porque queremos obter uma imagem com a melhor resolução possível, mas dependendo do documento e de onde o documento vai ser publicado torna-se necessário tomar alguns cuidados.

Por exemplo, inserir documentos com alta resolução e com o tamanho do arquivo muito grande em documentos Word, pode ser um problema. Primeiro o arquivo Word final vai ficar com um tamanho muito grande dificultando o manuseio do arquivo e armazenamento, sem falar na dificuldade de enviar o arquivo para revisão em outros departamentos.

Se a publicação final for um documento impresso em impressora comum, não é necessário que as imagens sejam em alta resolução, porque a impressora não vai reproduzir toda a resolução. Se for um documento PDF o tamanho da imagem também é importante para não termos um arquivo muito grande.

Se a publicação for feita na internet, temos o problema de velocidade e quantia de bytes necessários para fazer o download e exibir a imagem, portanto neste caso também não é necessário termos figuras com uma resolução muito alta.

De uma forma geral após a elaboração da imagem é necessário verificar onde vai ser publicada para decidir o tamanho e resolução finais da imagem.

8. Atualização de Imagens

A atualização de imagens podem seguir dois processos diferentes, dependendo de como foi utilizada no documento. No caso da imagem estar inserida diretamente no documento a atualização de imagem é bem trabalhoso, porque é necessário alterar cada imagem no documento.

No caso de documentos que possuem a referência da imagem pode ser um pouco menos trabalhoso, porque precisamos alterar a imagem somente no local físico. Como o documento possui uma referência, ele acaba sempre exibindo a imagem mais atualizada, se existir um processo bem definido de atualização destas imagens.

9. Controle de Qualidade das Imagens no Documento 

O controle de qualidade das imagens no documento é muito importante para garantir a qualidade final, por isto sempre verifique todas as imagens inseridas no documento, e em todas as plataformas de publicação. Às vezes algum formato não exibe corretamente em determinada plataforma, ou pior no caso de inserirmos somente a referência da imagem, é importante verificar a exibição da imagem, se ficou com uma boa qualidade e se a referência está correta.

10. Tradução de Texto em Imagens

Um problema comum em documentos é a utilização do documento em várias línguas. Neste caso o documento deve passar pelo processo de tradução, mas e as imagens como ficam?

Se a imagem possui texto no caso de um documento que deve ser feito em várias línguas, gera um problema, porque é necessário fazer a tradução do texto das imagens e depois alterar a imagem para inserir o texto. Neste caso podemos ter uma imagem para cada língua do documento.

Uma forma de minimizar este problema é procurar trabalhar com imagens com pouco ou sem texto se possível, ou se for necessário indicar alguma informação textual, podemos indicar a informação com números e criar uma tabela que referencia o número com o texto.

Para elaborar um documento técnico dependendo da aplicação, além do conteúdo em termos de texto é necessário fazer um bom planejamento sobre o a criação e gerenciamento das imagens, porque as imagens são parte importante do bom resultado da usabilidade do documento.

Posts Relacionados:

A Importância do Manual de Usuário
7 Dicas de Como Elaborar um Manual

Referência:

11 images issues for tech doc systems

8 image translation issues for tech doc

A Importância do Manual de Usuário

Quando um aplicativo está pronto para lançamento, independentemente do tipo, seja ele para computador, tablet ou celular, é importante para os clientes terem acesso às informações do aplicativo. Antes de adquirir ou mesmo utilizar um aplicativo, o cliente precisa ter acesso pelo menos às informações básicas como, instalação, configuração, utilização, entre outros detalhes. Neste caso o manual de usuário é uma forma importante de se fazer a propaganda.

No caso de aplicativos que fornecem a possibilidade de se fazer o download e utilizar por um período, antes de fazer a aquisição, geralmente o cliente procura por informações como, por exemplo, as telas, como funciona e os recursos principais.

Estas informações iniciais já representam uma parte do manual, ou seja, um guia rápido de informações de funcionamento e utilização do aplicativo. A partir destas informações o cliente decide se vale a pena ou não adquirir o produto.

Portanto inicialmente o cliente precisa de informações claras, objetivas e simples para um primeiro contato. Depois desta fase ele precisa de informações mais detalhadas, onde possa tirar as dúvidas ou conhecer melhor as funcionalidades mais avançadas.

Nos dias de hoje, o termo manual não tem o mesmo significado que antigamente. Até bem pouco tempo atrás quando um aplicativo era adquirido, juntamente acompanhava um manual ou guia rápido. Este manual vinha na forma impressa e depois no formato digital em PDF.

Atualmente os manuais evoluíram juntamente com os aplicativos, e são apresentados em vários outros formatos além do PDF. Temos as informações diretamente na web, geralmente no site do produto, e em outros formatos específicos para celulares, tablets e outros tipos de dispositivos de leitura.

Além disto, o manual também não é mais uma espécie de “livro”, onde todas as informações estão em um único local de uma forma sequencial. Hoje as informações estão separadas em partes, por exemplo, uma parte mais simplificada acompanha o aplicativo, a explicação mais detalhada está no site ou é fornecido um guia completo onde o cliente pode fazer o download para leitura no computador, tablet ou celular.

Um exemplo é o manual do iPhone. Quando você adquiri um iPhone o manual não acompanha o produto, mas você pode ter acesso ao manual completo de utilização do iPhone, através do iBooks que é uma aplicação que já vem instalada no dispositivo.

Com a diversidade de dispositivos utilizados, a informação deve estar disponível em vários formatos específicos para cada dispositivo.

O grande desafio de hoje, após a elaboração do conteúdo para o manual de usuário, é gerar a informação nos vários formatos necessários para atender a maioria dos dispositivos de forma a apresentar uma boa comunicação visual.

Posts Relacionados

10 Cuidados ao Utilizar Imagem em Documento Técnico
7 Dicas de Como Escrever um Manual