GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

CONTENIDO

Tabla de contenido
CONTENIDO ......................................................................................................................................... 1
INTRODUCCION ................................................................................................................................... 2
EL PROCESO DE ELABORACION DE UN MANUAL ................................................................................ 2
1. Identifique el usuario del manual ............................................................................................... 3
2. Elabore las imgenes que utilizar en el manual ........................................................................ 4
3. Identifique los roles dentro del sistema...................................................................................... 6
4. Consiga los recursos informticos para elaborar el manual ....................................................... 7
5. Defina los mdulos del manual ................................................................................................... 8
6. Defina la estructura del manual .................................................................................................. 9
7. Identifique los diferentes escenarios del usuario. ...................................................................... 9
8. Identifique los posibles problemas que pueda encontrar el usuario........................................ 10
ASPECTOS A TENER EN CUENTA........................................................................................................ 10
Redaccin ...................................................................................................................................... 10
Definir el formato del manual ....................................................................................................... 11
Gestin de ttulos para PDF........................................................................................................... 11
Muestre todos los pasos y variantes de los procesos ................................................................... 12
Tipo de letra .................................................................................................................................. 12
CONTROL Y ACTUALIZACION DE LOS MANUALES ............................................................................. 13
MAS RECOMENDACIONES................................................................................................................. 13
TIPOGRAFIA RECOMENDADA ............................................................................................................ 13
PALABRAS RECOMENDADAS ............................................................................................................. 14
ESTANDAR DEL USO DE IMGENES................................................................................................... 14

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 1 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

INTRODUCCION
Esta gua presenta el proceso de elaboracin de los manuales de usuario del sistema SIGA
y los aspectos que se deben tener en cuenta para que dichos manuales sean efectivos para
el uso por parte de los usuarios del sistema en La Universidad de La Sabana.
Elaborar un manual de usuario del sistema SIGA no es solamente mostrar las pantallas y
contar lo que hace cada botn sino mostrar adems la integracin del sistema con los
procesos propios de la institucin.
Es necesario tener siempre presente que los manuales deben ser de fcil consulta, y adems
claros, completos y concretos, y mostrar todas las alternativas que se le pueden presentar
al usuario.

EL PROCESO DE ELABORACION DE UN MANUAL

El siguiente es el proceso para elaborar un manual del sistema SIGA.
1.
2.
3.
4.
5.

Identifique el usuario del manual.

Elabore las imgenes a utilizar en el manual.
Identifique los roles dentro del sistema.
Identifique y consiga los recursos informticos para la elaboracin del manual.
Defina los mdulos del sistema, ya que es probable que sea mejor elaborar un
manual general y un manual especfico por cada mdulo o funcionalidad.
6. Definir la estructura del manual, por procesos o por partes de la interfaz de usuario.
7. Identificar los diferentes escenarios del usuario.
8. Identificar posibles problemas que pueda encontrar el usuario.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 2 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

1. Identifique el usuario del manual

Observe la siguiente imagen y analcela:

Piense Qu mensaje la transmite sta imagen?

Para elaborar un manual debe tener en cuenta quien ser el usuario de ese manual en
especfico, en el caso de La Universidad de La Sabana y ms especficamente del proyecto
SIGA, se pueden tener como usuario a estudiantes, profesores, empleados administrativos,
o inclusive personas externas a la institucin, adems, pueden existir diferentes grupos
dentro de cada tipo de usuario, por ejemplo, en los estudiantes se pueden tener estudiantes
de pregrado, de postgrado o estudiantes de educacin continua externos, y puede suceder
que cada tipo de usuario tenga opciones diferentes dentro del sistema.
Otro ejemplo son los profesores de pregrado y postgrado, y a nivel de empleados
administrativos se debe tener en cuenta los permisos y mens que vern los usuarios de
acuerdo a su rol por ejemplo si es de nivel directivo.
Ahora bien, enlazando ste tema con el siguiente que es sobre el uso de imgenes, busque
en la imagen siguiente un aspecto que usted considere un error o que preferiblemente no
debera presentar.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 3 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

2. Elabore las imgenes que utilizar en el manual

Un manual es mucho mejor entre ms claro sea, y las imgenes son excelentes
herramientas para que los usuarios entiendan los procesos que realiza el software, por lo
tanto es recomendable que el manual no solamente tenga texto explicativo sino que vaya
acompaado por imgenes que le permitan al usuario tener mayor claridad de las funciones
del programa.
Para elaborar las imgenes de software generalmente se usa la funcin de impresin de
pantalla del computador, tambin conocido como Print Screen, el cual permite capturar
el pantallazo que se tenga activo en determinado momento, sin embargo existen
programas gratis que hacen esta labor un poco ms sencilla, por ejemplo permitiendo la
captura de solo una parte de la pantalla.
En caso de que solo tenga la opcin de print screen del computador, ser necesario pasarla
a algn programa de edicin para recortar la imagen y ajustarla de acuerdo a la necesidad.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 4 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

Es muy recomendable que la imagen sea bastante clara y si va a explicar una parte de la
pantalla trate de recortar solo esa seccin, observe la diferencia a continuacin:
Toda la pantalla
Parte de la pantalla

Ahora bien, si desea resaltar alguna parte de la imagen, es recomendable sealarla para
dirigir la atencin solo a esa seccin y que los usuarios entiendan la explicacin, para lo cual
existen varios mtodos como por ejemplo rodear o encerrar la seccin con un recuadro (ver
imagen anterior), o hacerla ms visible desvaneciendo el resto de la imagen, como en el
siguiente ejemplo.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 5 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

En algunos procedimientos se pueden usar las imgenes para describir pasos en un proceso,
pero se recomienda que no sean muchos pasos ya que puede sobrecargar la imagen,
observe el siguiente ejemplo:

Luego de la imagen se pueden explicar los pasos del proceso.

Ejemplo:
1. Seleccionar el texto: El primer paso es seleccionar el texto al cual desea aplicar negrilla.
2. De clic en el botn que contiene la letra N para aplicar negrilla al texto seleccionado.
Adicionalmente se recomienda:
No usar imgenes que no le aporten a las explicaciones del manual.
No olvide explicar lo que desea mostrar en la imagen.

3. Identifique los roles dentro del sistema.

Es necesario conocer y clarificar los roles que asumirn los usuarios dentro del sistema, ya
que ste aspecto le indicar los procesos, accesos y procedimientos que les correspondan,
generalmente existen tres niveles de roles:
1. Consulta
2. Edicin
3. Administracin
Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 6 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

Teniendo en cuenta los tipos de usuario y los niveles de permisos y roles es recomendable
generar los Pantallazos usando una cuenta con los permisos propios al manual que se
est desarrollando, por ejemplo, si est elaborando un manual para estudiantes, entonces
procure usar una cuenta de estudiante para crear el manual, ya que se usa una cuenta con
permisos diferentes, puede cometer el error de mostrar en las imgenes mens y opciones
de pantalla que no le correspondan.

4. Consiga los recursos informticos para elaborar el manual

Asegrese de contar con todos los recursos que necesita para la creacin del manual,
adems tenga en cuenta que si requiere elaborar de forma urgente, entonces use
herramientas que usted maneje, ya que si usa herramientas no conocidas, entonces deber
invertir tiempo adicional en el aprendizaje de la herramienta.
Puede necesitar recursos como:

Un procesador de texto verstil como Microsoft Word.

Un editor de imgenes como Paint.
Power Point para tratamiento de imgenes

Tambin existes herramientas gratis en Internet que le pueden ser tiles para realizar
acciones que pueden requerir software de pago, por ejemplo, existe la pgina
https://pixlr.com/ que le permite aplicar efectos especiales a imgenes.
Es recomendable adems tener la Plantilla que use la institucin para la elaboracin de
manuales.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 7 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

5. Defina Las secciones del manual

Es muy probable que el sistema cuente con varios mdulos o secciones, y que esos mdulos
se correspondan con funcionalidades, procesos o procedimientos, por lo tanto es
aconsejable pensar en la posibilidad de elaborar manuales individuales para cada mdulo,
ya que ste permite al usuario encontrar rpidamente lo que necesita o concentrarse en el
tema de su inters.
Puede suceder que se confunda un mdulo con las secciones de un manual, por ejemplo, si
pensamos en un manual para el estudiante, se puede analizar a la luz de los procesos que
debe realizar el estudiante en su interaccin con el sistema, por ejemplo:
Ingresar al sistema
Consultar notas
Registrar una peticin, queja o reclamo
Actualizar datos personales (si lo debe hacer)
Si la seccin del manual se ve que es un proceso ms complejo, podra dar pie a un manual
ms especfico.

Puede suceder que la unin de los manuales especficos por secciones o procesos, den como
resultado el manual completo para el tipo de usuario en cuanto al uso de todo el sistema.
Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 8 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

6. Defina la estructura del manual

La estructura del manual defina a la vez la forma que el usuario lo usar, por ejemplo, si se
define que el manual solo explique las partes del sistema entonces puede suceder que el
usuario no tenga claridad sobre los procesos, y por el contrario, si se explican los procesos
y su forma de llevarlo a cabo con el sistema, puede suceder que existan funciones
adicionales en el sistema que queden por fuera del sistema, entonces es necesario pensar
que es lo que desea la institucin que el usuario maneje de acuerdo a su rol.
Es recomendable que el manual tenga una Tabla de
contenido que le permita al usuario encontrar rpidamente
los temas.
Se pueden usar herramientas adicionales proporcionadas por
el procesador de texto como por ejemplo Tablas de ndice que le facilitan las tareas de
bsqueda de temas al usuario en el manual.

