NOTA:

El estilo de redacción de los manuales de documentación debe:

 Ser concreto.
 Definir los términos utilizados.
 Utilizar títulos, subtítulos y párrafos cortos.
 Emplear formas activas en lugar de pasivas.
 Aplicar correctamente las referencias bibliográficas.
 No usar frases largas que presenten hechos distintos.
 Al finalizar actualizar el índice

1 Introducción
El Manual Técnico, como su nombre lo indica, contiene las especificaciones técnicas más
importantes del sistema desarrollado. Constituye una guía especializada para la realización
de las operaciones de mantenimiento de la aplicación. Se encuentra dirigido
fundamentalmente a la dirección de Tecnologías de la Información, al administrador del
sistema, a otros desarrolladores, así como al departamento de calidad y auditoría de
sistemas.

2 Descripción
2.1 Nombre del sistema
Nombre del sistema al que se refiere el manual.

2.2 Versión del sistema

La versión del sistema en el manual nos permitirá mantener un control sobre las
modificaciones que han afectado al sistema original.

2.3 Tipo de manual

Se especifica el tipo de manual al que se hace referencia, permitiendo tener un control en
nuestros manuales, además de una fácil identificación.

2.4 Fecha de elaboración del manual

Fecha de elaboración, para tomarla como un punto de referencia y control.

2.5 Contenido
2.5.1 Introducción
Breve descripción del sistema desarrollado, que contemple el ámbito abarcado, cuál es su
función principal y un detalle de las funciones o partes que lo componen. Además, incluir
una pequeña descripción del negocio en el cual se enmarca la aplicación.

2.5.2 Objetivos
Breve descripción de los objetivos generales y específicos que se cumplieron con el
desarrollo del sistema.

2.5.3 Fundamentación de la tecnología implementada

Breve descripción, acerca de las tendencias y tecnologías actuales sobre las que se apoya la
propuesta, además incluir la justificación de las seleccionadas para el desarrollo de la
aplicación.
2.5.4 Requerimientos técnicos

2.5.5 Estilo arquitectónico

Define la estructuración en capas de la aplicación.

2.5.6 Diagrama del modelo arquitectónico

Diagrama del modelo de capas

2.5.7 Modelo lógico de datos

 Incluir el Diagrama de Clases asociado a la vista de la arquitectura de la aplicación.
Debe contener las entidades del sistema, sus atributos, así como las relaciones que
se establecen entre ellas. (sólo clases, no es la entidad relación, el ER va en otro
documento)
 ER
 Diccionario de datos

2.5.8 Descripción de los algoritmos

Se deben explicar de manera exhaustiva en lenguaje natural los algoritmos y diagramas de
flujo más importantes y complejos.

2.5.9 Configuraciones adicionales

2.5.10 Glosario de términos

En él se definen los conceptos y términos importantes para la comprensión del problema,
así como de todos los procesos descritos anteriormente.