La documentación en ingeniería de software es como un paraguas que comprende todos los documentos y materiales escritos que se requieren para el desarrollo y uso del producto de software.
Hay cuatro tipos diferentes de manuales de documentación. Cada manual de documentación se prepara en diferentes fases del desarrollo del software.
Clasificación del Manual de Documentación:
1. Manual de análisis/especificaciones:
este manual se prepara durante la fase de análisis del desarrollo del software. En este manual se describen todas las informaciones que especifican los requisitos del software. La información de este manual se presenta a continuación:
- Especificación formal:
en esto, todos los requisitos del software se describen en detalle. - Diagrama de contexto:
este diagrama describe el contexto del software. - Diagrama de flujo de datos: el diagrama
de flujo de datos es una representación visual del flujo de información dentro del software.
2. Manual de diseño:
en este manual, toda la información sobre el diseño del software y cómo debe verse un software. Este manual consta de lo siguiente:
- Diagramas de flujo:
es una representación visual para representar el procedimiento de trabajo del software. - Diagramas de relación de entidades:
este es un tipo de diagrama de flujo que ilustra cómo las «entidades» como personas, objetos, etc.
3. Manual de implementación:
este manual se prepara durante la fase de desarrollo del desarrollo del software. En este manual, toda la información sobre el código del programa, los algoritmos y las estructuras de datos que se utilizan en el software. Este manual consta de lo siguiente:
- Listado de código fuente:
describe el código desarrollado para ese software. - Listado de referencias cruzadas:
describe la referencia del módulo de código.
4. Manual de Prueba:
Este manual se prepara en la fase de prueba del Software. El probador se utiliza para comprobar el software en busca de los mejores y peores casos de funcionamiento y el resultado se almacena. Este manual consta de lo siguiente:
- Datos de prueba:
estos son los datos que se utilizan como entrada para procesar la tarea en el software. - Resultados de prueba:
estos datos son la salida que produce el software para los datos de prueba proporcionados.
Publicación traducida automáticamente
Artículo escrito por SHUBHAMSINGH10 y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA