Cómo convertirse en escritor técnico

Mi primer consejo es averiguar qué tipo de escritor técnico quieres ser.

Sí, hay más de un tipo.

En términos muy generales, hay personas que escriben:

  1. Documentación del usuario final (archivos de ayuda, manuales de referencia, guías de usuario, etc.). Estos son documentos que simplifican las tareas complejas, por lo que incluso un novato puede usar un producto complicado. Estos escritores son excelentes para desglosar tareas complejas y hacer que parezcan fáciles de hacer.
  2. Documentación técnica (hojas de datos, guías de instalación, manuales de reparación, guía de inspección, guías de programador, especificaciones de ingeniería, etc.). Estos están escritos para una audiencia técnica, como el personal de mantenimiento. Estos tipos también son grandes escritores, pero también son expertos en la materia. Tener las credenciales y calificaciones correctas suele ser un requisito legal si desea publicar documentos.
  3. Marcom, también conocido como documentación técnica de marketing (partes técnicas de propuestas comerciales, hojas de datos / hojas de especificaciones, etc.). Estos son documentos escritos para clientes experimentados que desean conocer los detalles técnicos de un producto. Geeks si quieres. Debido a que la información tiene que ser EXACTA, estos documentos están escritos por personas del equipo de desarrollo y no de marketing. Debido a que el equipo de desarrollo no suele ser muy bueno para vender con sus palabras, la escritura real a menudo la realizan escritores técnicos.

Tus oportunidades, perspectivas de carrera, calificaciones necesarias y el tipo de trabajo que harás están definidos por el tipo de escritor técnico que seas. Es posible cambiar de un tipo a otro, pero hacerlo no siempre es fácil.

Mi segundo consejo sería descubrir la industria de la que quieres formar parte.

La escritura técnica se basa en los estándares y procedimientos de la industria que está contratando.

Un trabajo de redacción técnica para una empresa aeronáutica, por ejemplo, será completamente diferente de un trabajo de redacción técnica para una empresa de software.

Esto se trata tanto de intereses como de credenciales. No querrá pasar todo el día escribiendo sobre cómo configurar servidores si no le interesan, y la compañía no lo contrataría para pasar todo el día escribiendo sobre cómo configurar servidores si no pudiera demostrar cierto grado de conocimiento y entusiasmo por el tema.

Una vez más, las perspectivas de carrera variarán según la industria que elija. Algunos, como el software, son muy grandes. Otros, como la aeronáutica, también son grandes, pero no tienen casi tantos empleadores. El pago también varía según la industria, como puede ver aquí: http://www.bls.gov/ooh/media-and…

Mi tercer consejo sería obtener la experiencia necesaria para el trabajo.

Una vez que haya decidido el tipo de escritor técnico que quiere ser y de qué tipo de industria quiere formar parte, necesitará obtener la experiencia necesaria. Si Quora es una indicación, hay muchas personas a las que les gustaría convertirse en autores técnicos, incluidos periodistas y desarrolladores.

Así que realmente no quieres entrar sin ninguna experiencia.

Debe comenzar a escribir sobre el tipo de cosas sobre las que estará escribiendo. Escriba algunas muestras excelentes y haga que un profesional las revise si puede. Serán realmente útiles cuando se presente a un empleo.

Una gran técnica es ofrecer documentación para la escritura de software o servicios de código abierto. Necesitan grandes escritores para trabajar de forma gratuita, y usted necesita la experiencia para que pueda dejar de escribir de forma gratuita. Ahora sacarán más provecho de usted, pero a la larga obtendrá más de la experiencia. Un ganar-ganar.

También querrá aprender a estructurar sus manuales de ayuda e indexarlos correctamente. Confía en mí cuando digo que el software especializado de autoría de ayuda hace una gran diferencia cuando escribes documentación técnica. Hará más en menos tiempo y cometerá menos errores en el proceso. Mi consejo es comenzar a aprender una herramienta de autoría de ayuda popular como HelpNDoc (que es de uso gratuito para uso personal y fines de evaluación).

Mi cuarto consejo es el que has escuchado antes.

Ya sea que esté buscando un trabajo a tiempo completo, con la esperanza de trabajar por cuenta propia, haciendo esto como un trabajo paralelo o buscando lanzar su propio negocio, la búsqueda de trabajo siempre será parte del proceso. Sigue las mejores prácticas. Estoy seguro de que la buena gente de Quora puede ayudar.

