Metodología para elaboración de Manuales de Usuarios Proyecto SIACE

SISTEMA INTEGRAL ADMINISTRATIVO DE
CONTRALORIAS DE ESTADO
(SIACE)
Pagina Elaboración
1/ 18
25/07/2016
METODOLOGÍA PARA EL DESARROLLO DE
MANUALES DE USUARIOS DE SISTEMAS
Versión
1.0
Actualización
-
La información contenida en este documento es propiedad intelectual de las Contralorías de estados Orientales de Venezuela
Se prohíbe la reproducción total o parcial del mismo, sin consentimiento explícito de las mismas.
ENCUENTRO DE CONTRALORÍAS ORIENTALES-ENCOOVE – TODOS LOS DERECHOS RESERVADOS 2015.
Metodología para el Desarrollo de Manuales de Usuarios
de Sistemas
Versión 1.0
Julio de 2016

(SIACE)
Pagina Elaboración
2/ 18
25/07/2016
Versión
1.0
Actualización
-
DATOS DE LOS PARTICIPANTES EN LA
ELABORACIÓN Y/O MODIFICACIÓN DEL MANUAL
FECHA VERSIÓN DESCRIPCIÓN AUTOR CONTRALORIA
25/07/2016 1.0 ELABORACIÓN ANALISTAS DE
PLANIFICACIÓN Y
TELEMÁTICA I
MONAGAS

(SIACE)
Pagina Elaboración
3/ 18
25/07/2016
Versión
1.0
Actualización
-
ÍNDICE
Pág.
INTRODUCCIÓN……………………………………….……………………………………………….………………...2
CAPITULO I: GENERALIDADES DE LA METODOLOGÍA
OBJETIVO………………………………………………………………………………………………………………………...4
ALCANCE…………………………………………………………………………………………………………………………4
REFERENCIAS…….……………………………………………………………………………………………………….……4
DEFINICIONES……………...……………………………………………………………………………………………...……4
CAPITULO II: LINEAMIENTOS PARA DESARROLLAR EL MANUAL
NORMAS G ENERALES………………………………………………………………………………………………………...7
NORMAS DE PRESENTACIÓN..………………………………………………………………...………………………….…7
NORMAS DE REDACCIÓN….………………………………………………………………………………………………..10
CAPITULO III: DESARROLLO DEL MANUAL
ELABORACIÓN……………………………………………………………………………………………………...………….14

(SIACE)
Pagina Elaboración
4/ 18
25/07/2016
Versión
1.0
Actualización
-
INTRODUCCIÓN
Los manuales de usuarios son documentos de comunicación técnica que buscan
brindar asistencia a los sujetos de cómo utilizar el sistema, además sirven de apoyo para
capacitar al personal, ya que facilita la comprensión y entendimiento preciso de las
operaciones, tramites y servicios que realiza el sistema de información.
La metodología pretende servir de orientación y ayuda a los responsables de elaborar
este tipo de instrumentos, además contiene la descripción de los capítulos necesarios para
su elaboración. Es importante utilizar un lenguaje simple, claro y directo, el cual permitirá
mejorar la redacción, la comunicación y el grado de instrucción que se desea establecer en
los manuales de usuarios que se emitan.
La presente metodología está estructurada en tres capítulos: capítulo I Generalidades
de la metodología donde se describen el objetivo, alcance, referencias y definiciones. En el
capítulo II denominado “Lineamientos para desarrollar el manual”, donde se describen las
normas generales, de presentación y de redacción. Capítulo III denominado “Desarrollo del
manual” que describe como elaborar el manual de usuario.

(SIACE)
Pagina Elaboración
5/ 18
25/07/2016
Versión
1.0
Actualización
-
CAPITULO I
GENERALIDADES DEL MANUAL

