Anexo G

Anexo G
Estándares de documentación y manuales
DOCUMENTACIÓN TÉCNICA
Toda documentación que se genere para un Sistema Informático específico, que haya sido
revisado y aprobado, debe poseer lo siguiente:
IDENTIFICACIÓN DEL DOCUMENTO
Este documento debe incorporar la siguiente información:
 Logotipo del Ministerio de Salud, SNIS-VE, Unidad solicitante u otro en consenso

con la unidad que revisa el Sistema Informático.
 Nombre oficial del SNIS-VE.
 Denominación y extensión, de corresponder a una unidad/área en particular debe
anotarse el nombre de la misma.
 Lugar y fecha de elaboración.
 Número de revisión (en su caso).
 Unidades/áreas responsables de su elaboración, revisión y/o autorización.
 Clave del formulario. En primer término, las siglas del SNIS, en segundo lugar, las
siglas de la unidad/área involucrada donde se utiliza el formulario y, por último, el
número correlativo del formulario. Entre las siglas y el número debe colocarse un 169
guion o diagonal. (en su caso)
Manual de Normas, Procesos y Procedimientos para el Desarrollo de Sistemas

ESTRUCTURA DEL DOCUMENTO.
Por cada documento final deberá entregarse copias al personal involucrado en el proyecto
de desarrollo del Sistema.
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.
De su estructura
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, áreas de aplicación e importancia de su revisión y actualización, cuál 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 del SNIS y las áreas involucradas 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.
3.3. Controles de auditoria implementados en el sistema.
3.4. Descripción de campos requeridos por pantalla con presentación de pantallas.
3.5. Mapa de navegación. Muestra de forma gráfica la interconexión entre cada una
de las pantallas del sistema, lo que servirá para saber cómo llegar a
determinada parte de la aplicación. Se muestran los menús, submenús y
pantallas a las que nos lleva cada uno de ellos
3.6. Descripción gráfica del mapa de navegación. En el anterior aparece de forma
de diagrama de flujo y en esta sección deberá aparecer ya con las respectivas
pantallas.
3.7. Descripción paso a paso de los procesos. Así como pantallas, botones, cuadros
de texto, etc., pero también se muestra el código de cada rutina, pantalla, botón,
etc. es decir, se muestra lo que hay detrás de la interfaz del usuario
170
3.8. Requerimientos de interface con otros sistemas (si hubiere).
Serie: Documentos Técnico Normativos
3.9. Modelo lógico de datos, diagrama entidad-relación.

3.10. Modelo de datos físico, junto con su respectivo diccionario de datos.
3.11. Matriz de procesos versus unidades/áreas involucradas.
3.12. Plataforma de usuario. Aquí se describen los requerimientos mínimos 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.13. Áreas de aplicación y/o alcance de los procedimientos. Esfera de acción que
cubren los procedimientos.
Responsables
Para iniciar los trabajos que conducen a la integración de un manual, es indispensable

prever que no quede diluida la responsabilidad de la conducción de las acciones en
diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo
técnico del Área Tecnológica del SNIS-VE, al que se le debe encomendar la conducción
del proyecto de desarrollo de sistemas, en sus fases de diseño, implantación y
actualización.
De esta manera se logra homogeneidad en el contenido y presentación de la información.
Por lo que respecta a las características del equipo técnico, es conveniente que sea
personal con un buen manejo de las relaciones humanas y que conozca a la organización
en lo que concierne a sus objetivos, estructura, funciones y personal.
Para este tipo de trabajo, el SNIS debe nombrar a la persona que tenga los conocimientos
y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede
encargarlo al titular del área tecnológica conjuntamente con los servicios de consultores
externos.
Concepto (s)
Palabras o términos de carácter técnico que se emplean en el procedimiento, las cuales,

por su significado o grado de especialización requieren de mayor información o ampliación
de su significado, para hacer más accesible al usuario la consulta del manual.
Procedimiento (descripción de las operaciones)
Se debe presentar por escrito, en forma narrativa y secuencial, de cada una de las
operaciones que se realizan en un procedimiento, explicando en qué consisten, cuándo,
cómo, dónde, con qué, y cuánto tiempo se hacen, señalando los responsables como ser,
establecimientos de Salud, Municipios, coordinador de Red, etc., de llevarlas a cabo.
Cuando la descripción del procedimiento es general, y por lo mismo comprende varias
áreas, debe anotarse la unidad que tiene a su cargo cada operación. Si se trata de una
descripción detallada dentro de una unidad administrativa, tiene que indicarse el puesto
responsable de cada operación. Es conveniente codificar las operaciones para simplificar
su comprensión e identificación, aun en los casos de varias opciones en una misma
operación.
171
Formularios impresos.