7. Identifique los diferentes escenarios del usuario.

Mientras el usuario se encuentre interactuando con el sistema se le puede presentar

diferentes situaciones y el usuario puede usar el mismo de formas diversas, por ejemplo, si
es un sistema Web, considere entonces el funcionamiento del sistema en los navegadores
ms comunes ya que puede suceder que el sistema no funcione igual en todos los
ambientes.
Igualmente considere que no todos los usuarios tienen los mismos equipos, por ejemplo
puede suceder que algunos tiene equipos con sistema operativo Windows y otros con
tecnologa Apple, lo cual obliga a revisar si es necesario hacer pantallazos para todos estos
ambientes.
De la misma forma considere si es viable y factible que los usuarios eventualmente usen
Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 9 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

otro tipo de dispositivos como equipos mviles, celulares o tabletas.

Ya desde el punto de vista tcnico, tenga en cuenta que el sistema podra exigir unos
requisitos mnimos para su correcto funcionamiento, y esto es muy importante cuando el
usuario puede llegar a usar el sistema fuera de la institucin.

8. Identifique los posibles problemas que pueda encontrar el usuario

Generalmente, cuando se elaboran manuales para los usuarios, se piensa solamente en el
funcionamiento perfecto del sistema, y no se considera las eventualidades y problemas que
pueda llegar a tener el usuario durante su interaccin con el software, por lo tanto procure
colocar en el manual una seccin de Solucin de problemas. Considere problemas como:

Qu hacer si est registrando informacin y se apaga el equipo.

Qu hacer si intenta ingresar varias veces al sistema.
Qu hacer si el sistema no muestra las opciones requeridas

Es muy probable que muchas inquietudes de los usuarios tengan que ver con procesos, por
ejemplo que tenga inhabilitada alguna opcin y tenga que ver con estados en el sistema,
o parametrizacin.

ASPECTOS A TENER EN CUENTA

Existen algunas recomendaciones que se pueden tener en cuenta para hacer que los
manuales resulten ms efectivos y sean de gran utilidad para los usuarios que los van a
utilizar, a continuacin revisaremos esas recomendaciones:

Redaccin
Es una de las recomendaciones ms importantes ya que de la redaccin depende en gran
medida que el usuario entienda lo que el manual desea explicar, por lo tanto trate de ser
claro y concreto, procure no usar palabras tcnicas si el manual est dirigido a usuarios que
no son del rea tcnica, y si es necesario usar esas palabras entonces se recomienda que el
manual tenga un glosario.
Es una buena idea que despus de escribir algo, lo muestre a otras personas para que lo
Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 10 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

valoren y revisen si lo entienden, esto le da oportunidades de mejora en la redaccin.

Tambin existe la posibilidad de contar con correctores de estilo que son personas
especializadas en redaccin, pero su servicio tiene costo adicional.

Definir el formato del manual

Actualmente, existen varias opciones de formatos para presentar manuales a los usuarios,
usualmente se disean manuales para entregarlos de forma impresa pero esto tiene
desventajas como por ejemplo el gasto de papel (no es amigable con el medio ambiente),
existen tambin formatos digitales que presentan muchas ventajas, por ejemplo el ahorro
de papel, fcil de actualizar y fcil de distribuir.
Se pueden crear los manuales en un procesador de texto que la mayora de los usuarios
manejen, como por ejemplo Microsoft Word, pero es muy recomendable que el manual
quede en varios formatos para asegurar que todos los usuarios los puedan acceder y
consultar, por ejemplo se pueden crear en Word, convertirlos adems a formato PDF y
como apoyo se puede crear una presentacin con diapositivas en el programa Microsoft
PowerPoint.
Tambin existe la posibilidad de apoyarse en otros formatos ms dinmicos como videos,
animaciones interactivas, y pginas web, pero su uso depende de la intencionalidad,
recursos de desarrollo y estrategia de capacitacin definida.

Gestin de ttulos para PDF

Es muy recomendable que los manuales tengan tabla de contenido para fcil acceso a los
temas que contiene, para crearla es necesario la creacin automtica de la tabla, y el
programa Microsoft Word, tiene esa utilidad haciendo uso de los formatos de Ttulos,
adems con sta misma herramienta se puede crear la tabla de contenido para el formato
PDF.
Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 11 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

Muestre todos los pasos y variantes de los procesos

Cuando escriba un procedimiento muestre todos los
pasos completos y variantes posibles del proceso, y
muestre y explique el resultado que debe obtener el
usuario luego de realizar el procedimiento.
Considere que generalmente un sistema puede
presentar pantallas diferentes de acuerdo a las opciones
que se seleccionen en los mens, por ejemplo puede
suceder que el usuario tenga que seleccionar entre nacional o internacional, entonces si
selecciona nacional luego puede seleccionar una ciudad, pero si selecciona internacional
podra seleccionar un pas diferente, observemos entonces que estas variantes del sistema
se deben explicar en el manual.

