Free Press

Continuando donde lo dejamos en la primera parte de la serie de herramientas de escritura técnica. (Si no la has leído, échale un vistazo)
En esta entrega, nos ocupamos de las herramientas de escritura técnica utilizadas en la fase de «Documentación de la información».
Esta es la fase de escritura, edición, dibujo, revisión y reescritura. Es la fase en la que el equipo de documentación de la información está a pleno rendimiento produciendo guías, manuales, blogs, demostraciones en vídeo, páginas de ayuda en línea, etc. Dada la variedad de tareas en esta fase, las herramientas de escritura técnica empleadas son también muy diversas e innumerables.

Las 17 mejores herramientas de software de escritura técnica para la documentación en 2020

• • Whatfix
  • MediaWiki
  • Adobe Robohelp

• Notepad++
• WordPress
• Adobe Photoshop
• Adobe Illustrator
• Microsoft Visio
• Windows Snipping Tool
• Windows Movie Maker
• Powtoon
• Prezi
• Microsoft Word
• Kingsoft WPS Office
• Google Docs
• Adobe Framemaker
• oXygen XML Author

1. Whatfix

Whatfix supone un cambio de paradigma en la forma de presentar la documentación de ayuda en línea. Las páginas de ayuda web estáticas y largas no captan la atención del usuario con la misma eficacia que las guías interactivas e ilustradas que presenta Whatfix, popularmente llamadas «globos».
Además, la ayuda en línea en el mundo actual necesita extenderse a través de varios gadgets, ya sean PCs, tabletas o smartphones. Whatfix adapta automáticamente el contenido de la ayuda a cada dispositivo. Y el mismo contenido de ayuda se puede acceder en diferentes formas – como una presentación de diapositivas, PDF, o un vídeo.
Consejo del autor: ¡Whatfix soporta una característica única – Paseo interactivo en tiempo real – en el que pones tus fragmentos de ayuda directamente en la página del producto en vivo! El usuario lee el fragmento en el globo de Whatfix y realiza la acción correspondiente en la página. Esta es una herramienta de escritura técnica popular entre las empresas que buscan un cambio de las metodologías tradicionales.

MediaWiki

Mostrar la ayuda en línea de su producto como páginas wiki es una idea simple y eficaz. Sus páginas pueden integrarse directamente en Wikipedia si no tiene un sitio web independiente para su producto en línea. Alternativamente, puedes alojar páginas de ayuda tipo Wiki en el sitio web de tu producto. La gran familiaridad de este formato entre los usuarios online es una ventaja clave, y la herramienta gratuita de edición de wikis MediaWiki Visual Editor hace que la creación de la ayuda sea bastante sencilla.
MediaWiki es una herramienta de edición web basada en PHP, que utiliza Wikipedia. Sin embargo, incluso las grandes corporaciones de software, siendo Intel un ejemplo clave, utilizan esta herramienta para presentar su información de ventas y marketing, How To’s, y páginas de ayuda sobre políticas y procedimientos.
Consejo del autor: Esta herramienta de escritura técnica viene con un buen soporte para las extensiones – para el contenido multilingüe, la revisión colaborativa, el seguimiento de las ediciones, la búsqueda incorporada, etc.

Adobe RoboHelp

Herramienta de autoría estándar del sector utilizada para crear sistemas de ayuda para aplicaciones de escritorio o basadas en la web. ¡Ningún usuario de ordenador es ajeno a RoboHelp! Cada vez que pulsa F1 en cualquiera de sus aplicaciones de software estándar, la ventana de ayuda que aparece casi siempre se crea con RoboHelp. Sin embargo, también puede utilizarse para elaborar la documentación técnica convencional para imprimir, como guías y manuales.
El sofisticado IDE de RoboHelp permite a los escritores técnicos desarrollar proyectos de ayuda a gran escala y representarlos en múltiples dispositivos de hardware/sistemas operativos, y en múltiples formatos (PDF, HTML, DOC, etc.). La versión más antigua de RoboHelp puede adquirirse como edición de bajo coste si el presupuesto es una limitación. Sin embargo, las pequeñas empresas pueden optar por alternativas sencillas y gratuitas, como los blogs de WordPress o los Wikis. El viejo MS Word también puede generar archivos de ayuda HTML básicos para usted.
Consejo del autor: La gestión de grandes productos de software con versiones de actualización periódicas puede ser un gran desafío para los escritores técnicos, ya que tienen que estar sincronizados con el historial de cambios del producto. Los archivos de ayuda suelen mostrar variables configurables definidas por el usuario que se repiten varias veces a lo largo de la documentación de ayuda. (Por ejemplo, una variable como «Tiempo de reposo después de la inactividad» está configurada a 30 segundos en la versión anterior, para ser configurada a 1 minuto en la actualización). El proyecto RoboHelp se encargaría de actualizar el valor de la variable a lo largo de los archivos de ayuda!