Espero que ayude.


Descargo de responsabilidad: trabajo en el equipo de HelpNDoc.

Ve a escribir, técnicamente

Encuentre algo técnico o complejo, algo que la mayoría de las personas tiene dificultades para resolver. Tal vez cómo usar una función en Microsoft Word. Luego describa, paso a paso, cómo ejecutar el procedimiento. Tome capturas de pantalla en el camino. Publíquelo en un blog o en Quora, o en cualquier lugar donde la gente necesite ayuda para resolver cosas.

Acabas de escribir un procedimiento, eso es redacción técnica.

Parece simple, pero si fuera así, no habría todas estas personas trolleando a Quora en busca de respuestas sobre cómo hacer las cosas.

Conocí a escritores de tecnología sin un título, y algunos de ellos estaban especializados en una industria específica, pero principalmente eran personas que naturalmente organizan la información lógicamente y saben cómo explicar las cosas de la manera en que las personas entienden.

Sin embargo, siempre es útil tener un entrenamiento formal para convertirse en un escritor técnico profesional, ya sea como escritor técnico o en un campo altamente técnico de algún tipo. Pero nada mejor que solo hacerlo. Mi último gerente consiguió su trabajo al ganar esencialmente un concurso en respuesta a un desafío de redacción técnica de un desarrollador de software de código abierto. Simplemente lo hizo y le pagaron. Luego dijeron, “oye, ¿estás haciendo algo? ¿Quieres un trabajo?” Porque ya habían visto que él podía hacer el trabajo.

Solo hazlo, publícalo, compártelo y pide comentarios. Y lea todo al respecto, en todas partes.

Hay muchas maneras de convertirse en un escritor técnico y he escrito bastante sobre este tema en el pasado ya que quería ayudar a los escritores principiantes que querían ingresar a este nicho de escritura sólido.

Una forma normal de hacerlo es obtener un título o certificado de redacción técnica de una universidad de cuatro años y luego solicitar un trabajo de techcomm. Para obtener una lista completa de los programas de certificados y diplomas en los Estados Unidos, consulte Programas de certificados en Escritura técnica y comunicación técnica | Centro de comunicación técnica

Sin embargo, un título de comunicación técnica no es imprescindible para encontrar un trabajo como escritor técnico. Si puede escribir pasos de procedimiento en inglés sencillo , en teoría puede convertirse en un escritor técnico. Sin embargo, también debe amar la tecnología y dar la bienvenida a la oportunidad de aprender y crecer. La escritura técnica ama a los aprendices rápidos con apetito por la tecnología.

También puede deslizarse lateralmente hacia la escritura tecnológica (vea el enlace a continuación) comenzando como ingeniero, maestro, periodista o en algún otro puesto y luego como voluntario gradualmente para tareas de documentación hasta que se encuentre en un puesto de escritura a tiempo completo.

Es importante desarrollar una cartera para presentar a los reclutadores y expandir su presencia en las redes sociales en Internet. Conéctese en cada oportunidad y no sea tímido para que la gente sepa que está buscando un puesto de redacción técnica.

Si desea ver una lista de puestos de redacción técnica anunciados en Craigslist por ciudades seleccionadas en los EE. UU. Y la India, no dude en visitar JOBS | Centro de comunicación técnica

Para algunos de mis artículos publicados sobre este tema, lo invitamos a visitar para encontrar trabajo | Centro de comunicación técnica

Espero que esto ayude. ¡Buena suerte!

El título de escritor técnico tiene diferentes retiros dependiendo del tipo de documentos que se escriben. ¿Se le pide que escriba las instrucciones de ensamblaje de un producto de bricolaje (estantería, juguete, etc.) o se le pide que describa cómo funciona un motor a reacción? En muchas compañías, un escritor técnico puede escribir procedimientos de producción o pruebas de ingeniería. He escrito todo, desde una etiqueta de producto médico (especificaciones de espacio muy críticas) hasta una propuesta de subvención de NIH $ 12.5 M (la ganamos) al boletín de la compañía. Como EE que se convirtió en escritor ocho años antes de retirarse porque el trabajo estaba allí, he escrito cientos de artículos publicados sobre temas que van desde microscopios USB hasta calculadoras HP.

El consejo principal que puedo dar es escribir tanto como sea posible. Pronto descubrirá si tiene una habilidad natural o, como yo, simplemente disfruta de la escritura, y trabaja duro en ello. Escribo dos artículos cada semana de forma recreativa. He escrito un artículo de siete páginas sobre el tema titulado “¿Qué es la escritura técnica?”, Que estoy feliz de compartir. De ese artículo:

