Implementación de TIC

Octavio César Escobar Jaramillo Capacitación sobre la solución tecnológica

Documentación de sistemas
La documentación de sistemas es el conjunto de información que nos dice ¿qué hacen los
sistemas?, ¿cómo lo hacen? Y para ¿quién lo hacen?.

La documentación consiste en material que explica las características técnicas y la operación de un

sistema. Es escencial para proporcionar entendimiento de un sistema a quien lo vaya a usar, para
mantenerlo y para procesos de auditoría.

Pueden generarse varios tipos de documentación:

Documentación técnica.- que explica la lógica del sistema y su código cuando aplique. Puede ser
que se contengan inclusive descripciones dentro del mismo código a manera de comentarios.
Adicionalmente pueden incluirse diagramas de flujo, requisitos de infraestructura, arquitectura de
bases de datos, requerimientos de comunicaciones, listados de programas, y otros documentos.

Documentación para el usuario.- Contiene en forma general naturaleza de las capacidades del
sistema y el cómo utilizarlo. Puede incluirse una sección de errores comunes que sirvan al usuario
como referencia de apoyo mientras usa el sistema.

La importancia de la documentación bien podría ser comparada con la importancia de la existencia

de una póliza de seguro; mientras todo va bien no existe precaución de confirmar si la póliza está
o no vigente. El problema viene cuando esta es requerida ante un incidente.

La documentación adecuada y completa de una aplicación es escencial en un sistema de

información. Sin embargo, frecuentemente es la parte a la cual se dedica el menor tiempo y se le
presta menor atención. Documentación incompleta dentro de las empresas normalmente trae
como consecuencia que el diseñador constantemente esté incolucrado en el sistema y complique
el que pueda moverse a otra asignación.

Manual de usuario
El manual de usuario es un documento técnico de un determinado sistema que intenta dar
asistencia que sus usuarios. Los manuales de usuario generalmente son incluidos a dispositivos
electrónicos, hardware de computadora y aplicaciones. El manual de usuario puede venir tanto en
forma de libro como en forma de documento digital, e incluso poder ser consultado por internet
(este último convirtiéndose en el medio más frecuente con el desarrollo de los sistemas de nube).

En general, un manual de usuario debería poder ser entendido por cualquier usuario principiante,
como así también serle útil a usuarios avanzados. Un error común de un manual de usuario es que
sea realizado por personal técnico de sistema e incluya tecnisismos. Estos deben ser eliminados ya
que el enfoque de este documento es al usuario final. Un manual de usuario completo suele tener:
 Implementación de TIC
Octavio César Escobar Jaramillo Capacitación sobre la solución tecnológica

• Un prefacio, con información sobre cómo usar el propio manual.
• Un índice.
• Una guía rápida rápida sobre cómo usar las funciones principales del sistema.
• Una sección para la resolución de problemas.
• Una FAQ (tipo de archivos).
• Información de contacto.
• Un glosario.

Uno de los objetivos fundamentales del Manual de Usuario es facilitar la tarea de conocimiento,
uso y aprendizaje del sistema. Sin embargo, se ha de tener siempre presente que los métodos,
mecanismos de trabajo y las propias herramientas software difieren de las utilizadas por otros
sistemas lo que es difícil pensar en un manual de proósito general para los usuarios.

El manual de usuario contiene información acerca de todas las operaciones básicas para la
mayoría de los usuarios. Da una visión completa del uso de la solución a nivel de usuario,
explicando con detalle el funcionamiento de las herramientas utilizadas en el sistema e incluyendo
capturas de pantallas útiles para el seguimiento de la explicación.

El manual de usuario debe contemplar (según aplique) la explicación del uso de dispositivos de
almacenamiento externo como son memorias USB, nube de datos, CD, CD-RW o DVD.
Configuraciones básicas, desde el teclado, idioma, fecha y hora.

Manual técnico
Este documento contiene la información sobre recursos utilizados en la solución tecnológica,
incluyen una descripción detallada sobre las características físicas y técnicas de cada componente.
Puede incluir temas como las 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. Este
tipo de manual suele incluir información como:

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

• Diagramas de flujo de datos, junto con su respectivo diccionario de datos.
• Controles de auditoria implementados en el sistema.
• Descripción de campos requeridos por pantalla con presentación de pantallas.
• Diagrama de navegación del sistema.
• Requerimientos de interfase con otros sistemas.
• Modelo lógico de datos, diagrama entidad-relación.
• Modelo de datos físico, junto con su respectivo diccionario de datos.
 Implementación de TIC
Octavio César Escobar Jaramillo Capacitación sobre la solución tecnológica

• Matriz de procesos versus organización.
• Matriz de programas versus entidades.
• Requerimientos mínimos que se deben tener tanto de hardware como de software para
que el sistema se pueda instalar y ejecutar correctamente.
• Áreas de aplicación o alcance de los procedimientos. Esfera de acción que cubren los
procedimientos
• Autor y medios de escalamiento ante incidentes con el sistema (En ocasiones esto se
entrega en documento separado)