(SIACE)
Pagina Elaboración
6/ 18
25/07/2016
Versión
1.0
Actualización
-
OBJETIVO
Proporcionar una metodología para la elaboración, presentación y contenido de los
manuales de usuarios del Sistema Integral Administrativo de Contralorías de Estado
(SIACE).
ALCANCE
Esta metodología se ha dividido en 3 capítulos, señalándose en los dos (02) primeros la
estructura de la metodología y en el último, todo lo referente al desarrollo del manual de
usuario, a saber:
I. Generalidades de la metodología.
II. Lineamientos para Desarrollar el manual.
III. Desarrollo del manual.
La metodología ofrece una guía práctica y sencilla para el desarrollo de manuales de
usuarios del Sistema Integral Administrativo de Contralorías de Estado (SIACE), que
permitirá identificar claramente el objetivo, alcance, los requerimientos del sistema tanto de
hardware y de software, el paso a paso del uso del sistema
REFERENCIA
Metodología para el desarrollo de manuales de usuario de sistemas de información,
elaborado por Dirección Técnica de la Contraloría del estado Monagas, Julio 2013.
Curso “Elaboración de Manuales Administrativos”, Instituto de Altos Estudios de Control
Fiscal y Auditoría de Estado, Fundación “Gumersindo Torres” (COFAE).
DEFINICIONES
Formulario: Son formas impresas que contienen una información fija o de concepto (la que
ya viene impresa) y otra información variable (la que se escribe sobre la forma) para ser
utilizados en una actividad determinada.
Manual: Instrumento técnico que contiene en forma ordenada y sistemática información
sobre objetivos, políticas, atribuciones, organización y procedimientos de una institución; así
como las instrucciones para la ejecución del trabajo asignado al personal, teniendo como
marco de referencia los objetivos de la institución.
Manual de usuario: Es un documento de comunicación técnica que buscan brindar
asistencia a los sujetos de cómo utilizar el sistema, además sirven de apoyo para capacitar
al personal, ya que facilita la comprensión y entendimiento preciso de las operaciones,
tramites y servicios que realiza el sistema de información.

(SIACE)
Pagina Elaboración
7/ 18
25/07/2016
Versión
1.0
Actualización
-
Metodología: Es un conjunto de procedimientos basados en principios lógicos, utilizados
para alcanzar una gama de objetivos que rigen una investigación. Es la manera de organizar
el proceso de la investigación, de controlar sus resultados y de presentar posibles soluciones
a un problema que conlleva la toma de decisiones. La metodología es parte del análisis y la
crítica de los métodos de investigación
Normas: Son los lineamientos que deben cumplir para la realización del manual que
atribuyen responsabilidades de cómo realizar las actividades.
Sistemas: Es un conjunto de elementos organizados y relacionados que interactúan entre sí
para lograr un objetivo. Los sistemas reciben (entrada) datos, energía o materia del ambiente
y proveen (salida) información, energía o materia.
Sistemas de información: Es un conjunto organizado de elementos dirigidos a recoger,
procesar, almacenar y distribuir información de manera que pueda ser utilizada por las
personas adecuadas dentro de las empresas, de modo que desempeñen sus actividades de
manera eficaz y eficiente.
Unidad organizativa: Es la representación de un grupo de personas que laboran dentro de
una organización, identificados y unidos de manera integral para el logro de objetivos
comunes, los cuales se distinguen por un orden jerárquico referente a las actividades,
conocimiento y destreza que aplica.

(SIACE)
Pagina Elaboración
8/ 18
25/07/2016
Versión
1.0
Actualización
-
CAPITULO II
LINEAMIENTOS PARA DESARROLLAR EL MANUAL

(SIACE)
Pagina Elaboración
9/ 18
25/07/2016
Versión
1.0
Actualización
-
NORMAS GENERALES
1. Los responsables de realizar el manual de usuario de un sistema de información son los
programadores encargados del desarrollo del sistema.
2. Los manuales de usuario de un sistema deben ser revisados por los jefes inmediatos del
área de programación así como también del área de organización y métodos.
3. El manual de usuario debe ser revisado por la Dirección técnica.
4. Es deber de la Dirección Técnica someter el manual de usuario para su aprobación por
el (la) Contralor(a).
5. Los manuales de usuarios de sistemas de información deben transcribirse en un solo
formato pre escrito en esta metodología.
NORMAS DE PRESENTACIÓN
1. El tamaño del papel a utilizar debe ser carta. Ancho 21,59cm y alto 27,94cm.
2. Los márgenes estarán comprendido: Superior 2,5 cm. Inferior 2,5 cm. Izquierdo 3 cm.
Derecho 2,5 cm.
3. El tamaño del logo debe estar comprendido en un tamaño de 2,13 cm de Alto y 2,46 cm
de Ancho.
4. La portada del manual será la establecida en los artefactos del desarrollo del Sistema
Integral Administrativo de Contralorías de Estado (SIACE).
5. El encabezado, debe cumplir con las siguientes exigencias:
Medidas para los recuadros:
(Aplicará para todas las secciones del recuadro)
Área 1: 2,57 cm alto, 2,57 cm ancho

(SIACE)
Pagina Elaboración
10/ 18
25/07/2016
Versión
1.0
Actualización
-
6. El pie de página, debe cumplir con las siguientes especificaciones:
 El tipo de letra es Arial tamaño 8 con alineación centrada.
