¿Es aburrida la escritura técnica?

¿Qué hace que un trabajo sea aburrido? ¿Haciendo lo mismo una y otra vez? CADA trabajo requiere, hasta cierto punto, que hagas lo mismo una y otra vez. ¿Trabajando con gente aburrida? CADA trabajo tiene gente aburrida. ¿Haciendo un trabajo que no quieres hacer? CADA trabajo tendrá algunos aspectos que no te gustarán.

Así es la vida. Algunos días son divertidos y otros aburridos .

Me metí en la redacción técnica porque para mí, había más días divertidos en redacción técnica que en contabilidad. Mis colegas sintieron lo mismo. Mi contador se sintió diferente. Lo mismo hizo mi abogado. Me encantaba tanto la escritura técnica que intenté mejorar la escritura técnica en sí misma al fundar HelpNDoc, una herramienta de autoría de ayuda que facilita la escritura técnica, hace 13 años.

En 13 años, he tenido algunos días aburridos. Pero he tenido más emocionantes. Así que me quedo con eso.

La escritura técnica no es para la mayoría de las personas. La mayoría de la gente quiere ser algo que se vea emocionante. Como un actor Esto se debe a que ven a los actores como personas que asisten a fiestas que tienen vidas de interés periodístico y les pagan mucho dinero solo por escribir cosas en las redes sociales.

No para humillar a los actores, pero sus vidas son difíciles. Y bastante aburrido. Puedo tolerar 13 horas de mirar palabras, pero no 13 horas frente a un espejo para que la gente me maquille. Pero eso soy solo yo. Puedo manejar a mis compañeros diciéndome “esta guía no explica las cosas correctamente para personas menores de 25 años”. ¿Puedo manejar a personas que nunca han actuado un día en su vida diciéndome que arruiné su infancia al decir cosas que mi personaje no debería haber dicho? Probablemente no.

Entonces, la pregunta es ¿qué te parece emocionante? Le recomiendo que lea mi respuesta a la pregunta “¿Qué hace que alguien sea un buen escritor técnico?”, Que incluía notas sobre lo que se supone que deben hacer los escritores técnicos. ¿Suena esto como algo que puedes hacer todos los días por el resto de tu vida? Si respondió que sí, entonces la redacción técnica es para usted .

Si esto suena aburrido, entonces supongo que la escritura técnica le resultará aburrida porque así es como es. Algunos días y diversión y algunos días son aburridos.

TL; DR : ¡La redacción técnica es increíble!

Sí, se supone que la escritura técnica es aburrida

Estamos aburridos cuando hay CERO VARIANZA . Y una buena redacción técnica debe tener una variación cero en su descripción de los pasos prácticos y otros componentes.

Por ejemplo, si llamamos a un procedimiento “subrutina” en la página 2, tenemos que llamar al mismo objeto “subrutina” y no “subproceso de programa” en la página 34, de lo contrario el usuario puede / se confundirá y terminará haciendo lo incorrecto .

Imagine que su avión es llevado por un piloto que está entrenado con un Manual de entrenamiento muy “emocionante” e “hilarante” que describe el aumento de la velocidad del avión como “pisar el acelerador” en una página, “dejarlo ir” en otra, y “tirar de la palanca de combustible a la posición X4” en otra. ¿Confiarías en ese piloto? Yo no lo haría

El objetivo de la escritura técnica NO es el entretenimiento. Su objetivo es ENSEÑAR cómo RESOLVER UN PROBLEMA CONSISTENTEMENTE CADA VEZ, de la MISMA MANERA, sin ningún error. Y para hacer eso, debe ser CONSISTENTE ROCK HARD, lo que significa que debe tener CERO VARIANZA , que por definición se traduce como ” ABURRIDO “.

LA PARADOJA

Pero se necesita mucho esfuerzo y creatividad para escribir algo tan consistente y confiable.

Así que aquí está la paradoja de la “escritura aburrida” : para escribir un documento técnico aburrido, se necesita mucha disciplina, conocimiento y previsión para asegurarse de que lo que ha escrito no se puede interpretar de otra manera que no sea la intención. Cualquier interpretación errónea … y vidas podrían estar en juego (como, por ejemplo, cuando el piloto acciona el interruptor incorrecto porque se llamaron diferentes nombres “entretenidos” en diferentes partes del manual solo porque el escritor intentó ser no aburrido y “creativo”) .

ANÉCDOTA

Esto me recordó una anécdota atribuida a diferentes escritores.

