Unidad

Documentacin de un Proyecto

ADMINISTRACIN DE PROYECTOS

8.1 Importancia de la documentacin de un proyecto

La documentacin de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicacin como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilizacin de parte del programa en otras aplicaciones, sin necesidad de conocerse el cdigo al dedillo. La documentacin de un programa empieza a la vez que la construccin del mismo y finaliza justo antes de la entrega del programa o aplicacin al cliente. As mismo, la documentacin que se entrega al cliente tendr que coincidir con la versin final de los programas que componen la aplicacin. Una vez concluido el programa, los documentos que se deben entregar son una gua tcnica, una gua de uso y de instalacin.

Tipos de documentacin .

La documentacin que se entrega al cliente se divide claramente en dos categoras, interna y externa:

 Interna: Es aquella que se crea en el mismo cdigo, ya puede ser en forma de comentarios o de archivos de informacin dentro de la aplicacin.  Externa: Es aquella que se escribe en cuadernos o libros, totalmente ajena a la aplicacin en si. Dentro de esta categora tambin se encuentra la ayuda electrnica.

La gua tcnica.
En la gua tcnica o manual tcnico se reflejan el diseo del proyecto, la codificacin de la aplicacin y las pruebas realizadas para su correcto funcionamiento. Generalmente este documento esta diseado para personas con conocimientos de informtica, generalmente programadores. El principal objetivo es el de facilitar el desarrollo, correccin y futuro mantenimiento de la aplicacin de una forma rpida y fcil. Esta gua esta compuesta por tres apartados claramente diferenciados:  Cuaderno de carga: Es donde queda reflejada la solucin o diseo de la aplicacin. Esta parte de la gua es nicamente destinada a los programadores. Debe estar realizado de tal forma que permita la divisin del trabajo  Programa fuente: Es donde se incluye la codificacin realizada por los programadores. Este documento puede tener, a su vez, otra documentacin para su mejor comprensin y puede ser de gran ayuda para el mantenimiento o desarrollo mejorado de la aplicacin. Este documento debe tener una gran claridad en su escritura para su fcil comprensin.  Pruebas: es el documento donde se especifican el tipo de pruebas realizadas a lo largo de todo el proyecto y los resultados obtenidos.

La gua de uso

Es lo que comnmente llamamos el manual del usuario. Contiene la informacin necesaria para que los usuarios utilicen correctamente la aplicacin. Este documento se hace desde la gua tcnica pero se suprimen los tecnicismos y se presenta de forma que sea entendible para el usuario que no sea experto en informtica. Un punto a tener en cuenta en su creacin es que no debe hacer referencia a ningn apartado de la gua tcnica y en el caso de que se haga uso de algn tecnicismo debe ir acompaado de un glosario al final de la misma para su fcil comprensin.

La gua de instalacin

Es la gua que contiene la informacin necesaria para implementar dicha aplicacin. Dentro de este documento se encuentran las instrucciones para la puesta en marcha del sistema y las normas de utilizacin del mismo. Dentro de las normas de utilizacin se incluyen tambin las normas de seguridad, tanto las fsicas como las referentes al acceso a la informacin.

8.2 Informe tcnico.

QU ES UN INFORME TCNICO?

Es la exposicin por escrito de las circunstancias observadas en el reconocimiento de precios, edificaciones, documentos, etc... , o en el examen de la cuestin que se considera, con explicaciones tcnicas, econmicas , etc. El informe se puede definir como "una exposicin de datos o hechos dirigidos a alguien, sobre una cuestin o asunto, o sobre lo que conviene hacer del mismo". Es, dicho de otra manera, "un documento que describe el progreso o resultados de una investigacin cientfica o tcnica, o el estado de un problema cientfico" (UNE 50135:1996). Se prepara a solicitud de una organizacin o persona.

Un informe tcnico es un documento que describe el progreso o los resultados de una investigacin tcnica, o el estado de un problema tcnico.

Un informe de este tipo debe presentar, sistemtica o cronolgicamente, informacin suficiente para que un lector cualificado pueda juzgar, evaluar o proponer modificaciones a sus conclusiones o recomendaciones.

Un informe tcnico debe comprender las siguientes partes:

Parte inicial. Cuerpos del informe. Anexos. Parte final.

   

Parte inicial.

La parte inicial debe contener los elementos siguientes en el orden que se indica a continuacin:

1. Primera y segunda pginas de cubierta, si fuesen necesarias. 2. Portada. 3. Resumen. 4. ndice. 5. Glosario de signos, smbolos, unidades, abreviaturas, acrnimos o trminos tcnicos. 6. Prefacio, si fuese necesario.

Cuerpo del informe.

El cuerpo del informe constar de las siguientes partes en el orden que se indica a continuacin:

1. Introduccin. 2. Ncleo del informe con ilustraciones y tablas. 3. Conclusiones y recomendaciones. 4. Agradecimientos, si los hubiese. 5. Listas de referencia.

Anexos.

Los anexos se consideran separadamente de la parte final, debido a que, aunque no siempre se requieren, pueden formar parte esencial de algunos informes.

Parte final.
La parte final debe contener los siguientes elementos en el orden que se indica a continuacin:
1. Hojas de datos del documento. 2. Lista de distribucin y disponibilidad, si se requiere. 3. Cubierta posterior (pginas tercera y cuarta de la cubierta), si se requiere

8.2.1 Plan estructurado del proyecto.

Es un modelo del trabajo a realizar en un proyecto organizado en estructura jerrquica. La herramienta PEP es una herramienta importante que le ayuda a mantener un resumen del proyecto. Esta herramienta es la base de la organizacin y coordinacin del proyecto. Muestra la cantidad de trabajo, el tiempo necesario y los costes producidos en el proyecto.

El plan estructurado del proyecto es la base operativa para otras etapas de la planificacin de proyecto, por ejemplo, planificacin de costes, programacin, planificacin de capacidades y Control del proyecto. La estructura de proyecto puede representarse en funcin de varios criterios:  Fases (orientado a la lgica).  Por funcin (orientado a la funcin).  Por objeto (orientado al objeto).

En un plan estructurado del proyecto se describen tareas individuales y actividades en el proyecto como elementos individuales de una jerarqua. En funcin de la fase de su proyecto, contine desglosando las tareas y operaciones del proyecto, etapa por etapa, hasta que alcance el grado de detalle necesario para llevarlo a cabo.

Elementos del plan estructurado del proyecto:  Tareas  Tareas parciales que estn subdivididas en otras  Paquetes de trabajo