7. La estructura del manual debe contener lo siguiente:
Portada.
Índice.
Introducción.
I. Generalidades del manual:
Objetivo.
Alcance.
Requerimientos del sistema:
Hardware
Software
II. Guía de usos
III. Definición de términos.

(SIACE)
Pagina Elaboración
11/ 18
25/07/2016
Versión
1.0
Actualización
-
NORMAS DE REDACCIÓN
1. Se deberá utilizar un lenguaje formal, claro y sencillo, de manera que su comprensión
sea rápida y fácil, a tono con la alta investidura o jerarquía de la persona o funcionario
que lo suscriba.
2. La descripción del objetivo deberá comenzar con un verbo en infinitivo y en un máximo
de 5 líneas.
3. Evitar el uso de términos complejos en la redacción del manual, porque el objetivo es
que sea comprendido completamente por el usuario, en tal sentido, deben evitarse
palabras confusas.
4. Cuando se utilice abreviatura, se deberá explicar su significado incluyendo
inmediatamente entre paréntesis la sigla correspondiente la primera vez. Por ejemplo:
SIACE (Sistema Integral Administrativo de Contralorías de Estado).
5. Cada párrafo debe contener frases cortas, leguaje sencillo y debe estar comprendido
entre cinco (05) y once (11) líneas en alineación: justificada, interlineado: sencillo de
1,0cm. Al culminar cada párrafo se debe dejar un espacio para iniciar el siguiente
párrafo.
6. Los títulos deben poseer fuente Arial tamaño once (11), alineación: justificada, en
mayúsculas, negritas y sin punto final.
7. Se debe dejar un espacio entre párrafo y dos para los títulos.
8. La fuente que se debe utilizar en el contenido del manual es Arial, normal tamaño once
(11).
9. En caso de utilizar una palabra en ingles se debe colocar el significado en español y
entre paréntesis la palabra en inglés.
10. Para las pantallas:
 La fuente que se usará para resaltar las pantallas debe ser Arial, normal tamaño
ocho (08).
 El color del tipo de letra que se utiliza para señalar las pantallas es negro.
 Cada imagen debe identificarse con el nombre de la pantalla por ejemplo INICIO
DE SESIÓN al pie de la imagen en mayúsculas.
 Se debe continuar la secuencia de las imágenes por ejemplo figura N°1, figura
N°2.
 Al culminar la descripción de cada pantalla debe ir “ver figura N° X” que le
corresponda a la imagen.
 La imagen va centrada.
 El formato de la imagen es rectángulo sombreado.
 El tamaño de la imagen es de 10 cm alto y 15 cm de ancho:

(SIACE)
Pagina Elaboración
12/ 18
25/07/2016
Versión
1.0
Actualización
-
11. La simbología que se utilizara para identificar las pantallas son:
FLECHA Para indicar o señalar, con
el grosor de dos (02)
punto y en color rojo.
OVALO Para resaltar, grosor de
dos (02) puntos y en color
rojo.
CUADRO DE
TEXTO
Se usan para escribir la
descripción de las
pantallas, sin borde y sin
relleno.

(SIACE)
Pagina Elaboración
13/ 18
25/07/2016
Versión
1.0
Actualización
-
CAPITULO III
DESARROLLO DEL MANUAL

(SIACE)
Pagina Elaboración
14/ 18
25/07/2016
Versión
1.0
Actualización
-
ELABORACIÓN
1. PORTADA
Es la primera página del manual, se elabora según las Normas de Presentación
numeral 4.
Figura N° 1. PORTADA
2. ÍNDICE
Incluye la relación de las partes que conforman el documento permitiendo lo
siguiente:
 Dar una referencia numérica o alfanumérica a cada concepto.
 Colocar las referencias a la izquierda de los temas y conceptos incluidos, es
decir número de páginas.
 El nombre índice, introducción y los capítulos van en mayúscula y en negrita.
 La identificación índice debe ir en alineación: centrada y la palabra “página”,
se debe abreviar (pág.) en negrita y con alineación: a la derecha.
 La estructura del índice debe ir en alineación: justificada.

