Manual tcnico.

Interpretacin de
Documentacin Tcnica

Manual tcnico. Trata acerca de los principios y tcnicas de una

funcin operacional determinada. Se elabora
como fuente bsica de referencia para la
unidad administrativa responsable de la
actividad y como informacin general para el
personal interesado en esa funcin. Ejemplos
de este tipo de "Manual tcnico de auditoria
administrativa", y el "Manual tcnico de
sistemas y procedimientos"..

MANUAL TCNICO:
Documento que contiene informacin vlida y

clasificada sobre la estructura y modo de operar un

aparato. Su contenido destina un porcentaje menor
a la descripcin y uno mayor a la grfica. Ejemplos
Manuales de TV y Sonido, CPU, vehculos, etc.

Informacin contenida en
Manuales.
Tipos de manuales tcnicos:

Componentes y dispositivos.
Maquinaria y equipos.
Instalacin de equipos y sistemas.
Operacin de equipos y sistemas.
Mantenimiento de equipos y sistemas.
Anlisis de informacin escrita.
Anlisis de informacin grfica.

Manuales tcnicos.
Consulta de datos tcnicos.
Anlisis grfico.
Anlisis funcional.
Consulta de componentes

equivalentes.
Verificacin de parmetros de
operacin.

Manual tcnico
Este documento contiene toda la informacin sobre
los recursos utilizados por el proyecto, llevan una
descripcin muy bien detallada sobre las
caractersticas fsicas y tcnicas de cada elemento.
Por ejemplo: caractersticas de procesadores,
velocidad, dimensiones del equipo, garantas,
soporte, proveedores y equipo adicional.

Su extensin depende de la cantidad de recursos y

equipo utilizado y generalmente se presenta en
forma de fichas tcnicas en donde se describe en
cada una las caractersticas de cada recurso.

CONSIDERACIONES GENERALES PARA LA

DOCUMENTACIN DE EL DESARROLLO DE
APLICACIONES INFORMTICAS:
1. Toda documentacin que se genere para un
proyecto especfico, que haya sido revisada
y aprobada, debe poseer lo siguiente:
A) Identificacin del documento
Este documento debe incorporar la siguiente
informacin:
Logotipo de la organizacin.
Nombre oficial de la organizacin

 Denominacin y extensin. De corresponder a una

unidad en particular debe anotarse el nombre de la

misma.

Lugar y fecha de elaboracin.

Nmero de revisin (en su caso).
Unidades responsables de su elaboracin, revisin y/o
autorizacin

Clave de la forma. En primer trmino, las siglas de la

organizacin, en segundo lugar las siglas de la unidad

administrativa donde se utiliza la forma y, por ltimo,
el nmero de la forma. Entre las siglas y el nmero
debe colocarse un guin o diagonal. (en su caso)

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 efecten durante la etapa de garanta de
que lo cubre (si as fuera el caso), el usuario
final del sistema debe recibir una versin
actualizada final del documento manual tcnico.

Estructura del documento MANUAL TCNICO

1. ndice: Relacin de los captulos y pginas
correspondientes que forman parte del documento
2. Introduccin: Se debe presentar una breve descripcin
del sistema desarrollado, que contemple el mbito
abarcado, cual es su funcin principal y un detalle de
las funciones macros o partes que lo componen. Puede
incluir un mensaje de la mxima 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 especficos: Se deben describir
brevemente los objetivos especficos que se
cumplieron con el desarrollo del sistema.

3. Contenido tcnico
3.1. Definicin de reglas del negocio implementadas en
el sistema desarrollado.
3.2. Diagramas de flujo de datos, junto con su
respectivo diccionario de datos.
3.3. Controles de auditoria implementados en el
sistema.
3.4. Descripcin de campos requeridos por pantalla con
presentacin de pantallas.
3.5. Diagrama de navegacin del sistema.
3.6. Requerimientos de interfase con otros sistemas.
3.7. Modelo lgico de datos, diagrama entidad-relacin.
3.8. Modelo de datos fsico, junto con su respectivo
diccionario de datos.
3.9. Matriz de procesos versus organizacin.
3.10. Matriz de programas versus entidades.

 3.11. Plataforma de usuario. Aqu se

describen los requerimientos mnimos que

se deben tener tanto de hardware como de
software para que el sistema se pueda
instalar y ejecutar correctamente (en caso
de que se considere necesario).

3.12. reas de aplicacin y/o alcance de los

procedimientos. Esfera de accin que
cubren los procedimientos

Estos son los pasos del manual del

usuario:
1. Portada: De que se trata el documento y quien lo
elaboro?
2. Introduccin: Describe el uso del documento ( para que
sirve?) y de que habla?
3. Anlisis y requerimientos del sistema(que se ocupa para
poder instalarlo y usarlo?)
3. Explicacin del funcionamiento: Debes de poner paso a
paso y con pantallas bien explicadas como funciona el
programa
4. Glosario