¿Cuáles son las habilidades más importantes que debe tener un escritor técnico?

Fui escritor técnico durante varios años. Creo que tuve bastante éxito. Hubo varias cualidades que me permitieron servir bien a mis clientes internos.

1 – Capacidad para comprender los procesos que los expertos en la materia (PYME) tuvieron que documentar.
2 – Capacidad y disposición para decir a las PYME: “No entiendo”.
3 – La capacidad de ver lagunas lógicas en un proceso. Por ejemplo, si un paso comenzara cuando otro terminara, ¿cómo se suponía que sucedería eso? ¿Fue automatizado? Si no, ¿no tenía que haber un paso de comunicación? ¿Eso necesitaba ser documentado? ¿Se suponía que todos los usuarios “solo sabían” que el primer paso había terminado? Supuse que la telepatía y la clarividencia no eran realmente parte del proceso.
4 – La capacidad de entrevistar y guiar a las PYME para que avancen de principio a fin en los procesos que estaba documentando.
5 – La capacidad de gestionar las expectativas en términos de plazos. Y si no podía, y algo iba a pasar, una buena disposición para ir a mi supervisor e informarle de la dificultad y explorar posibles soluciones.

Se presumen varias habilidades de software para el trabajo de redacción técnica. El software de documentación (generalmente estaba en un entorno basado en Microsoft Office) y la capacidad de crear capturas de pantalla, diagramas (Visio, Photoshop), etc. también son una especie de requisito previo mínimo. Los proyectos más técnicos requieren que el escritor técnico sea capaz de comprender e incluso escribir código o comprender planos, etc. Mis habilidades estaban en el entorno de los procesos comerciales, por lo que nunca fue mi área. Pero conocía escritores que sí. Y tenían cada vez más demanda. Si estuviera entrando en el campo hoy, estaría buscando reforzar mis conocimientos de codificación y / o ingeniería.

7 habilidades más importantes que debe tener un escritor técnico

1)

CURIOSIDAD En primer lugar, debe tener una curiosidad infinita tanto por la tecnología y la ciencia, por un lado, y por escribir y comunicarse, por el otro. La escritura técnica florece en la intersección de estas dos áreas de interés. No es necesario ser un experto en tecnología ni en escritura, ya que ambos son temas muy amplios y es imposible saber al 100% todo lo que se necesita saber, especialmente en el campo de la tecnología. El teléfono celular que compré hace 3 años está casi obsoleto ahora. Mientras escribo estas líneas, Elon Musk acaba de presentar el primer prototipo de su semi-camión totalmente eléctrico. Debe seguir aprendiendo nuevo software, nuevo hardware, nuevos conceptos de sistema. Si no tiene curiosidad por estas cosas, no sobrevivirá como escritor técnico, ya que no puede describir y documentar lo que no le interesa .

2)

ORDEN. ¿Cómo se ve tu habitación? ¿Tienes tus calcetines colgando de la parte superior de la lámpara? ¿Hay una caja de pizza medio vacía y de una semana de antigüedad en tu cama? Entonces lo más probable es que no seas una persona que se preocupe mucho por el orden y la jerarquía en tu vida. Para convertirse en un buen escritor de tecnología, debe tener un sentido firme de orden y disciplina. Las cosas que no se alinean correctamente, las cosas que no se almacenan de una manera geométricamente agradable, las oraciones y los párrafos que no se introducen con una jerarquía de vista de árbol deberían molestarlo. Debe tener el impulso interno de limpiar cosas sucias y narrar procedimientos de varios pasos de manera lógica y secuencial.

3)

PACIENCIA. Las cosas no siempre salen bien en la escritura técnica. Hay muchos obstáculos y contratiempos inesperados en el camino al crear un documento técnico. Estos contratiempos comienzan con su incapacidad ocasional para no comprender el sistema que está documentando debido a la confusión organizacional y otras dificultades relacionadas con la oficina. A veces estarás retrasado en el horario y la fecha límite. O en otras ocasiones, habrá tantos cambios frecuentes en el producto que está documentando que tendrá ganas de abandonar el lugar y retirarse a un tranquilo pueblo de pescadores en el medio del Pacífico y no volver a tocar el teclado. Pero todos se sienten así de vez en cuando. No eres solo tú. Si tienes la paciencia y la fe para atravesar esa ola difícil, volverá a salir el sol al otro lado de la montaña oscura. Debes tener la fuerza interior para guiarte a través de esos episodios difíciles para ser un buen escritor tecnológico.

4)

Escritura simple. La escritura técnica tiene que ver con la escritura simple sin adornos. Debe saber cómo escribir sin el tipo de lenguaje introspectivo y emocional que es bienvenido en la “escritura creativa”. No está tratando de generar emociones en sus documentos. Por lo tanto, trate de mantener las metáforas, adjetivos y adverbios al mínimo. Evite los verbos compuestos y las expresiones locales coloquiales, ya que su escritura puede traducirse a diferentes idiomas y algunas expresiones locales no se traducen bien. Intenta escribir en oraciones cortas y en voz activa. Use verbos cortos de acción regular como “Obtener”, “Seleccionar”, “Hacer clic”, etc. Haga un esquema en su cabeza del mensaje principal que está tratando de transmitir. Luego escriba en pasos secuenciales, cada paso siguiendo al anterior de manera lógica. Tome un curso o lea un libro por escrito.

