Tema 5 - Manual Técnico y del Usuario

La documentación de proyectos es importante para identificar más 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 irresponsables del mismo podrán 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.

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.
• 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.

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).

(Ver más)

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.

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).
• Investigación.
• Propuestas claras.
• Plan de trabajo.
• Recursos.
• Calendarización.

    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.

Carpeta Gerencial o Resumen Ejecutivo.

    Este documento va dirigido hacia las personas de mas 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 más importantes del proyecto. Generalmente debe contener elementos gráficos y resúmenes que ayuden a identificar mas fácilmente las ideas propuestas.

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.

    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 más 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.