6 problemas técnicos comunes de escritura
(1) Datos escasos.
Se supone que debe documentar cómo funciona algo, pero no hay suficiente información sobre el tema para escribir una guía técnica completa. Se espera que realice su propia investigación, búsqueda de información y verificación de hechos. Es posible que deba perseguir a las PYME y las partes interesadas para entrevistarlas, lo que lleva tiempo y delicadeza. No tener suficiente información para comenzar a escribir o actualizar un documento existente es un problema común en la escritura tecnológica.
(2) Reseñas interminables.
A veces, revisar un documento técnico lleva más tiempo que escribirlo. O los revisores no están disponibles o tardan demasiado en responder. A veces, la revisión entra en una “espiral de la muerte” cuando el revisor nunca está satisfecho y se le pide que haga tres, cuatro, cinco borradores y no tiene idea de cuándo se realizará la tarea. Este es otro problema común en la escritura técnica.
(3) Misión arrastrada.
Empiezas a escribir para el producto A, pero pronto te dicen que A es ahora B. Poco después de hacer una corrección de ruta y comenzar a documentar el producto B, llega la noticia: B ahora se lanzará como C. Así que vuelves a tablero de dibujo, vuelva a tomar todas las capturas de pantalla, cambie todos los títulos de los capítulos, vuelva a hacer su TOC e índice, cambie los pies de página, etc. y comience a reconstruir su edificio. Eso también sucede de vez en cuando en la escritura tecnológica.
(4) Sin bylines, sin gloria.
Por lo general, nadie sabe que eres un escritor de tecnología, ya que nunca obtienes ningún byline. En mi experiencia, es muy raro que una escritora de tecnología publique algo debajo de ella. Seguro que ganas mucho dinero, especialmente en comparación con los pobres poetas, periodistas y guionistas. Pero al final de una larga carrera, nadie sabrá lo duro que luchaste para contener el caos y mantener el orden en el universo de la información. Si ese tipo de anonimato te molesta, probablemente deberías elegir otra línea o trabajo.
(5) Granularidad óptima.
¿Qué tan “granular” debería ser tu escritura tecnológica? ¿Cuántos detalles debes incluir en tu escritura? ¿Cuánto es suficiente para tu audiencia? ¿Debería describir cada botón y enlace en la GUI? ¿O debería simplemente escribir una guía de solución de problemas al más alto nivel y no insultar la inteligencia de su audiencia recordándoles que hagan clic en el botón Aceptar en cada pantalla una vez que hayan terminado? La granularidad es un problema común que se resuelve cuanto mejor conozca a su público objetivo.
(6) Localización.
Con cada día que pasa, los documentos tecnológicos son compartidos y consumidos en diferentes partes del mundo por audiencias provenientes de un entorno cultural completamente diferente. Es por eso que los documentos técnicos se traducen regularmente y se adaptan a otras culturas. Están “localizados”. Eso requiere un tipo especial de escritura que evite los clichés locales y favorezca un “inglés internacional” desinfectado (en el caso del inglés). Además, en realidad requiere menos escritura y más imágenes e ilustraciones. Algunos observadores incluso afirman que el futuro de la documentación técnica está más en la ilustración técnica y menos en la redacción técnica. Por lo tanto, cuantas más habilidades gráficas y de visualización tenga, más podrá evitar tales desafíos de localización.
Para obtener más información sobre los diversos aspectos de la redacción y edición técnica, puede consultar mi curso de redacción y redacción técnica en línea https://www.udemy.com/technical- …