5)

ANONIMATO. Los escritores técnicos no obtienen bylines y no construyen una reputación como lo hacen otros escritores. Por lo general, nadie es consciente de que alguna vez existen. Trabajan de forma anónima detrás de las líneas para crear los documentos que enseñan al mundo cómo operar las cosas correctamente. Si tienes ganas de hacerte un nombre y brillar como escritor famoso, entonces la redacción técnica definitivamente no es para ti y debes reconsiderar tu elección de carrera. Debe sentirse cómodo con su anonimato para ser un escritor técnico feliz.

6)

HABILIDADES SOCIALES. Ya sea que trabaje como escritor solitario o en un entorno de oficina, necesita las habilidades sociales para llevarse bien con colegas que generalmente son los mejores y más brillantes ingenieros y gerentes que jamás haya conocido. Las PYME (Expertos en la materia) con las que se enfrentará en su carrera como escritor técnico lo ayudarán si sienten que respeta su tiempo. Los necesita, pero la mayoría de ellos no tendrían mucho tiempo para dedicarle, ya que generalmente están muy ocupados con sus propios proyectos. Por lo tanto, debe hacer su tarea antes de interactuar con ellos y poder mantener una pequeña charla regular en otros momentos. Ayuda estar realmente interesado en sus compañeros de oficina. Esa es una habilidad y un don que es útil en todas las situaciones sociales.

7)

HABILIDADES TÉCNICAS. Como escritor técnico, utilizará muchos sistemas y software diferentes para producir sus manuales de usuario, archivos de ayuda y una docena de otros tipos de documentos interesantes. Realmente tienes que saber cómo usar dicho software. Habrá algunos que tendrá que aprender en el trabajo, pero debe dominar cosas básicas como MS Word y Excel por su cuenta, antes de entrar en su cubículo. Las certificaciones pueden ayudar aunque no sean necesarias, dependiendo de los requisitos de su puesto. Como escritor técnico, siempre es una gran ventaja saber cómo usar productos de Adobe como FrameMaker, RoboHelp, InDesign, Photoshop e Illustrator. Hay otros paquetes más nuevos como el grupo de productos Flare. DITA y la autoría estructurada están dando grandes pasos mientras escribo estas líneas. Entonces, hay un montón de aprendizaje que debes hacer para sobrevivir y construir una buena carrera como redacción técnica. ¡Te deseo buena suerte!

Los escritores técnicos a menudo juzgan sus habilidades en función de su inclusión de hechos en sus manuscritos. Ciertamente, una interpretación objetiva del producto o diseño en la escritura es muy importante, sin embargo, los mejores escritores técnicos con los que he trabajado también son muy expertos en proporcionar los hechos de la manera más agradable para el lector.

Por ejemplo.

Si el objetivo es crear una especificación de diseño para ingenieros de software, el documento debe explicar no solo qué, sino también por qué debe hacer el código. De ese modo, el ingeniero de software puede obtener una comprensión mucho más detallada de lo que el producto final debe hacer por el usuario.

En otras palabras, escriba específicamente para el usuario final de una manera que proporcione más que solo rutas lógicas, pero que pintará una imagen para el lector. Hay una razón para el dicho “Una imagen dice más que mil palabras”.

Para ser un escritor técnico exitoso, necesita,

• Anhelo de información: hablar / leer / navegar / entrevista / …
• Simplifique su escritura: la más valiosa de todas
• Tecnología: disfrute de la vista de pájaro y deje detalles sangrientos a otros 🙂
• Oferta de asistencia – Especificaciones / UI / Marketing / Soporte

Es un trabajo muy gratificante si amas / te das cuenta de lo anterior.

Para convertirte en un buen escritor técnico, no solo debes eliminar algunas habilidades, sino que también debes poseer ciertos rasgos de personalidad . Con la combinación correcta de ambos, la escritura tecnológica sería algo natural para usted. Así que a continuación hay una lista de ambos, rasgos y habilidades de un buen escritor técnico.

1. Siempre que la redacción técnica sea un nicho de escritura, por supuesto, es una gran habilidad para escribir . Un título en Periodismo, Inglés o Comunicaciones te da una ventaja;
2. La buena documentación del software siempre se organiza sistemáticamente. Entonces, para crearlo y / o mantenerlo, un buen escritor técnico debe ser analítico y sistemático ;
3. Una de las demandas a los techdocs es la precisión. Por lo tanto, un redactor técnico debe tener buenas habilidades de investigación y exploración y estar atento a los detalles ;
4. Habilidad en lenguaje sencillo: su escritura debe ser clara y fácil de entender.

Creo que estos son los clave. Si necesita obtener más información, puede que le guste este artículo: 11 habilidades de un buen escritor técnico . También es posible que desee investigar un poco sobre qué esperan los empoderadores de los escritores técnicos y revisar algunos sitios web de trabajo.

¡Buena suerte!

Suficiencia de las ideas (primero la habilidad requerida) en mente y luego la capacidad de CONVERTIR las ideas en una información semántica convincente sin la anomalía desdeñosa del tema / tema (elegido).