Formularios impresos que se utilizan en un procedimiento, las cuales se intercalan dentro
del mismo o se adjuntan como anexos. En la descripción de las operaciones que impliquen
su uso, debe hacerse referencia específica de éstas, empleando para ello números
indicadores que permitan asociarlas en forma concreta. También se pueden adicionar
instructivos para su llenado que de acuerdo a la evolución de la tecnología podrán ser
formularios digitales, tales como los formularios F-301, F-302 y F-303
Diagramas de flujo.
Representación gráfica de la sucesión en que se realizan las operaciones de un

procedimiento y/o el recorrido de formularios o materiales, en donde se muestran las
unidades involucradas, puestos de salud y municipios que intervienen en cada operación
descrita. Además, suelen hacer mención del equipo o recursos utilizados en cada caso.
Los diagramas representados en forma sencilla y accesible en el manual, brinda una
descripción clara de las operaciones, lo que facilita su comprensión. Para este efecto, es
aconsejable el empleo de símbolos y/o gráficos simplificados, el diagrama de flujo debe
ser representado por un diagrama Swim.
Glosario de términos.
Debe tener una lista de conceptos de carácter técnico relacionados con el contenido y
técnicas de elaboración de los manuales de procedimientos, que sirven de apoyo para su
uso o consulta.
MANUAL DEL USUARIO
El Manual de Usuario debe facilitar:
1) Los documentos a los que se pueden dar entrada por computadora.
2) Los formatos de los documentos.
3) Las operaciones que utiliza de entrada y salida de los datos.
4) El orden del tratamiento de con los datos introducidos.
5) El momento en que se debe solicitar una operación deseada.
6) Los resultados de las operaciones realizadas a partir de los datos introducidos.
Al elaborar el Manual de Usuario, hay que tener en cuenta a quién va dirigido, es decir, el
manual puede ser manejado desde el Coordinador del SNIS hasta el introductor de datos
de los establecimientos de Salud. Por consiguiente, debe redactarse de forma clara y
sencilla para que lo entienda cualquier tipo de usuario.
El manual del usuario debe contener:
Índice
Contenido
Descripción del contenido del manual de usuario

172
Diagrama general del sistema
Serie: Documentos Técnico Normativos
Muestra en forma condensada el flujo general de la información y de las actividades que

se realizan en el sistema. Proporciona una visión general del sistema. Representar los
diagramas utilizando para ello diagramas de bloques.
Diagrama particular detallado.
Presentar gráficamente todos los pasos que se efectúen dentro del Área del usuario a
quien está dirigido este manual.
Deben especificarse los de entrada, salida, los resultados, revisiones y procesos
manuales.
Explicación Genérica de las Fases del Sistema
En este punto se explica en forma específica y detallada todas las operaciones que
aparecen representadas en forma gráfica en el diagrama particular. Se analizan cada una
de las fases señalando:
a) El proceso principal que se desarrolla.
b) La entrada de la información.
c) La obtención de un resultado parcial.
d) El envío de información a otra Área.
Instalación del Sistema
La instalación del sistema proporciona detalles completos sobre la forma de instalar el

sistema en un particular de acuerdo a la tecnología preparada en la fase de Análisis y
determinación de requerimientos.
Iniciación al Uso del Sistema
En este punto se explica cómo iniciarse en el sistema y cómo se pueden utilizar sus
cualidades comunes. Esta documentación debe decir al usuario cómo salir de un
problema cuando las cosas funcionan mal.
Manual de Referencia
Es el documento definitivo de cara al usuario y debe ser completo. Describe con detalle
las cualidades del sistema y su uso, los informes de error generados y las situaciones
en que surgen esos errores.
Dependiendo del sistema, los documentos se pueden proporcionar al usuario por
separado o reunidos en varios volúmenes.
El software desarrollado tiene que tener sistemas de ayuda en línea, esto evita que el
173
usuario pierda tiempo en consultas manuales.

Anexo G

Cargado por

Copyright:

Formatos disponibles

Anexo G

Cargado por

Información del documento

Descripción original:

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Anexo G

Cargado por

Copyright:

Formatos disponibles

Anexo G

Estándares de documentación y manuales

IDENTIFICACIÓN DEL DOCUMENTO

Este documento debe incorporar la siguiente información:

 Logotipo del Ministerio de Salud, SNIS-VE, Unidad solicitante u otro en consenso

Manual de Normas, Procesos y Procedimientos para el Desarrollo de Sistemas

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

3.9. Modelo lógico de datos, diagrama entidad-relación.

Para iniciar los trabajos que conducen a la integración de un manual, es indispensable

Palabras o términos de carácter técnico que se emplean en el procedimiento, las cuales,

Procedimiento (descripción de las operaciones)

Manual de Normas, Procesos y Procedimientos para el Desarrollo de Sistemas

Representación gráfica de la sucesión en que se realizan las operaciones de un

Descripción del contenido del manual de usuario

Muestra en forma condensada el flujo general de la información y de las actividades que

Explicación Genérica de las Fases del Sistema

La instalación del sistema proporciona detalles completos sobre la forma de instalar el

Iniciación al Uso del Sistema

Manual de Normas, Procesos y Procedimientos para el Desarrollo de Sistemas

También podría gustarte