DOCUMENTACIÓN DURANTE EL DESARROLLO DEL SOFTWARE

La documentación se suele clasificar en función

de las personas o grupos a los cuales está dirigida:
•Documentación para los desarrolladores
•Documentación para los usuarios
•Documentación para los administradores o soporte técnico

Documentación para los desarrolladores

• Es aquélla que se utiliza para el propio desarrollo del producto y, sobre todo, para su mantenimiento futuro. 
• Se documenta para comunicar estructura y comportamiento del sistema o de sus partes, para visualizar y controlar la arquitectura del sistema, para comprender mejor el mismo y para controlar el riesgo, entre otras cosas.
• En este sentido, todas las fases de un desarrollo deben documentarse: requerimientos, análisis, diseño, programación, pruebas, etc.. 
• Hay decenas de notaciones, tanto estructuradas como orientadas a objetos. Un caso particular es el de UML, que analizamos en otra obra. 
• De todas maneras, los diagramas son muy útiles, pero siempre y cuando se mantengan actualizados, por lo que más vale calidad que cantidad.

Documentación para los usuarios

• La documentación para usuarios es todo aquello que necesita el usuario para la instalación, aprendizaje y uso del producto. Puede consistir en guías de instalación, guías del usuario, manuales de referencia y guías de mensajes 
• Los usuarios no leen los manuales a menos que nos les quede otra opción, se recurre a los manuales solamente cuando se produce un error o se desconoce cómo lograr algo muy puntual, y recién cuando la ayuda en línea no satisface las necesidades del usuario.
• Es incluso deseable proveer un software tutorial que guíe al usuario en el uso del sistema, con apoyo multimedia, y que puede llegar a ser un curso online. 
• Buena parte de la documentación para los usuarios puede empezar a generarse desde que comienza el estudio de requisitos del sistema.

Documentación para administradores

• También soporte técnico, a veces llamada manual de operaciones, contiene toda la información sobre el sistema terminado que no hace al uso por un usuario final. 
• Es necesario que tenga una descripción de los errores posibles del sistema, así como los procedimientos de recuperación. 
• Como esto no es algo estático, pues la aparición de nuevos errores, problemas de compatibilidad y demás nunca se puede descartar, en general el manual de operaciones es un documento que va engrosándose con el tiempo