Divido ampliamente la comunicación escrita en técnica o no técnica. La Tabla 1 muestra estos dos grupos con algunos de los atributos opuestos de cada uno.

El campo de la escritura técnica tiene su propia terminología y enfoques académicos. No sé nada de esto porque lo hice por interés y necesidad (comenzando mi propio boletín). Estoy seguro de que los lectores / escritores formados formalmente tendrán comentarios adicionales.

X <> Y,

Ricardo

Si escribe (considerando que hizo esta pregunta, debería ser seguro asumir que sí), si está listo para enfrentar críticas (y múltiples ediciones sobre lo que escribe), si ama la tecnología (o su participación en la solución de los problemas de las personas) , y si sabe qué peso y posible impacto tiene cada palabra y signo de puntuación, ya debería estar en camino de convertirse en un escritor técnico.

Consígase en línea. Leer libros. Haga algunas muestras disponibles. Mejora tu currículum. Mejore su dominio sobre la comunicación verbal y (especialmente) escrita. Busque documentos de preguntas sobre redacción técnica y resuélvalos. Opcionalmente, obtenga algunas certificaciones en redacción técnica. Entonces, creo, sería bueno ir. Todo lo mejor, Joyal.

La redacción técnica es un proceso mediante el cual se presenta información técnica a través de documentos escritos que son ‘fáciles de usar’. El alcance de la documentación técnica es amplio e incluye todo, desde correos electrónicos comerciales hasta informes comerciales, a través de la ayuda de una guía del usuario. La mayoría de las personas leen los manuales documentados solo cuando otras fuentes de ayuda no funcionan. Esta puede ser la razón por la que parte de la documentación está mal preparada.

Las compañías de software opinan que su software es fácil de usar y no requiere ninguna documentación manual. Sin embargo, la creación de documentación técnica es menos costosa en comparación con el soporte técnico.

Al comenzar, es bueno saber que la preparación de un documento técnico efectivo no es un trabajo fácil, requiere planificación con una ejecución adecuada. Para obtener más información sobre la escritura técnica, visite Cómo ser eficaz en la redacción técnica.

Los escritores técnicos crean documentos de procedimientos o “procedimientos”, con mayor frecuencia para un usuario que accederá a los documentos en un manual o en una base de datos en línea. La buena noticia es que la demanda de escritores técnicos está en aumento. Cada vez que se desarrolla una aplicación de software o un producto, se necesita documentación complementaria al instante. Existe una tremenda demanda de escritores técnicos para crear documentos que muestren a los usuarios cómo utilizar programas de software. Las industrias incluyen: compañías de alta tecnología, servicios bancarios y financieros, negocios médicos y farmacéuticos, centros de llamadas y muchos otros. Un escritor técnico bien entrenado no se quedará sin oportunidades de trabajo.

Puede convertirse en un escritor técnico si escribe bien y se familiariza con las guías de estilo que puede encontrar en la biblioteca o en Internet. Inicialmente, querrá familiarizarse con Microsoft Word como herramienta de escritura. Puede buscar otras herramientas en Internet, pero no se deje llevar por ellas a expensas de aprender metodología básica para crear documentación técnica que no cambie. Las herramientas de escritura siempre cambian y se pueden aprender según sea necesario.

La metodología para crear documentación técnica implica cinco partes básicas. Tome un curso y / o lea artículos / libros para aprender a hacer lo que se requiere en cada una de las cinco partes. Es fácil memorizar la metodología básica de cinco partes y siempre tenerla en cuenta al entrevistar para un puesto de Escritura Técnica. Vea cinco pasos para escribir una buena documentación técnica en http://jamesgraves.com

Muchas veces el subtexto de esta pregunta es ¿Cómo puedo obtener experiencia como escritor técnico para poder conseguir un trabajo? –Una pregunta que a menudo me hacen cuando hablo con estudiantes de redacción técnica.

Mi respuesta es similar a la de otros aquí: obtenga experiencia de cualquier manera que pueda. Hay muchos proyectos de código abierto que pueden usar la ayuda de un escritor. Únase a uno y comience a proporcionar contenido al proyecto. Sí, este es un trabajo ‘gratuito’, pero le brindará una valiosa experiencia trabajando con un equipo de desarrollo de software y aprendiendo a crear contenido útil.

