Importancia
de la documentación En el desarrollo de software se requiere
llevar a cabo varias tareas dentro de las cuales se encuentra la documentación
del sistema que comúnmente asociamos con los manuales de ayuda,
ya sea técnica o de usuario.
Es muy importante el desarrollo de los manuales de las aplicaciones
ya que así podremos mantener, actualizar y explicar la forma
en que el usuario interactúa con el sistema; sin embargo, frecuentemente
es la parte a la cual se dedica el menor tiempo y atención.
Existen varios programas que nos ayudan a realizar esta tarea de manera
fácil y sencilla, cumpliendo con los estándares establecidos.
La mayoría de los programas incluyen un editor WYSIWYG (lo
que ves es lo que obtienes), similar a un procesador de textos, lo
cual permite crear de manera visual nuestros archivos de ayuda.
¿Qué
es lo que podemos hacer?
Podemos crear manuales a partir de diversos formatos de archivo
e importarlos a la aplicación y desarrollar la documentación.
Una opción importante de estas herramientas es poder exportar
a varios formatos por ejemplo: PDF, ayuda en HTML, Winhelp (.hlp),
Visual Studio Help, documentos de texto (.rtf), archivos compilados
de Windows (.chm), libros electrónicos multimedia (.exe)
y XML. Los archivos basados en formato HTML incluyen tabla de contenidos,
índice, motor de búsqueda resaltando las palabras
encontradas en las páginas.
Ventajas
Un solo archivo fuente y múltiples formatos de salida: A
partir de un proyecto podemos generar todos los formatos de ayuda
desde archivos en formato de texto hasta generar archivos en formato
XML.
Entorno de trabajo intuitivo: Mediante el editor de la herramienta
podremos capturar información y dar formato al texto (cambio
de fuentes, uso de negrita o cursiva, etc.), corrector ortográfico,
insertar imágenes, clip de video, tablas, añadir enlaces
tanto internos como externos, añadir palabras clave o descriptivas,
diseñar el menú de tópicos, incluir estilos
dinámicos, tablas complejas, y mucho más.
Ahorrar tiempo de desarrollo de los manuales: Sólo debemos
crear un proyecto y a partir de éste introducir la información,
para generar y actualizar las salidas de archivos de acuerdo con
nuestras necesidades, ya que las herramientas manejan todos los
aspectos complejos y técnicos.
Manuales en formato HTML y XML: Permite desarrollar manuales de
las aplicaciones basadas en Web e integrarlos.
Algunas herramientas incluyen visualizador de imágenes, utilidad
de captura de pantalla y herramientas que ayudan a crear, diseñar
e imprimir el manual de la aplicación.
Es esencial proporcionar la documentación a quien vaya usar
la aplicación, ya que permite enseñar a los usuarios
cómo interactuar con el sistema y a los desarrolladores a
hacer actualizaciones.
Entre las herramientas que existen podemos encontrar versiones de
evaluación y libres por ejemplo: Help & Manual 4, HelpMaker
7.2, Help Creator 1.0, Help Workshop. |
