Documentacion

La documentacion de un proyecto de software es importante debido a que ayuda a explicar y a poner en disponibilidad de los interesados la informacion importante del proyecto como lo son los objetivos, alcances, limites entre otros.

Tambien la documentacion es importante para entender el proyecto y el negocio tanto para los desarrolladores como para los clientes, usuarios y stakeholders.

La documentacion esta dividida en 5 tipos principales:

• Documentacion General
• Documentacion Economica.
• Documentacion Tecnica.
• Documentacion de Usuario.
• Documentacion Gerencial o Resumen ejecutivo.

Documentacion General:

Es la documentacion en donde se plasma el analisis y pre-analisis del proyecto, este documento contiene:

• Informacion del Negocio
• Informacion de la organizacion
• Objetivos del proyecto
• Limites del proyecto
• Alcances del proyecto
• Descripcion del problema
• Areas involucradas
• Propuestas claras de solucion
• Recursos
• Calendarizacion

Documentacion Economica:

En esta documentacion el objetivo es analizar y mostrar el beneficio que obtendremos del proyecto y el costo que tiene involucrado el proyecto, frecuentemente esta documentacion sirve para hacer un analisis financiero en donde esta involucrado

• La calidad del producto
• La cantidad
• El timpo
• El beneficio
• El costo

Indudablemente son variables que toman importancia para las empresas y que de ellas depende si ganamos la cotizacion para desarrollar o otra empresa ofrece mejores vantajas que nosotros.

En este documento es importante destacar las ventajas competitivas de nuestro equipo de desarrollo debido a que este aspecto pudiera ser el factor determinante para ser contratados.

Documentacion Tecnica

En la documentacion tecnica es donde se detallan los aspectos de estructura de la solucion de software, documentacion que en un futuro sera util para entender cualquier problema del software, para planificar el mantenimiento o para incrementar la funcionalidad del mismo.

La documentacion tecnica debe ser detallada y explicada porque esta documentacion debe ser entendible por personal que inclusive no estubo involucrado en el analisis ni el diseño.

Imaginemos que el software se desarrollo hace 10 años y las personas que participaron en ese proyecto de desarrollo ya no se encuentran laborando para la empresa, en cambo ahora hay otras personas encargadas del software.  Es en este caso que los nuevos desarrolladores acuden a la documentacion tencica para entender la estructura del software.

Entre las caracteristicas de la documentacion tecnica tenemos:

• Diseño de la base de datos
• Diseño de las aplicaciones (form)
• Diseño de la red
• Documentacion de codigo
• Diagramacion UML en general

Documentacion de Usuario

La documentacion de usuario debe ser lo mas detallada en cuanto a la forma de uso del software, aqui debemos destacar la funcionalidad para que el usuario final entienda la forma de operar del software y que se reduzca la resistencia a utilizar el mismo.

Entre la documentacion de usuario debemos incluir:

• Objetivo del software
• Forma de funcionamiento
• Datos de entrada (validados)
• Informacion de salida
• Secluencia de ejecucion.
• Preguntas frecuentes
• Ayuda

Si fuera posible en este manual hay que colocar imagenes con los pasos remarcados (rojo) para que el usuario se guie mejor, podemos incorporar videos y sonido demostrativo para mejorar la experiencia del usuario.

Documentacion Gerencial o Recumen ejecutivo 

Esta es una documentacion compuesta de las documentaciones anteriores, debemos colocar un resumen del software principalmente resaltando las ventajas del mismo para que sea atractivo nuestro trabajo para la gerencia, debemos incluir imagenes, graficas y resumenes pequeños.

Este documento se debe elaborar con poco contenido pero muy concreto y debe ser escrito con lenguaje claro y sencillo, sin tecniquismos.

Ademas tenemos que tener la habilidad de plantear la idea del proyecto de forma atractiva, que cause interes y logre que los gerentes se inclinen hacia nuestro proyecto.

Una buena practica es elaborar el resumen ejecutivo y darselo a un amogo o familiar ajeno al proyecto para que lo lea detenidamente, despues, debemos pedirle que nos describa el proyecto y asi sabremos que hemos logrado transmitir con el documento. tambien preguntarle si esta claro, que podria mejorarse, si causamos impacto y provocamos interes por el proyecto.

Finalmente debemos trabajar exaustivamente en el resumen ejecutivo debido a que muchos gerentes es lo unico que leen de los proyectos y si no logramos convencerlos con nuestro trabajo entonces sera un proyecto perdido.