Tipo de letra
El tipo de letra afecta bastante a la fcil comprensin del contenido, note el siguiente
ejemplo:

Cul de las dos opciones se entiende ms?

Aunque parece que la opcin A tiene un tipo de letra ms elegante, puede que sea ms difcil
de leer y si es una gran cantidad de texto, el usuario se puede cansar, mientras que la opcin
B facilita la lectura. (Note que en ste prrafo el tipo de letra es diferente al resto del documento,
letra Georgia)

Igualmente se debe considerar el tamao de la letra, y esto afecta generalmente a usuarios

que puedan tener afectaciones visuales, trate entonces que la letra no sea ni muy pequea
ni muy grande.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 12 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

CONTROL Y ACTUALIZACION DE LOS MANUALES

Los sistemas de informacin son dinmicos y generalmente son modificados o actualizados,
por lo tanto es necesario que los manuales puedan ser adaptados a las modificaciones que
sufra el sistema e igualmente mantener informados a todos los usuarios de las
actualizaciones, para esto se manejan las versiones de los manuales y la fecha de
publicacin de la versin. Se debe procurar montar siempre la ltima versin de los
manuales en el portal del sistema.

MAS RECOMENDACIONES
1. Redactar en infinitivo, no usar tuteo, estandarizar el vocabulario, lxico.
2. Se llama SIGA, CAMPUS, mdulo de gestin acadmica, etc.?
3. Nunca asumir nada se asume que el usuario sabe que es SIGA?

TIPOGRAFIA RECOMENDADA
Para Ttulo 1
Cambria, 14, Azul, negrilla, alineacin izquierda
Para Ttulo 2
Cambria, 13, color negro, negrilla, cursiva, alineacin izquierda, numeracin lista multinivel.
Para Ttulo 3
Cambria, 11, color negro, negrilla, alineacin izquierda, numeracin lista multinivel.
Para texto normal
NOMBRE DE TIPO
Calibri
Arial
Times New Roman
Calisto (Recomendacin)
Century Gothic
Comic Sans
Georgia (Recomendacin)
Tahoma
Verdana
Elabor
Eduardo Robayo C.

TAMAO
12
12
12
12
12
12
12
12
11
Revis

EJEMPLO
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Universidad de La Sabana
Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 13 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

PALABRAS RECOMENDADAS
Clic: Describe la accin de oprimir un botn del mouse. Usar con clic derecho y clic
izquierdo, por ejemplo Haga clic con el botn derecho del mouse.
Mouse: Considerando que en el ambiente informtico internacional la palabra mouse es
ms genrica para describir ste dispositivo que la palabra ratn.
Pgina: Se recomienda usar la palabra pgina y no la palabra pantalla ya que el sistema
es en un entorno Web.
Formulario: Es el trmino estndar usado en el mbito Web, Por ejemplo Aparece el
formulario Registro de notas- .
Campo: Es el trmino estndar para la gestin de informacin en formularios, por ejemplo
seleccione el campo Nombre.
Tecla: Estndar usando para esta parte del teclado.
Combinacin de teclas: Accin de presionar varias teclas al mismo tiempo.
Oprimir: Accin de presionar, por ejemplo oprima las teclas CTRL-ALT-DEL.

ESTANDAR DEL USO DE IMGENES

Se recomienda usar las imgenes en los siguientes formatos, alineadas a la derecha del
texto explicativo del procedimiento y que se mueva con el texto, con borde:
EJEMPLO
MENU INSERTAR
Para insertar imgenes en el documento haga clic en
el men INSERTAR que se encuentra en la parte
superior de la pantalla, sta opcin habilita una barra
de herramientas que permite agregar tablas,
imgenes, imgenes en lnea (imgenes que se
pueden descargar de Internet), formas, SmartArt,
Grficos y Capturas.
Formas: Las formas son herramientas de dibujo.
SmartArt: Son estructuras prediseadas para usos de maquetacin.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 14 de 15

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA
Gua: Elaboracin de manuales de usuario
GENERAL

Versin: 1.0
Fecha: 10/Abr/2015

Si la imagen es grande, entonces se puede dejar centrada, y colocar el texto explicativo

sobre ella o debajo. Adems se sugiere aplicar la siguiente estructura para explicar pasos de
un procedimiento:

Recuerde que la imagen no debe quedar muy cargada de pasos y se deben usar textos
muy cortos, que pueden ser explicados en detalle delante de la imagen.

Elabor
Eduardo Robayo C.

Revis

Aprob
Direccin de Tecnologas y
Sistemas de informacin
Pgina 15 de 15