La importancia de la documentación de software

Definición de documentación de software

Los manuales técnicos, de usuario y otras instrucciones que facilitan el uso y operación de un producto o servicios de software constituyen la documentación de software, la cual podría incluir (donde fuera necesario) el código fuente, los códigos de error y sus significados. Puede existir en formato electrónico, como archivo PDF o CD, o como libro.

Normas para la documentación del software

El Instituto de Ingeniería Eléctrica y Electrónica (IEEE, por sus siglas en inglés) ha diseñado normas para la documentación de la industria del software. Se le denomina IEEE 1063-2001, "Estándar para la documentación de usuario de software", y detalla el contenido, la arquitectura y la importancia de un manual de documentación del software. La Organización Internacional de Normalización y la Comisión Electrotécnica Internacional (ISO e IEC, ídem) también han establecido normas para la documentación del software. Sus estándares se llaman ISO/IEC 18019-2004 e ISO/IEC TR 9294. Se ocupan de la documentación y la gestión del software, respectivamente. Cada una de estas normas hace hincapié en que la documentación es una parte integral del ciclo de vida del software.

Funciones de la documentación de software

Todos los procesos del ciclo vital del software en el desarrollo de cualquier software se registran como documentación. La documentación sirve como información escrita sobre definición de requerimientos, especificaciones generales del sistema, especificación de cada componente y los planes integrales de prueba y mantenimiento. Las herramientas de gestión de configuración también son de gran utilidad en la documentación del software.

Documentación de software para desarrolladores

La importancia de la documentación para desarrolladores radica en el hecho de que la primera contiene información sobre las operaciones del sistema de software. Esta información posibilita la reproducción del software o su adaptación para mantenimiento. El tipo de información documentada suele valer muchísimo para la compañía de software. Dicha información podría perderse si no se documenta, ya que los desarrolladores van y vienen.

Documentación de software para usuarios finales

Guardar

documents image by AGITA LEIMANE from Fotolia.com

Los manuales de usuario final facilitan la interacción de dicho usuario con la computadora. Un manual de capacitación es un ejemplo de un manual orientado al usuario. Reduce el tiempo de aprendizaje para el uso productivo del software, ahorrando al usuario final muchísimo dinero. Los documentos del usuario final también pueden ser un manual de referencia, que detalle el funcionamiento del sistema, o una guía para administradores de sistema, que detalle la forma de operar y dar mantenimiento al sistema.