Saltar la navegación

3.8.- Documentación.

Caso práctico

Imagen que muestra a una chica sentada, trabajando con un ordenador.

Ada ha quedado dentro de dos días con su cliente. Pregunta a María por todos los dossiers de documentación. La pálida expresión de la joven hace que Ada arda en desesperación: "—¿No habéis documentado las etapas? ¿Cómo voy a explicarle al cliente y sus empleados el funcionamiento del software? ¿Cómo vamos a realizar su mantenimiento?".

Todas las etapas en el desarrollo de software deben quedar perfectamente documentadas.

En realidad, la documentación no debe ser considerada como una etapa más en el desarrollo del proyecto, la elaboración de documentos es constante durante todo su ciclo de vida.

Documentar un proyecto se hace necesario para dar toda la información a los usuarios de nuestro software y para poder acometer futuras revisiones.

Una correcta documentación permitirá pasar de una etapa a otra de forma clara y definida. También se hace imprescindible para la reutilización de parte de los programas en otras aplicaciones, siempre y cuando se desarrollen con diseño modular.

De acuerdo al destinatario final de los documentos, podemos distinguir tres tipos:

Guías técnicas. Dirigidos a personal técnico en informática (analistas y programadores).

Aspectos que quedan reflejados:

El diseño de la aplicación.

La codificación de los programas.

Las pruebas realizadas.

¿Cuál es su objetivo?

Facilitar un correcto desarrollo, realizar correcciones en los programas y permitir un mantenimiento futuro.

Guías de uso. Dirigidos a usuarios que van a usar la apliación(clientes).

Aspectos que quedan reflejados:

Descripción de la funcionalidad de la aplicación.

Forma de comenzar a ejecutar la aplicación.

Ejemplos de uso del programa.

Requerimientos software de la aplicación.

Solución de los posibles problemas que se pueden presentar.

¿Cuál es su objetivo?

Dar a los usuarios finales toda la información necesaria para utilizar la aplicación.


 Guías de instalación. Dirigidos al personal informático responsable de la instalación.

Aspectos que quedan reflejados:

Puesta en marcha.

Explotación.

Seguridad del sistema.

¿Cuál es su objetivo?

Dar toda la información necesaria para garantizar que la implantación de la aplicación se realice de forma segura, confiable y precisa.

Reflexiona

Según estimaciones, el 26% de los grandes proyectos de software fracasan, el 48% deben modificarse drásticamente y sólo el 26% tienen rotundo éxito. La principal causa del fracaso de un proyecto es la falta de una buena planificación de las etapas y mala gestión de los pasos a seguir. ¿Por qué el porcentaje de fracaso es tan grande? ¿Por qué piensas que estas causas son tan determinantes?