Notepad++

Un editor HTML para principiantes muy eficaz. La mayoría de la gente aprende los fundamentos de la programación HTML en esta herramienta de escritura técnica. Si su producto de software no requiere una documentación de ayuda en línea muy pesada, para hacer archivos de ayuda de tamaño medio, esta herramienta es más que suficiente.
Su interfaz gráfica de usuario personalizable permite una edición fácil, soporta WYSIWYG para la impresión y también tiene opciones de soporte multilingüe.
Consejo del autor: Notepad++ viene con un rico conjunto de plug-ins. Multi-clipboard, Code Compare, Auto-Save son algunos de los más populares. Los escritores técnicos deben elegir el conjunto adecuado de plug-ins, que pueden transformar un editor ordinario para principiantes en una opción viable para la edición de ayuda en línea.

WordPress

El lugar GoTo si desea tener documentación técnica para su producto en forma de blogs. WordPress es una plataforma de gestión de contenidos online gratuita y de código abierto. Se puede acceder a los blogs escritos en WordPress directamente desde la URL del blog de WordPress o se pueden integrar en el sitio web de la empresa.
Este artículo está alojado en el blog de WordPress llamado Whatfix Academy. Si el objetivo es publicar contenido en línea sobre su empresa/tecnologías asociadas con regularidad, entonces configure una cuenta de blog de WordPress. Los blogs también pueden captar las respuestas de los usuarios en forma de comentarios y «me gusta», lo que hace más fácil relacionarse con su público objetivo y percibir su aprecio por su producto.
Consejo del autor: Los blogs de forma aislada pueden no reunir suficientes globos oculares. Por lo tanto, escriba su blog primero, promueva su blog en las plataformas de medios sociales después y finalmente mida la audiencia/respuestas antes de continuar con el siguiente conjunto de blogs.
También puede leer: Cómo la escritura técnica está cambiando con los tiempos

Adobe Photoshop

Una herramienta por la que la mayoría de los escritores técnicos de la industria juran. Es la herramienta de edición de imágenes más popular del mundo para crear y editar fotos e ilustraciones basadas en rasterización (píxeles). Se puede utilizar para crear diseños de interfaz de usuario, páginas web, anuncios de banner, gráficos de vídeo, edición de imágenes para la impresión. Manipular una imagen, superponer una imagen sobre otra, refinar una fotografía para eliminar imperfecciones y corregir problemas de iluminación son sus usos más populares. El proceso de edición de imágenes es reversible e incremental, por lo que los cambios pueden revertirse fácilmente.
Consejo del autor: Para los diseñadores profesionales, que necesitan constantemente una herramienta de edición de imágenes, casi no hay sustituto para Adobe Photoshop. Sin embargo, si usted es un usuario ocasional, pruebe GIMP, que es de código abierto. Sólo admite esquemas de color RGB, mientras que Photoshop también admite el modo de color CMYK (CYAN YELLOW MAGENTA BLACK). Y la curva de aprendizaje es mayor para GIMP, pero es gratis mientras que Photoshop cuesta una bomba!

Adobe Illustrator

Herramienta para crear y editar ilustraciones basadas en vectores como logotipos y marcas u otros elementos de diseño. Los diseñadores gráficos suelen cometer el error de diseñar los logotipos de sus productos en Photoshop. Pero el mismo logotipo tiene que ser impreso en tarjetas de visita, así como en carteles publicitarios masivos. Por tanto, la clave es escalar la imagen sin perder la claridad, algo que consiguen las herramientas de creación de imágenes basadas en gráficos vectoriales. Adobe Illustrator y Corel Draw son las principales herramientas de escritura técnica en este espacio.
Consejo del autor: Esta herramienta forma parte de la solución Adobe Creative Cloud con costosos alquileres mensuales. Las herramientas de escritura técnica alternativas y gratuitas como Inkscape o Affinity Designer pueden hacer el trabajo igualmente bien con los formatos SVG. A menos que necesite todas las herramientas principales de escritura técnica que forman parte de esta solución (Photoshop, InDesign, etc), esta herramienta no es imprescindible.

