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