manuales técnicos , manuales y otras instrucciones que facilitan el uso y el funcionamiento de un producto o servicios de software constituyen la documentación del software . Esta documentación puede incluir en su caso, el código fuente, los códigos de error y sus significados. La documentación del software puede existir también en formato electrónico, en formato PDF , como un CD o un libro.
Software Documentación Normas
el Instituto de ingeniería eléctrica y electrónica ( IEEE) ha diseñado normas para la documentación del software de la industria del software . IEEE 1063-2001 , "estándar de Software Documentación del usuario ", detalla este documento el contenido , la arquitectura y la importancia de un manual de documentación de software llamado . La Organización Internacional de Normalización ( ISO ) y la Comisión Electrotécnica Internacional ( IEC ) también han establecido normas para la documentación del software. Sus estándares se llaman ISO /IEC 18019-2004 y la norma ISO /IEC TR 9294 . Se ocupan de la documentación del software y su gestión , respectivamente . Cada una de estas normas hacen hincapié en que la documentación del software es una parte integral del ciclo de vida del software.
Funciones de documentación de software
Todos los procesos del ciclo de vida del software en la desarrollo de cualquier software se registran como documentación del software. La documentación del software sirve como información escrita sobre definición de requerimientos , especificaciones generales del sistema , la especificación de cada componente y los planes de mantenimiento de pruebas integrales. Herramientas de gestión de configuración también son muy útiles en la documentación del software.
Software Documentación para Desarrolladores
La importancia de la documentación del software para desarrolladores de software radica en el hecho de que la documentación del software contiene información en las operaciones del sistema de software . Esta información permite reproducir el software o adaptarlo a maintenance.The tipo de información documentada es generalmente un valor de millones a la compañía de software . Dicha información podría perderse si no se documentó que los desarrolladores van y vienen.
Software Documentación para usuarios finales
Software Documentación ayuda a los usuarios finales aprecian el software más rápido.
manuales de usuario final facilitan la interacción del usuario final con el ordenador . Un manual de capacitación es un ejemplo de un manual orientado al usuario. Se reduce el tiempo de aprendizaje para el uso productivo del software , ahorrando al usuario final millones de dólares. Los documentos de los usuarios finales también pueden ser un manual de referencia que detalla el funcionamiento del sistema o la Guía del administrador del sistema que detalla cómo operar y mantener el sistema .