(SIACE)
Pagina Elaboración
15/ 18
25/07/2016
Versión
1.0
Actualización
-
3. INTRODUCCIÓN
Se refiere a la explicación que se dirige al lector sobre el contenido del manual, de su
utilidad y de los fines y propósitos generales que se pretende cumplir a través de él.
Incluye información de cómo se usará, quien, cómo y cuándo hará las revisiones y
actualizaciones.
Es recomendable que al formular la introducción, se emplee un vocabulario sencillo, a
efecto de facilitar su entendimiento, cumpliendo lo siguiente:
 Propósito y utilidad.
 Síntesis del contenido.
 Ámbito de su aplicación.
4. OBJETIVO
En este apartado se deberá expresar el propósito que se pretende alcanzar con la
aplicación del manual. El objetivo deberá ser lo más concreto posible, y su redacción
clara y en párrafos breves, la descripción del objetivo deberá comenzar con un verbo
en infinitivo y en un máximo de 5 líneas.
5. ALCANCE
En esta sección se debe describir las funcionalidades del sistema.
6. REQUERIMIENTOS DEL SISTEMA
Esta parte se refiere a aquellos aspectos que necesita el sistema para funcionar,
tanto a nivel del hardware como del software.
6.1 HARDWARE.
En esta sección se debe establecer la parte física es decir las características que
debe tener el hardware de una computadora para ejecutar la aplicación desarrollada.
Ejemplo:
Los requerimientos de hardware deben de ser:
Hardware Mínimo Máximo
Procesador Pentium 4 I7,I5,I3,Core duo
Espacio en disco
duro
2GB 4GB
Memoria RAM 512 MB 2GB
Cámara PC VGA Cámara VGA

(SIACE)
Pagina Elaboración
16/ 18
25/07/2016
Versión
1.0
Actualización
-
6.2 SOFTWARE
En este apartado se describe la parte lógica del sistema es decir aquellas
características que debe tener el software para ejecutar la aplicación desarrollada.
Pueden ser:
 Requisitos del sistema operativo.
 Requisitos de otras aplicaciones.
Ejemplo:
Los requerimientos de software deben de ser:
7. GUÍA DE USOS
En este capítulo se capturan las pantallas para ser descritas, es decir, dar a conocer
al usuario paso a paso el funcionamiento total del sistema. Para las capturas de
pantallas debe cumplir lo siguiente:
• Ubicar en el teclado la tecla print screen o Impr pant, que generalmente se
encuentra ubicada en la parte superior derecha del teclado al lado de la tecla
f12. (ver figura N°2 )
Figura N° 2. TECLADO
• Pegar (pulsar las teclas Ctrl+v al mismo tiempo o simplemente dar click
derecho y pulsar la opción pegar), seguidamente aparecerá la pantalla
capturada, ya lista para ser descrita, de la siguiente manera:
1. Se escribe el nombre de la pantalla cumpliendo con las Normas de
Redacción numeral 10.
Software Mínimo Máximo
Sistema
operativo
Windows XP professional, Windows 7,
Sistemas de
oficina
Microsoft Office Access
2003
Microsoft Office Access
2007
Dispositivos
auxiliares
Controlador de cámara
Web Cam
Controlador

(SIACE)
Pagina Elaboración
17/ 18
25/07/2016
Versión
1.0
Actualización
-
2. Se hace la descripción detalla de la funcionalidad de la pantalla.
3. Se ubica la imagen cumpliendo con las Normas de Redacción numeral
10 y 11.
4. Se identifica la figura cumpliendo con las Normas de Redacción
numeral 10.
Ejemplo:
PANTALLA INICIO DE SESIÓN
Esta representa la pantalla principal del sistema donde se refleja como entrar al
sistema.
Figura 3.INICIO DE SESIÓN
 Ingresar el nombre de Usuario
 Ingresar la contraseña
 Presione el botón “Iniciar Sesión” para ingresar al sistema.

(SIACE)
Pagina Elaboración
18/ 18
25/07/2016
Versión
1.0
Actualización
-
8. DEFINICIÓN DE TERMINOS
Es un listado alfabético de definiciones de aquellas palabras o términos utilizados en
el manual de usuario y que puedan prestarse a confusión en virtud de que no siempre
tienen la misma acepción o no son ampliamente conocidos.
Para redactarlos se recomienda ajustarse a los criterios siguientes:
 Defina con la mayor claridad y concreción posible los términos señalados en
el manual.
 Incluya los términos que se presten a confusión.
 Ordene los términos en orden alfabético.

Metodología para elaboración de Manuales de Usuarios Proyecto SIACE

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Metodología para elaboración de Manuales de Usuarios Proyecto SIACE

Similar to Metodología para elaboración de Manuales de Usuarios Proyecto SIACE (20)

Metodología para elaboración de Manuales de Usuarios Proyecto SIACE