Manual Tecnico

Elaboracion Manual Tecnico

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.

CONSIDERACIONES GENERALES PARA LA DOCUMENTACIÓN DE EL DESARROLLO DE APLICACIONES INFORMÁTICAS:

1. Toda documentación que se genere para un proyecto específico, que haya sido revisada y aprobada, debe poseer lo siguiente:

A) Identificación del documento

Este documento debe incorporar la siguiente información:

• Logotipo de la organización.

• Nombre oficial de la organización.

• Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma.

• Lugar y fecha de elaboración.

• Número de revisión (en su caso).

• Unidades responsables de su elaboración, revisión y/o autorización.

• Clave de la forma. En primer término, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por último, el número de la forma. Entre las siglas y el número debe colocarse un guión o diagonal. (en su caso)

B) Estructura del documento.

2. Por cada documento final deberá entregarse copias al personal involucrado en el proyecto.

3. Una vez concluido el desarrollo de un sistema, considerando para esto los posibles cambios que se efectúen durante la etapa de garantía de que lo cubre (si así fuera el caso), el usuario final del sistema debe recibir una versión actualizada final del documento manual técnico.

Estructura del documento MANUAL TÉCNICO

1. Índice

Relación de los capítulos y páginas correspondientes que forman parte del documento

2. Introducción.

Se debe presentar una breve descripción del sistema desarrollado, que contemple el ámbito abarcado, cual es su función principal y un detalle de las funciones macros o partes que lo componen. Puede incluir un mensaje de la máxima autoridad de las áreas comprendidas en el manual.

2.1. Objetivo general del sistema

Se debe de describir el objetivo general del sistema.

2.2. Objetivos específicos

Se deben describir brevemente los objetivos específicos que se cumplieron con el desarrollo del sistema.

3. Contenido técnico

3.1. Definición de reglas del negocio implementadas en el sistema desarrollado.

3.2. Diagramas de flujo de datos, junto con su respectivo diccionario de datos.

...