Esta escritora anecdótica se sienta y escribe una carta muy larga a su amiga. Al final de la carta, agrega esta nota de posdata: “Lo siento, hoy no tuve tiempo para escribirle una carta breve”.

Los buenos escritores técnicos experimentados siempre encuentran tiempo para escribir documentos aburridos.

Tu pregunta es:

¿Es aburrida la escritura técnica?

¿Está preguntando si es aburrido escribir un documento técnico o si es aburrido leer un documento técnico?

Usted ve, un buen escritor técnico nunca haría una pregunta tan ambigua como la suya; leen lo que escriben para determinar si la escritura es útil y ayuda al lector. Este es uno de los desafíos de la escritura técnica que algunas personas no encuentran aburrido. Todos los demás, probablemente sí.

Leer un documento técnico no pretende ser entretenido. Está destinado a resolver problemas. Si resuelve tus problemas, entonces te hace más feliz; si no, te frustra. Aburrido no es relevante.

Personalmente, creo que ser un escritor técnico “ se pregunta ” y hacer felices a las personas es un desafío divertido y, por lo tanto, no aburrido.

Luego también está la parte en la que ser escritor técnico le permite aprender sobre cosas que la mayoría de la gente nunca escuchará. Eso es todo un mundo de no aburrido.

Una vez escribí manuales para el ensamblaje y operación de un sistema de información de quiosco basado en computadora ubicado en mercados y farmacias. El requisito de nuestro cliente era que el usuario final (un empleado de la tienda) debería poder ensamblar y operar el sistema, trabajando a partir de un conjunto “simple” de instrucciones ilustradas.

Escribir el manual fue tedioso, pero nada aburrido. Lo refinamos hasta el punto de que los extremos de los cables estaban codificados por colores para que coincida con un color en la conexión en la computadora, impresora, monitor, etc. Por lo tanto, el equipo en sí era parte de la documentación.

Es sorprendente cuando debes escribir para alguien que nunca ha ensamblado un sistema. No puede simplemente escribir, “Inserte el disco en la computadora”. Debe dibujar imágenes para mostrar la ubicación de la ranura de la unidad, la orientación correcta del disco y la punta de un dedo empujando el disco.

De hecho, probamos los manuales incorporando temas con cero conocimientos informáticos para armar un sistema. En el momento en que se detuvieron para preguntarse y pensar, preguntamos: “¿Qué pasa?” Y luego actualizamos las instrucciones para resolver el bloqueo del camino. Al final, el manual fue escrito en gran medida por personas que no tenían idea de lo que estaban haciendo. Exactamente como debería ser.

Todo eso, muy interesante y, como dije, muy tedioso .

La escritura técnica comienza dentro de ti. Si bien los cursos pueden ayudar, las habilidades de escritura son cosas básicas muy importantes.

En Northx Consulting, recientemente hemos abierto 15 puestos para escritores técnicos que reclutan estudiantes nuevos y con experiencia. Estos escritores trabajarán en investigación tecnológica y análisis de escritura trabajando con personal de PHD y personal de tecnología sénior.

Las personas interesadas con excelentes habilidades de escritura pueden unirse a nosotros. Enviar currículum a [correo electrónico protegido]

El lugar de trabajo será estrictamente India, solo Chennai

Un trabajo se vuelve aburrido si deja de enseñarte cosas nuevas. Del mismo modo, un trabajo de redacción técnica se volverá aburrido si no puedes aprender nada nuevo después de un tiempo.

Si sigues invirtiendo tu tiempo en aprender cosas nuevas sobre la escritura técnica, el trabajo nunca será aburrido. Siempre hay algo nuevo que aprender.

¡No es aburrido si te gusta la escritura técnica!

Hay dos tipos de tareas:

  • Aprender sobre algo nuevo. Esta tarea es desafiante e interesante.
  • Hacer el trabajo repetitivo de formateo, edición, etc. Esto es fácil de hacer mientras piensa en otra cosa, escucha música, etc.

Entonces: no aburrido. A menos que pienses que es así.

Si.
Lo siento, pero es aburrido y todos sabemos cómo va a terminar el manual.
Sin embargo, al igual que las guías telefónicas antiguas (que también eran aburridas), la escritura técnica es extremadamente importante y ayuda a millones de personas en todo el mundo todos los días.

No lo creo, si le interesa escribir puede obtener diferentes temas para expandir, puede obtener un tema único para escribir un documento técnico.