Además, si está en la universidad, le recomiendo usar su centro de carreras universitarias para buscar pasantías para escritores técnicos. Conozco a muchas personas que comenzaron como pasante que luego fueron contratadas para trabajar en la empresa con la que hicieron la pasantía.

No es un mercado fácil en estos días, por lo que necesitará alguna evidencia de que sabe escribir, y trabajar con un proyecto de código abierto es una excelente manera de obtener esa experiencia.

La escritura técnica es fundamentalmente sobre la comunicación de información técnica. Básicamente, debes ser (o aprender a ser) un muy buen comunicador (una habilidad profunda y difícil) y estar dispuesto y ser capaz de aprender muchas materias técnicas diferentes.

Me convertí en un escritor técnico en la década de 1980 simplemente declarando que eso es lo que soy. Luego salí y encontré un par de compañías que me contrataron por contrato para escribir su documentación que me permitió encontrar una serie de trabajos TW permanentes. Entonces, algo de suerte, algunas ilusiones, y como poco comportamiento agresivo es lo que necesitaba. También tenía algunas habilidades de programación y un dominio bastante bueno del inglés, lo que me ayudó mucho.

Creo que esto todavía funcionará hoy, pero probablemente necesitará habilidades de software más sofisticadas que las que tenía cuando comencé. Por ejemplo, muchas compañías (especialmente las grandes) se están mudando a DITA para administrar sus necesidades de documentación. DITA es una aplicación XML y sería muy útil saber qué es XML para trabajar con DITA de manera más efectiva.

Así es como puede convertirse en un escritor técnico:

  1. Comuníquese con su red y encuentre a alguien que esté trabajando en este momento como escritor técnico.
  2. Entrevístelos para descubrir:
  1. ¿Qué hacen a diario?
  2. ¿Qué herramientas usan?
  3. ¿Qué tipo de habilidades pueden identificar como esenciales para un escritor técnico?
  • Evalúe su propio conjunto de habilidades y conocimientos de herramientas.
  • Identifique las brechas entre su conocimiento y la información que obtuvo del escritor técnico profesional.
  • Intenta repetir este ejercicio con un par de escritores técnicos.
  • Una vez que tenga una buena idea de lo que hacen los escritores técnicos en el entorno de trabajo, vaya adquiriendo esas habilidades y conocimientos. Paralelamente, comience a solicitar trabajos de redactor técnico de nivel básico a través de su red, sitios de trabajo, etc.

    Una vez que encuentre un trabajo, comenzará su viaje como escritor técnico.

    La habilidad más importante que debe tener un escritor técnico es la capacidad de comprender conceptos (complejos o no) y poder escribirlos para que otra persona pueda leerlos y comprender bien el tema.

    Muchos hermanos ya agregaron algunos comentarios útiles, pero le sugiero que lea la Guía de ingenieros para redacción técnica de Kenneth Budinski.

    En muchas universidades de ingeniería, este libro se enseña como libro de curso.

    Comience donde está. Mira la documentación a tu alrededor. ¿Qué no funciona? Si se debe explicar un documento antes de usarlo, o si las instrucciones no son claras, comience allí.

    Si un documento no mueve al usuario a la acción, revíselo. Si el documento desconcierta al usuario …

    ¿El documento necesita advertencias?

    ¿Necesita imágenes para calzar al usuario donde está algo?

    ¿Es demasiado vergonzoso cuando una imagen servirá?

    Comienzas entrenando para ser escritor y también experto en la materia. Esa es la parte fácil.

    La parte difícil es hacer contactos, porque la verdad “No es lo que sabes, es a quién conoces” es más inocentemente cierto de lo que imaginas.

    Red, blog, LinkedIn usado, busque grupos profesionales de temas, etc. Encuentre personas que estén familiarizadas con sus campos.

    ¡Buena suerte!

    ¡Un escritor técnico debe desarrollar muchas habilidades!

    ¡Lea sobre los pasos del árbol para la carrera de escritor técnico!

    Como hemos estado viendo esta pregunta por todas partes, creamos un libro electrónico de la Guía de carrera para escritores técnicos, ¡puede que le resulte útil! ¡Buena suerte con tu carrera de escritor técnico!

    Escribí un artículo sobre esto: Cómo convertirse en un escritor técnico por Bradley Nice en mi curva de aprendizaje

    Espero que lo encuentres útil 🙂