Unidad VI Documentación M.C. Juan Carlos Olivares Rojas

Agenda 6.1 Manual Técnico Delimitación Justificación Objetivos Análisis Diseño Programas Pruebas

Agenda 6.2 Manual del Usuario Introducción Requerimientos de H/S Instalación Operación

6.1 Manual técnico La documentación de proyectos es importante para identificar mas fácilmente los aspectos y características que forman parte de un proyecto. Una adecuada documentación le proporciona identidad y "personalidad" a un proyecto, de manera que los usuarios responsables del mismo podrían reconocer más fácilmente las ventajas y desventajas, características y funcionalidades, funciones y ventajas, así como costos y beneficios que impliquen el desarrollo del proyecto.

Manual técnico La documentación de un proyecto debe contar con las siguientes características: Lenguaje claro y de acuerdo al nivel aplicado: Gerencial. Técnico. Usuario. Contemplar todos los aspectos del proyecto.

Manual técnico Contar con objetivos fácil de detectar. Servir como soporte en todo el desarrollo del proyecto. Identificar ventajas y desventajas (resaltar ventajas). Contar con adecuada estructura.

Manual técnico Los documentos que componen una adecuada documentación de un proyecto deben ser los siguientes: Carpeta general o profesional. Carpeta gerencial o resumen ejecutivo. Carpeta técnica. Plan económico (factibilidad).

Carpeta profesional Consiste en un documento que detalla todos los aspectos relacionados con el proyecto, identifica todas las bases y orígenes sobre las que nace el proyecto, además que especifica los pasos necesarios, los recursos y aplicaciones que un proyecto necesita. El objetivo de la carpeta profesional es servir de modelo para la implementación del proyecto a desarrollar, de manera que las personas involucradas obtengan información fácilmente en cualquier etapa del proyecto.

Carpeta profesional Los aspectos principales que debe de contemplar la carpeta profesional son: Definición del problema a resolver (delimitar). Definición clara de objetivo y metas. Áreas que involucra. Conocimiento de la organización. Planteamiento claro (pasos).

Carpeta profesional Investigación. Propuestas claras. Plan de trabajo. Recursos. Calendarización.

Carpeta profesional Este documento va dirigido hacia personas que van a estar relacionadas directamente con la implementación del proyecto, por lo que su nivel se orienta hacia el uso y aplicaciones utilizadas para el definir el proyecto. De preferencia se debe hacer carpetas especializadas por cada tipo de usuario.

Carpeta gerencial o resumen ejecutivo Este documento va dirigido hacia las personas de más alto nivel de la empresa o hacia aquellas de las que depende la decisión de implementar o no el proyecto. Generalmente se utiliza un lenguaje claro sin tecnicismo, en términos ejecutivos. Su extensión no debe ser mucha, y debe de recalcar los aspectos mas importantes del proyecto.

Carpeta gerencial o resumen ejecutivo Generalmente debe contener elementos gráficos y resúmenes que ayuden a identificar más fácilmente las ideas propuestas. Esta carpeta es importante ya que va dirigido a las personas que toman decisiones.

Carpeta técnica Este documento contiene toda la información sobre los recursos utilizados por el proyecto, llevan una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento. Por ejemplo: características de procesadores, velocidad, dimensiones del equipo, garantías, soporte, proveedores y equipo adicional. Su extensión depende de la cantidad de recursos y equipo utilizado y generalmente se presenta en forma de fichas técnicas en donde se describe en cada una las características de cada recurso.

Carpeta económica (plan o propuesta). Este documento contiene información relacionada con el aspecto económico y de factibilidad del proyecto, su objetivo principal es describir todos aquellos costos relacionados con el desarrollo e implantación del proyecto, ayuda a la empresa a establecer marcos de referencia y evaluar mas fácilmente los alcances y disponibilidad para llevar a cabo el proyecto.

Carpeta económica (plan o propuesta). Consta de 2 secciones, una de ellas es el plan económico del desarrollo del proyecto y la otra es el plan económico para implementar el proyecto (la mas importante). Generalmente en esta carpeta se incorpora el estudio de factibilidad que permitirá a la empresa a evaluar la posibilidad de poner en marcha la realización del proyecto.

Delimitación La primera fase que se debe hacer es definir que características debe tener el documento técnico y si esté va a ser entregado o va a ser documento interno. Cuando el documento es externo este debe contener sólo la información necesaria para el entendimiento del software.

Justificación La sección de justificación del documento técnico es importante para entender el porque se hizo el proyecto. En muchos casos la justificación dice al lector si valió la pena el proyecto o no, además de que indica si la solución desarrollado resuelve el problema planteado.

Objetivos Los objetivos definen las actividades que debe de hacer el software o prototipo implementado. Se debe hacer esta anotación por que si no se tiene claro la misión y visión del proyecto, no se alcanza a comprender el porque se implementó dicha solución.

Análisis La etapa de análisis consiste en detallar cada una de los módulos del proyecto definiendo las características que deben de hacer. La fase de análisis responde a los ¿qué? Del software o del mecanismo de solución.

Diseño La fase de diseño indica los ¿cómo? Del software o de la solución planteada. Antes de implementar cualquier cosa, se necesita tener la idea de cómo solucionarlo. Si no se tiene alguna idea de cómo solucionar un problema difícilmente se resolverá.

Programas Los programas en el área de la computación es la forma en que se implementa un diseño para solucionar un problema a través de una computadora. La utilización de un lenguaje de programación en un proyecto dependerá de las características del proyecto y del equipo de trabajo.

Pruebas En la fase de pruebas se muestran el plan de pruebas que se diseñó y se ejecutó para probar el problema. Se detallan los resultados obtenidos así como si se resolvieron o no los problemas detectados en la fase de depuración.

6.2 Manual de usuario El manual de usuario es el documento técnico que explica el funcionamiento del software o prototipo desarrollado como producto resultante del proyecto. El manual de usuario detalla cada una de las funciones del prototipo así como la forma en que debe operar el usuario el desarrollo.

Introducción La introducción indica el contexto en que fue desarrollado el proyecto. Detalla las características sobresalientes del prototipo implementado. Muestra cada una de las demás secciones del manual de usuario.

Requerimientos de H/S En el manual de usuario se necesita indicar las características que debe poseer el software desarrollado para poderse ejecutar. Se debe detallar las características mínimas, recomendadas y óptimas, tanto de hardware y software.

Instalación El manual de usuario debe indicar la forma en como debe de instalarse el software desarrollado para poderse ejecutar. El proceso debe detallar cada una de las acciones que necesita hacer el usuario para poner a punto el sistema.

Operación El manual de usuario debe indicar cada una de las acciones que puede realizar el usuario sobre el sistema. El manual de usuario debe de servir de referencia a todo tipos de usuarios desde usuarios limitados hasta los administradores

¿Preguntas?