Microsoft Visio

Una popular herramienta de diagramación utilizada en el diseño de aplicaciones de ingeniería. Los redactores técnicos a menudo necesitan diseñar diagramas de flujo, diagramas arquitectónicos, diagramas de circuitos eléctricos, diseño de productos de software, etc. Visio es una ayuda conveniente para esto.
Es una herramienta de escritura técnica que cumple con el IEEE y que se ajusta a los estándares de la industria del software como UML (Unified Modeling Language) y BPMN (Business Process Model and Notation).
Consejo de los autores: Visio no ha formado parte de la suite tradicional de Microsoft Office, siempre se ha vendido por separado de forma similar a MS Project. Pero un anuncio muy reciente de Microsoft dice que los suscriptores en línea de Office 365 ahora pueden acceder a Visio también.

Windows Snipping Tool

Si usted está buscando opciones de captura de pantalla que son más sofisticados que PrntScr en su teclado, Snipping Tool es una buena opción. Aparte de la captura de pantalla completa, también puede capturar recortes a mano alzada, o recortes parciales del área de la pantalla. Para capturar imágenes fijas de los vídeos, utilice la opción de retardo para poder guardar el fotograma exacto como imagen.
Consejo de los autores: forma parte de la suite de software de Windows, pero es posible que no esté activada por defecto en algunas ediciones de Windows.

Windows Movie Maker

Una sencilla herramienta de edición de vídeo que los redactores técnicos pueden utilizar para hacer sus vídeos de demostración de productos. Forma parte de la suite Windows Essentials. Sin embargo, desde enero de 2017, este software ha sido descontinuado, sin el anuncio de un reemplazo adecuado. Así que, todos aquellos usuarios con versiones antiguas de Windows, ¡agradeced a vuestras estrellas de la suerte!
Consejo de los autores: Los vídeos y los recortes de audio pueden organizarse y editarse en una vista de guión gráfico, cuadro a cuadro. También es posible extender una serie de imágenes fijas en una línea de tiempo. Las voces en off mezcladas con sonidos de fondo pueden dar a sus vídeos un toque sofisticado.

Powtoon

La escritura técnica es cada vez más visual. Los vídeos animados son una forma excelente de captar la atención del usuario y transmitir el mensaje de forma atractiva. Powtoon es una buena herramienta de animación basada en la web, que se vende como producto SaaS. Con esta herramienta se pueden crear presentaciones animadas y vídeos explicativos de forma gratuita. Sin embargo, los vídeos creados con la versión gratuita llevarán una marca de agua «Powtoon».
Consejo para los autores: Si la redacción técnica no tiene fines oficiales, está perfectamente bien utilizar la versión gratuita de esta herramienta. Sin embargo, un alquiler nominal, usted podría obtener la versión premium que le permite crear vídeos sin la marca de agua y varias otras características.

Prezi

Una toma poco convencional en la fabricación de demos en forma de una presentación de vídeo. A diferencia de Powerpoint, donde el contenido se divide rígidamente en diapositivas, Prezi te ofrece un enorme lienzo en blanco. Puedes escribir y dibujar en él a tu antojo. Acercando o alejando el contenido enfocado y cambiando el enfoque de un cuadro a otro en el mismo lienzo – es como se hace una presentación de vídeo continua.
Consejo de los autores: Además de la versión gratuita, existe una versión de prueba para estudiantes que también es gratuita y que tiene casi todas las funciones de la versión de pago. Elija esa.
Lea también – 14 conceptos erróneos de la escritura técnica que debe conocer.

Microsoft Word

Se siente bastante tonto al escribir sobre el omnipresente MS Word. Pero por muy habitual que sea en nuestra vida digital diaria, sigue siendo el mejor amigo de un redactor técnico. Con una fácil conversión entre los formatos PDF y DOC, la simple combinación de Word y Adobe Acrobat Reader no debe tomarse a la ligera. Este artículo puede tratar sobre todas las herramientas de escritura técnica más sofisticadas del mundo, pero se está escribiendo con el humilde MS Word: Experimente con las diversas plantillas de documentos que ofrece Word. Ayudan a hacer que su documento se vea apropiado para el propósito previsto – como folletos de marketing, libros blancos técnicos, guías de solución de problemas, y así sucesivamente.

