Un manual técnico es aquel que va dirigido a un público con conocimientos técnicos

sobre algún área.

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

El manual técnico va dirigido a la dirección de IT, al administrador del sistema y a otros

desarrolladores de software para que puedan darle mantenimiento en caso de que se
requiera. También puede ser utilizado por el departamento de auditoría de sistemas
El Manual Técnico del Sistema debe contener como mínimo:

 Introducción
<Breve descripción del alcance del documento y resumen de este>
 Tabla de contenido
<Estructura de un documento con los títulos de los temas y subtemas que forman el
documento>
 Pre-requisitos de instalación del sistema en el servidor
<Sistema operativo de los servidores de aplicaciones y base de datos, marca y
versión de la base de datos, marca y versión de los servidores de aplicaciones,
navegador, configuraciones de seguridad, etc., para que el sistema se pueda
ejecutar correctamente>

 Pre-requisitos de instalación del sistema en el cliente

<Descripción de los requerimientos mínimos que se deben tener tanto de hardware
como de software para que el sistema se pueda ejecutar de forma correcta a nivel
del cliente (usuario final)>

 Frameworks y estándares
<Nombres y versiones de los frameworks y estándares bajo los cuales está
construido el sistema>

 Controles de auditoría implementados en el sistema. NA

<Definir los eventos y la trazabilidad que se está registrando sobre las operaciones
que se realizan en los sistemas de información, con el objeto de realizar monitoreo
de los servicios informático>

 Requerimientos de interfaz con otros sistemas cuando aplique NA

<Las interfaces se definen como un proceso continuo donde se tiene siempre la
información actualizada mediante enlaces directos entre los sistemas y donde se
generan procesos directamente desde un sistema al otro>

 Modelo de datos (ER) con su respectivo diccionario de datos

<Estructura lógica de una base de datos que determina el modo de almacenar,
organizar y manipular los datos>

 Diagrama de Servicios NA
<Diagrama de servicios expuestos por el sistema>

 Descripción del Modelo de Persistencia NA

<Es la integración con una base de datos para guardar, actualizar y recuperar la
información que utiliza nuestra aplicación>

 Reglas de negocio
 <define o restringe algunos aspectos del negocio. Intenta hacer valer la estructura
del negocio, o controlar o influir en la conducta del negocio. Es importante saber
ubicar a las reglas del negocio dentro de una estructura de requerimientos>

 Scripts de instalación NA
<Scripts de instalación del sistema>

 Diagrama de despliegue NA
<Diagrama de despliegue del sistema >

 Diagrama de componentes NA
<Diagrama de componentes del sistema>