Recopilación y organización de documentación

a)organización de documentación

o medio mecanico

Recopilación y organización de documentación

Como finalización de la parte de documentación de todo el desarrollo, hay que hacer entrega de la documentación apropiada como una parte integral del producto resultante. En esta fase es necesario reunir todos los documentos generados y clasificarlos según el nivel técnico de sus descripciones. Es muy importante distinguir entre la documentación orientada a futuros desarrollos o modificaciones de mantenimiento (documentación de diseño, implementación y pruebas, manual técnico, manual de referencia), frente a la documentación de uso y aplicación (introducción de uso rápido, manual de configuración, manual de usuario, manual de interfaz). Una vez que se ha finalizado el proyecto se debe tener una documentación útil para el mantenimiento posterior y para la operación normal por parte de los usuarios. Esta sección es una enumeración bastante exhaustiva de esta documentación que se puede también consultar en: http://www.mendoza.gov.ar/imagenes/comip/metodologia.pdf.

7.3.1 Motivos de la documentación

Hay dos motivos para contar con una buena documentación:

1. Facilita el mantenimiento porque:

o Ayuda a localizar donde hay que modificar o añadir código.

o Los mantenedores necesitarán menos tiempo para comprender cada módulo.

o Supone una forma de comunicación entre profesionales, sobre todo si la forma en la que se ha realizado sigue un estándar, por ejemplo, todo el mundo sabe interpretar un diagrama de clases de UML.

o Una buena documentación facilita que el mantenimiento lo puedan realizar terceras empresas o personas.

2. Facilita la auditoría. Una auditoría es un examen del sistema que se puede hacer desde varios puntos de vista. Por ejemplo, aquí nos interesa saber si se están cumpliendo plazos o las normas de la empresa en la redacción del código.

7.3.2 Directrices a seguir para la redacción de un documento

Muchas organizaciones tienen un programa de documentación, que es un procedimiento estandarizado de redactar los manuales técnico y de usuario. Los procedimientos de documentación deben ser estandarizados para que de esta forma la comunicación sea rápida, no ambigua y reduzca costes de personal, es decir, se debe huir de las ``florituras'' lingüísticas propias de la literatura haciendo énfasis en la claridad y la concisión.

En general todos los tipos de documentos deben tener un estilo homogéneo, para ello se debe seguir un formato que tenga estos elementos:

1. Un preámbulo con: Autor(es) del manual, fecha, versión y revisores.

2. Un índice con secciones y subsecciones. A la hora de empezar a redactar un documento se hace un primer esbozo de las secciones a cubrir. Posteriormente, a medida que se van escribiendo se pueden hacer cambios,

...