Kingsoft WPS Office

MS Word, PowerPoint y Excel son conocidos por ser las herramientas de software de escritura técnica más utilizados, millas por delante de las alternativas disponibles. Sólo la revolución de Android ha frenado un poco al mamotreto de MS Office. Y ha dado un puesto de relevancia a Kingsoft Office, una alternativa razonable y gratuita a MS Office.
Consejo de los autores: Hay algunas características matizadas que WPS Writer no soporta – Tesauro es uno de ellos. El tesauro es una característica importante para los escritores técnicos, ya que estamos constantemente buscando mejores palabras para expresar los mismos puntos en diferentes documentos técnicos.

Google Docs

En un mundo que está recurriendo cada vez más a un práctico teléfono móvil para leer los documentos, en lugar de tomarse la molestia de encender el ordenador, Google Docs está ganando poco a poco importancia. La creación de documentos desde cero no sería conveniente en Google Docs, pero la revisión y la edición colaborativas pueden realizarse de manera eficiente a través de esta alternativa basada en la nube a MS Office.
Consejo del autor: Su perfecta integración con Gmail y Google Drive lo hace aún más atractivo. Como redactor técnico, te quedarías con las sofisticadas herramientas de procesamiento de textos. Pero su jefe de producto, que puede estar en movimiento todo el tiempo, seguro que se pone al día con sus revisiones en su teléfono, con toda probabilidad.

Adobe Framemaker

Un sofisticado procesador de documentos para documentos grandes y de tipo industrial. Se puede utilizar para generar documentos estructurados con un marco XML, con un 100% de conformidad con DITA. También puede utilizarse para documentos no estructurados, como sustituto de editores de documentos como MS Word.
Framemaker es una buena opción para generar documentos estructurados con plantillas predefinidas para cumplir con varios formatos estándar industriales, como acuerdos legales y estados financieros. Soporta la creación de TOC o índices en múltiples documentos, tiene ricas opciones de formato. No pierde rendimiento cuando se insertan gráficos.
Consejo del autor: Framemaker es una buena inversión para las empresas establecidas con equipos formales de redacción técnica que necesitan producir grandes documentos de más de 100 páginas. Sin embargo, las empresas de un solo producto y las nuevas empresas no necesitan hacer esta inversión. Existen herramientas gratuitas de creación de documentos basadas en XML. Y siempre se puede recurrir al viejo MS Word.

oXygen XML Author

Este es un editor XML gratuito y de código abierto compatible con DITA, con varios usuarios fieles y buenas críticas. DITA (Document Information Typing Architecture) es un estándar abierto para la creación y publicación de documentos que poco a poco se ha abierto camino en la gestión de documentos técnicos. Simplemente porque elimina la dependencia de la edición de contenidos de una herramienta concreta. Usted produce documentación en línea compatible con DITA (un conjunto de archivos XML), y luego la edición y el mantenimiento en el futuro sería posible a través de cualquier otra herramienta compatible con DITA.
Dado que las especificaciones de DITA es un área que requiere un enfoque especial, permítanme guardar eso para otro artículo.
Consejo del autor: Basta con decir que la suite de herramientas oXygen es una alternativa viable al enormemente popular pero prohibitivamente caro Adobe Framemaker. oXygen Author se utiliza generalmente en combinación con oXygen Developer.
Así que eso es todo el software de escritura técnica que necesitará en la fase de «Información del documento». La siguiente y última parte será la fase de «Publicación de la información».
Para aprender algunos consejos de escritura técnica y para asegurarse de que no se pierda nuestras actualizaciones de herramientas de escritura técnica, suscríbase a nuestro blog.
¿Le gusta? Marca el artículo o compártelo con tus amigos y colegas.

Nosotros, en Whatfix, estamos innovando el espacio de las herramientas de escritura técnica al alterar la idea misma del contenido escrito continuo. Nuestras guías interactivas te ayudarán a ser más productivo proporcionándote una forma rápida y efectiva de crear Documentación Técnica. Lee más sobre cómo Whatfix ayuda en la escritura técnica en este artículo.