Guia Elaboracion Manuales de Usuario

GUIA PARA ELABORACION DE MANUALES DE USUARIO

Sistema: SIGA

Guía: Elaboración de manuales de usuario Versión: 1.0

GENERAL Fecha: 10/Abr/2015

Elaboró Revisó Aprobó

Eduardo Robayo C.

Dirección de Tecnologías y

Sistemas de información

Página 1 de 15

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 imágenes que utilizará en el manual ........................................................................ 4

3. Identifique los roles dentro del sistema. ..................................................................................... 6

4. Consiga los recursos informáticos para elaborar el manual ....................................................... 7

5. Defina los módulos 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

Redacción ...................................................................................................................................... 10

Definir el formato del manual ....................................................................................................... 11

Gestión de títulos 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 IMÁGENES................................................................................................... 14


Sistema: SIGA




Eduardo Robayo C.



Página 2 de 15

INTRODUCCION Esta guía presenta el proceso de elaboración 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 botón sino mostrar además la integración del sistema con los procesos propios de la institución. Es necesario tener siempre presente que los manuales deben ser de fácil consulta, y además 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. Identifique el usuario del manual. 2. Elabore las imágenes a utilizar en el manual. 3. Identifique los roles dentro del sistema. 4. Identifique y consiga los recursos informáticos para la elaboración del manual. 5. Defina los módulos del sistema, ya que es probable que sea mejor elaborar un

manual general y un manual específico por cada módulo 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.


Sistema: SIGA




Eduardo Robayo C.



Página 3 de 15

1. Identifique el usuario del manual Observe la siguiente imagen y analícela:

Piense ¿Qué mensaje la transmite ésta imagen? Para elaborar un manual debe tener en cuenta quien será el usuario de ese manual en específico, en el caso de La Universidad de La Sabana y más específicamente del proyecto SIGA, se pueden tener como usuario a estudiantes, profesores, empleados administrativos, o inclusive personas externas a la institución, además, 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 educación 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 menús que verán 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 imágenes, busque en la imagen siguiente un aspecto que usted considere un error o que preferiblemente no debería presentar.


Sistema: SIGA




Eduardo Robayo C.



Página 4 de 15

2. Elabore las imágenes que utilizará en el manual Un manual es mucho mejor entre más claro sea, y las imágenes 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 acompañado por imágenes que le permitan al usuario tener mayor claridad de las funciones del programa. Para elaborar las imágenes de software generalmente se usa la función de “impresión de pantalla” del computador, también 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 más sencilla, por ejemplo permitiendo la captura de solo una parte de la pantalla. En caso de que solo tenga la opción de print screen del computador, será necesario pasarla a algún programa de edición para recortar la imagen y ajustarla de acuerdo a la necesidad.


Sistema: SIGA




Eduardo Robayo C.



Página 5 de 15

Es muy recomendable que la imagen sea bastante clara y si va a explicar una parte de la pantalla trate de recortar solo esa sección, observe la diferencia a continuación:

Toda la pantalla Parte de la pantalla

Ahora bien, si desea resaltar alguna parte de la imagen, es recomendable señalarla para dirigir la atención solo a esa sección y que los usuarios entiendan la explicación, para lo cual existen varios métodos como por ejemplo rodear o encerrar la sección con un recuadro (ver imagen anterior), o hacerla más visible desvaneciendo el resto de la imagen, como en el siguiente ejemplo.


Sistema: SIGA




Eduardo Robayo C.



Página 6 de 15

En algunos procedimientos se pueden usar las imágenes 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 botón que contiene la letra N para aplicar negrilla al texto seleccionado. Adicionalmente se recomienda:

No usar imágenes 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 asumirán 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. Edición 3. Administración


Sistema: SIGA




Eduardo Robayo C.



Página 7 de 15

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 imágenes menús y opciones de pantalla que no le correspondan.

4. Consiga los recursos informáticos para elaborar el manual Asegúrese de contar con todos los recursos que necesita para la creación del manual, además 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 versátil como Microsoft Word.

