5 capacidades esenciales que necesitas para convertirte en un gran escritor técnico

images/essential-skills-technical-writer.jpg

¿Cuál es la diferencia entre un gran escritor y un gran escritor técnico? Ambos son grandes escritores, pero uno de ellos ha dominado las capacidades esenciales necesarias para explicar y enseñar a utilizar a prácticamente todo el mundo cualquier producto que requiera cierto conocimiento técnico, con independencia de sus conocimientos tecnológicos.
Si eres escritor técnico o te interesa convertirte en uno, también es importante que domines las capacidades necesarias. Así que, para facilitarte la escritura técnica, hemos recopilado cinco de las capacidades más importantes que todo escritor técnico debe dominar para ser un profesional.

5 capacidades que debes dominar para ser escritor técnico profesional

1. Domina el arte de la usabilidad y las pruebas

Una de las principales responsabilidades de un escritor técnico es ofrecer un conocimiento tácito del diseño o características de un producto. Uno de los métodos más sencillos de hacer esto es crear escenarios fáciles de entender que pueden darse cuando los usuarios utilicen el producto.
Esta es la razón por la que muchos fabricantes y desarrolladores de software piden a sus escritores técnicos que utilicen y prueben sus productos antes de redactar manuales de ayuda y otros documentos. En algunos casos, es posible que te pidan que te unas a un equipo de experiencia del usuario para validar si el producto funciona efectivamente del modo en que se diseñó para funcionar.
Para dominar esta habilidad, tendrás que probar cada una de las funciones principales y secundarias del producto, una detrás de otra. Haz una lista de las funciones que funcionan adecuadamente y las que no funcionan tan bien. En ciertos casos, es posible que todas las funciones sean correctas, pero el diseño de la interfaz de usuario no sea adecuado. No dudes en incluir eso en la lista como problema.

2. Domina el arte de utilizar herramientas de creación de documentación de ayuda

Todo escritor técnico debería saber utilizar al menos una herramienta de creación de documentación de ayuda con soltura. Las herramientas de creación de documentación de ayuda están diseñadas para simplificar el proceso de redacción técnica y para facilitar la publicación de documentación en diversos formatos diferentes. Algunas de estas herramientas, como HelpNDoc, son gratuitas para uso personal y generan diferentes formatos de contenido, como HTML, archivos CHM help, PDF, Word, archivos Qt help, páginas web para iPhone, eBooks ePub y Kindle.

Hay muchas opciones para publicar documentación y al elegir el formato correcto, es necesario tener en cuenta los lectores objetivo, en particular al elegir un manual de usuario impreso o en pantalla.

3. Domina el arte de realizar investigaciones

La investigación es la base de toda buena documentación técnica. Y si la base es débil, la documentación terminará en el cubo de la basura y el fabricante del producto pagará un coste adicional por ello en concepto de atención al cliente. Este es el motivo por el que producir un manual de ayuda de calidad puede ser la mejor inversión que pueda hacer un desarrollador o fabricante.

En muchos casos, la calidad de la documentación es tan buena como lo haya sido la investigación. Por ello, investigar adecuadamente todos los aspectos del tema es clave para escribir una documentación de gran calidad. A muchos lectores y usuarios de producto les resulta fácil identificar contenido vago o irrelevante. Sin la investigación adecuada, es probable que cometas los mayores errores que cometen los autores de manuales de ayuda.

4. Dominar el arte de entrevistar SMEs

Cuando tengas un nuevo proyecto de redacción técnica, querrás disponer de toda la información y los fabricantes intentarán dártela, pero es posible que no siempre la comuniquen con éxito. Así que, en algún momento, deberás hacer preguntas para obtener la información relevante que necesites a expertos en la materia (SME, Subject Matter Experts).
Uno de los mejores métodos para hacer estas preguntas es realizar una entrevista. Pero realizar una entrevista para extraer toda la información clave que necesitas puede parecer un gran desafío si todavía no has dominado el arte de entrevistar expertos en la materia (SME, Subject Matter Experts).
Hay 3 fases clave para entrevistar expertos en la materia. En primer lugar, deberás prepararte para la entrevista, en segundo lugar, tendrás que hacer la entrevista, y en tercer lugar, necesitarás extraer los puntos significativos que sean relevantes para tu documentación.

Cómo prepararse para la entrevista

Primero deberás investigar un poco los antecedentes del tema o la documentación sobre la que quieras escribir. A continuación, deberás investigar los trabajos anteriores de tu experto en la materia que estén relacionados o conectados con tu proyecto actual. Esto te dará una idea clara de cómo abordar a estos expertos y cómo plantear tus preguntas para extraer los puntos significativos que necesitas.
La siguiente etapa es preparar las preguntas para tu entrevista. Empieza con la información que has recopilado durante tu investigación. Con este método te resultará más fácil crear un esquema lógico para todas tus preguntas. Quizá quieras hacer preguntas como los periodistas, que a menudo empiezan con un enfoque “quién, qué, dónde, cuándo, por qué y cómo”. Una vez preparadas todas las preguntas, programa la entrevista a una hora que resulte conveniente para ti y para el entrevistado.

Cómo realizar la entrevista

No hagas esperar al entrevistado. Empieza a la hora programada y mantén el límite de tiempo establecido. Empieza con preguntas ligeras para que el entrevistado se sienta cómodo si estás haciendo la entrevista por Skype o Google Hangout, y asegúrate de tener preparado tu software o dispositivo de grabación. A veces tendrás que hacer la entrevista varias veces para extraer todos los detalles importantes que necesitas. Céntrate en el tema durante toda la entrevista y evita las distracciones.

Cómo extraer los puntos clave

Cuando termines la entrevista, quizá quieras reproducir la conversación grabada. Haz una lista de los puntos clave o resúmelos. Analiza cuidadosamente la información que has extraído y verifica que cubra las lagunas de información que necesitas para escribir tu documentación. Si la información no es suficiente, quizá tengas que entrevistar a varios expertos en la materia (SME) o incluso a otros escritores técnicos para que te ayuden a encontrar las respuestas correctas que necesitas.

5. Domina el arte de escribir en un estilo claro y conciso

Todos los escritores técnicos deben dominar el arte de comunicar ideas, situaciones y escenarios complejos de un modo sencillo, preciso, claro y conciso. La claridad en la escritura técnica no tiene sustituto, especialmente si pretendes escribir un gran manual de ayuda. A pesar de ello, es necesario no subestimar los conocimientos y nivel de exposición de tu público objetivo.
Si la calidad de tu contenido es mala, tu público objetivo se dará cuenta de ello con facilidad. Si utilizas demasiados tecnicismos, siempre hay una papelera cerca… Adapta siempre tu contenido al nivel de expectativas y conocimientos medio de tu público.

Conclusión

El crecimiento de internet en las dos últimas décadas ha permitido la aparición de muchos negocios basados en la tecnología. El resultado es que los escritores técnicos necesitan actualizar constantemente sus conocimientos y habilidades sobre nuevo software, diseños, herramientas, plataformas, etc. Más que nunca, los escritores técnicos deben dominar nuevas habilidades para mantener su ventaja competitiva. Las habilidades mencionadas en este artículo se encuentran entre las más importantes para todos los escritores técnicos con independencia de su campo.