Usuario:SalinasL
Sumario
Documentación de software
La documentación de un software es el registro de todo lo que ocurrió en la implementación de una solución. Existen distintas metodologías sobre cómo hacer documentación. Aunque sí es importante estudiarlas, lo principal es evaluar qué funciona y qué no.
No es inteligente seguir ciegamente una metodología sólo porque así lo dice la certificación o el libro. Las circunstancias nunca van a ser las mismas que las del autor de la metodología.
La estructura documental de los proyectos de desarrollo de software
La estructura documental de los proyectos de desarrollo de software suele consistir en un documento –o más de uno- por cada una de las fases del desarrollo, si se sigue la versión 2.1 de MÉTRICA (o por cada uno de los procesos del desarrollo, si se sigue la versión 3). Esta documentación es la que establecen los manuales de Ingeniería del Software, indicándose en el cuadro no. 1 la documentación que indica R. S. Pressman (1992).
| PASOS | DOCUMENTO GENERADO |
|---|---|
| Análisis del sistema funciones del software | Planificación plan del proyecto |
| Análisis de requisitos o creación de un prototipo | Especificación de requisitos |
| Diseño de datos y arquitectónico | Especificación preliminar del diseño |
| Diseño procedimental | Especificación detallada del diseño |
| Codificación | Documentación del código |
| Pruebas | Plan, procedimientos y resultados de las pruebas |
| Lanzamiento y distribución | Documentación de usuario |
| Mantenimiento | Documentos modificados |
Cuadro 1. La documentación técnica generada en cada paso de las fases del desarrollo y mantenimiento de software.
Comparación de la documentación de proyectos de desarrollo de software con proyectos de otras tecnologías
Entendemos que la documentación que se presenta en los proyectos de software, se corresponde principalmente con la que aparece en Anexos a la Memoria en los proyectos que no son informáticos. Como se indica en el apartado 2, la Memoria es el Documento nº I, y consta de dos partes principales que son:
- I.1: Memoria, propiamente dicha.
- I.2: Anexos a la Memoria.
La documentación que se presenta con los proyectos de desarrollo de software corresponde a la Documentación Técnica, que también se presenta en los no informáticos; pero en estos aparece, como se ha dicho, agrupada en los Anexos, que forman parte del documento nº I (Memoria); y el resto de documentación se independiza, formando otros documentos (Documento nº III: Pliego de condiciones, y Documento nº IV:Presupuesto –además del Documento nº II: Planos, que es fundamental cuando se trata de construcciones, etc.-).
Relación entre las etapas de Proyecto y las etapas de su Ejecución
Son muchas las diferencias entre proyectos informáticos y los de otras tecnologías, pero interesa aquí señalar una, que se refiere a la relación y a la división y separación entre dos grandes etapas del proyecto y su ejecución; etapas que son las siguientes:
- Etapa de Proyecto.
- Etapa de Ejecución del Proyecto.
Interés de la estructura documental uniforme para los proyectos de diversas tecnologías
La estructura documental señalada, se puede decir que encuentra su justificación en los siguientes aspectos, al menos:
- Tiene una correspondencia con los llamados “factores del proyecto”, esto es, con los objetivos, contenidos y las condiciones que el proyecto debe considerar. E. Gómez-Senent (1994), presenta un cuadro en el que se expresa gráficamente la relación entre cada uno de los cuatro documentos típicos de cualquier proyecto tecnológico, y los que denomina factores del proyecto. Esto es, en todo proyecto tecnológico, aparecen determinados objetivos, condiciones, contenidos, etc. (los factores) que son recogidos en cada uno de los documentos referidos.
- Aparece recogida en alguna normativa legal, relativa a ciertos tipos de Proyectos.
- La recomienda el Instituto de Ingenieros Civiles de España.
- Está arraigada en la práctica de Proyectos anteriores a la Informática. Y mantiene su vigencia a pesar del paso del tiempo (incluso centenario), por lo que se trata de una estructura útil.
- Es la utilizada por las Administraciones Públicas, cuya participación en la actividad social es muy importante, tanto en España como en la Unión Europea (con esto se quiere indicar que la propuesta se formula también para los proyectos de promoción privada).
- Es conocida por muchas personas de las organizaciones públicas (y también, por supuesto, de las empresas), si estas han encargado algún Proyecto de tecnologías.
- El profesional de las Tecnologías de la información puede trabajar en equipos interdisciplinares. Una razón para la convergencia hacia la norma referida, es que estos profesionales no siempre trabajan individualmente o en grupos de personas de la misma profesión, sino que pueden hacerlo con frecuencia en el seno de equipos interdisciplinares − formados por profesionales de otras tecnologías y especialidades, y otros titulados, etc.− y la estructura normalizada la conoce todo profesional.
- Ha demostrado ser operativa para buscar la información deseada en una documentación extensa (como suele ser la del Proyecto).
Referencias
GÓMEZ-SENENT, E. y CHINER, M. (1.994): El Proceso Proyectual. Ed. Universidad Politécnica de Valencia, Valencia.
PRESSMAN, R. S. (1.992): Ingeniería de Software. Un enfoque práctico. Ed. McGraw-Hill, Madrid