Un editor de imágenes como Paint.

Power Point para tratamiento de imágenes También existes herramientas gratis en Internet que le pueden ser útiles para realizar acciones que pueden requerir software de pago, por ejemplo, existe la página https://pixlr.com/ que le permite aplicar efectos especiales a imágenes. Es recomendable además tener la “Plantilla” que use la institución para la elaboración de manuales.

https://pixlr.com/


Sistema: SIGA




Eduardo Robayo C.



Página 8 de 15

5. Defina Las secciones del manual Es muy probable que el sistema cuente con varios módulos o secciones, y que esos módulos se correspondan con funcionalidades, procesos o procedimientos, por lo tanto es aconsejable pensar en la posibilidad de elaborar manuales individuales para cada módulo, ya que éste permite al usuario encontrar rápidamente lo que necesita o concentrarse en el tema de su interés. Puede suceder que se confunda un módulo 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 interacción con el sistema, por ejemplo: Ingresar al sistema

Consultar notas

Registrar una petición, queja o reclamo

Actualizar datos personales (si lo debe hacer) Si la sección del manual se ve que es un proceso más complejo, podría dar pie a un manual más específico.

Puede suceder que la unión de los manuales específicos por secciones o procesos, den como resultado el manual completo para el tipo de usuario en cuanto al uso de todo el sistema.


Sistema: SIGA




Eduardo Robayo C.



Página 9 de 15

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 institución 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 rápidamente 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 búsqueda 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 más 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 tecnología 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


Sistema: SIGA




Eduardo Robayo C.



Página 10 de 15

otro tipo de dispositivos como equipos móviles, celulares o tabletas. Ya desde el punto de vista técnico, tenga en cuenta que el sistema podría exigir unos requisitos mínimos para su correcto funcionamiento, y esto es muy importante cuando el usuario puede llegar a usar el sistema fuera de la institución.

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 interacción con el software, por lo tanto procure colocar en el manual una sección de “Solución de problemas”. Considere problemas como:

Qué hacer si está registrando información 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 opción y tenga que ver con “estados” en el sistema, o parametrización.

ASPECTOS A TENER EN CUENTA Existen algunas recomendaciones que se pueden tener en cuenta para hacer que los manuales resulten más efectivos y sean de gran utilidad para los usuarios que los van a utilizar, a continuación revisaremos esas recomendaciones:

Redacción Es una de las recomendaciones más importantes ya que de la redacción 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 técnicas si el manual está dirigido a usuarios que no son del área técnica, y si es necesario usar esas palabras entonces se recomienda que el manual tenga un glosario. Es una buena idea que después de escribir algo, lo muestre a otras personas para que lo


Sistema: SIGA




Eduardo Robayo C.



Página 11 de 15

valoren y revisen si lo entienden, esto le da oportunidades de mejora en la redacción. También existe la posibilidad de contar con “correctores de estilo” que son personas especializadas en redacción, 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 diseñan 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 también formatos digitales que presentan muchas ventajas, por ejemplo el ahorro de papel, fácil de actualizar y fácil de distribuir. Se pueden crear los manuales en un procesador de texto que la mayoría 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 además a formato PDF y como apoyo se puede crear una presentación con diapositivas en el programa Microsoft PowerPoint. También existe la posibilidad de apoyarse en otros formatos más dinámicos como videos, animaciones interactivas, y páginas web, pero su uso depende de la intencionalidad, recursos de desarrollo y estrategia de capacitación definida.

Gestión de títulos para PDF Es muy recomendable que los manuales tengan tabla de contenido para fácil acceso a los temas que contiene, para crearla es necesario la creación automática de la tabla, y el programa Microsoft Word, tiene esa utilidad haciendo uso de los formatos de Títulos, además con ésta misma herramienta se puede crear la tabla de contenido para el formato PDF.


Sistema: SIGA




Eduardo Robayo C.



Página 12 de 15

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 menús, 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 podría seleccionar un país 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 fácil comprensión del contenido, note el siguiente ejemplo:

¿Cuál de las dos opciones se entiende más? Aunque parece que la opción A tiene un tipo de letra más elegante, puede que sea más difícil de leer y si es una gran cantidad de texto, el usuario se puede cansar, mientras que la opción B facilita la lectura. (Note que en éste párrafo el tipo de letra es diferente al resto del documento,

letra Georgia)

Igualmente se debe considerar el tamaño de la letra, y esto afecta generalmente a usuarios que puedan tener afectaciones visuales, trate entonces que la letra no sea ni muy pequeña ni muy grande.


Sistema: SIGA




Eduardo Robayo C.



Página 13 de 15

CONTROL Y ACTUALIZACION DE LOS MANUALES Los sistemas de información son dinámicos 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 publicación de la versión. Se debe procurar montar siempre la última versión de los manuales en el portal del sistema.

MAS RECOMENDACIONES 1. Redactar en infinitivo, no usar tuteo, estandarizar el vocabulario, léxico. 2. Se llama SIGA, CAMPUS, módulo de gestión académica, etc.? 3. Nunca asumir nada… se asume que el usuario sabe que es SIGA…?

TIPOGRAFIA RECOMENDADA Para Título 1 Cambria, 14, Azul, negrilla, alineación izquierda Para Título 2 Cambria, 13, color negro, negrilla, cursiva, alineación izquierda, numeración lista multinivel. Para Título 3 Cambria, 11, color negro, negrilla, alineación izquierda, numeración lista multinivel. Para texto normal

NOMBRE DE TIPO TAMAÑO EJEMPLO

Calibri 12 Universidad de La Sabana

Arial 12 Universidad de La Sabana

Times New Roman 12 Universidad de La Sabana

Calisto (Recomendación) 12 Universidad de La Sabana

Century Gothic 12 Universidad de La Sabana Comic Sans 12 Universidad de La Sabana Georgia (Recomendación) 12 Universidad de La Sabana

Tahoma 12 Universidad de La Sabana

Verdana 11 Universidad de La Sabana


Sistema: SIGA




Eduardo Robayo C.



Página 14 de 15

PALABRAS RECOMENDADAS Clic: Describe la acción de oprimir un botón del mouse. Usar con clic derecho y clic izquierdo, por ejemplo “Haga clic con el botón derecho del mouse”. Mouse: Considerando que en el ambiente informático internacional la palabra “mouse” es más genérica para describir éste dispositivo que la palabra “ratón”. Página: Se recomienda usar la palabra página y no la palabra “pantalla” ya que el sistema es en un entorno Web. Formulario: Es el término estándar usado en el ámbito Web, Por ejemplo “Aparece el formulario –Registro de notas- “. Campo: Es el término estándar para la gestión de información en formularios, por ejemplo seleccione el campo “Nombre”. Tecla: Estándar usando para esta parte del teclado. Combinación de teclas: Acción de presionar varias teclas al mismo tiempo. Oprimir: Acción de presionar, por ejemplo “oprima las teclas CTRL-ALT-DEL”.

ESTANDAR DEL USO DE IMÁGENES Se recomienda usar las imágenes 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 imágenes en el documento haga clic en el menú INSERTAR que se encuentra en la parte superior de la pantalla, ésta opción habilita una barra de herramientas que permite agregar tablas, imágenes, imágenes en línea (imágenes que se pueden descargar de Internet), formas, SmartArt, Gráficos y Capturas. Formas: Las formas son herramientas de dibujo. SmartArt: Son estructuras prediseñadas para usos de maquetación.


Sistema: SIGA




Eduardo Robayo C.



Página 15 de 15

Si la imagen es grande, entonces se puede dejar centrada, y colocar el texto explicativo sobre ella o debajo. Además 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.

Documents

Guia Elaboracion Manuales de Usuario