04 - 3 - Presentacion Manuales - Usuario
04 - 3 - Presentacion Manuales - Usuario
04 - 3 - Presentacion Manuales - Usuario
Estructura de contenidos
Pág.
Introducción........................................................................................................................3
Mapa de contenido.............................................................................................................4
1. Manual del usuario.........................................................................................................5
1.1 Componentes...............................................................................................................5
1.1.1 Alcance......................................................................................................................6
1.1.2 Requisitos de conocimiento para manejar el sistema...............................................6
1.1.3 Requerimientos de hardware y software del equipo cliente......................................6
1.1.4 Política de seguridad.................................................................................................7
1.1.5 Ingreso al sistema.....................................................................................................7
1.1.6 Mapa de navegación.................................................................................................7
1.1.7 Descripción de las funciones del sistema.................................................................7
1.1.8 Información sobre la mesa de ayuda........................................................................7
1.1.9 Descripción de los mensajes de error.......................................................................8
2. Ejercicio de creación de un manual de usuario .......................................................... 12
3. Ejercicio de creación de un manual técnico ............................................................... 26
Glosario........................................................................................................................... 31
Bibliografía...................................................................................................................... 32
Control del documento.................................................................................................... 33
Introducción
Es así como los manuales de usuario y técnico juegan un papel importante al facilitar
que el personal técnico y operativo que interactuará con el software cuente con las
herramientas y conocimientos necesarios para operarlo.
Una documentación insuficiente de la funcionalidad del sistema hará que las personas
cometan errores y generará frustración o apatía por el nuevo sistema.
Mapa de contenido
Desarrollo de contenidos
El manual del usuario busca explicar paso a paso cada una de las operaciones que se
pueden realizar en la aplicación. Es un manual ilustrativo que se construye de tal manera
que sea de fácil comprensión para los usuarios finales de la aplicación.
Del manual se espera que pueda despejar todas las dudas y que al final el usuario logre
manejar la aplicación correctamente.
1.1 Componentes
Algunos de los ítems que se deben relacionar en este manual se muestran en la figura.
1.1.1 Alcance
En este apartado se debe indicar si los usuarios que van a manejar el sistema requieren
conocimientos técnicos particulares como los que se relacionan a continuación:
• Informática básica.
• Sistemas operativos.
• C
onocer las políticas de seguridad de la institución, por ejemplo, las políticas
de ingreso, validación de usuarios y manejo de contraseñas.
Es necesario indicar las especificaciones técnicas del hardware y software que se deben
utilizar para que el sistema funcione adecuadamente en el equipo cliente de la aplicación.
Estas especificaciones ya fueron definidas en los documentos de diseño y validadas
posteriormente durante el proceso de construcción de la aplicación.
En cuanto al hardware se pueden indicar los requerimientos mínimos, los recomendados
y los óptimos.
Se debe presentar de manera muy detallada, el mapa de navegación con sus respectivos
botones y funciones. Por regla general, existe una estandarización en los botones de
la barra de menú, es por ello que en este capítulo se deben relacionar cada uno de los
botones, incluyendo, su nombre, imagen y su función.
Se debe indicar de manera general cuál será la filosofía de navegación del sistema, el
uso de los menús, botones y las recomendaciones correspondientes con el inicio y cierre
de sesiones.
En este se muestran los menús, submenús y pantallas disponibles para cada una de las
funcionalidades del sistema.
Una vez que la aplicación entra a operar se requiere que se constituya una mesa de
ayuda que se encargará de dar soporte de primer nivel a los usuarios. Generalmente una
mesa de ayuda está formada por usuarios líderes que han participado en el proyecto de
desarrollo y conocen la aplicación en detalle.
A los usuarios se le deben dar instrucciones claras de los casos en los cuales deben
acudir a la mesa de ayuda. Algunas actividades típicas de una mesa de ayuda son:
Las mesas de ayuda generalmente usan software para manejo de casos como GLPI
(http://glpi-project.org/) en lugar del correo electrónico.
Lo anterior permite que se pueda controlar la calidad del servicio de soporte técnico ya
que a los casos se les puede monitorear la fecha de solicitud, la fecha de la solución y las
intervenciones que han hecho tanto los técnicos como los usuarios.
Es importante hacer una relación de los mensajes de error que pueden surgir de la
operación de la aplicación. Además, se debe establecer una o varias acciones a seguir
de acuerdo al error.
Generalmente los errores que se presentan al capturar datos se muestran al usuario
junto con la acción correctiva, como corregir el rango de una fecha o no usar caracteres
especiales para los nombres. Sin embargo, pueden aparecer errores generados por la
plataforma o situaciones no previstas por los programadores. Es en estos casos donde la
información sobre errores es necesaria.
No Descripción Detalle
Este manual describe la funcionalidad de la aplicación
“Gestión Odontológica” que permite la asignación,
modificación y cancelación de citas del consultorio
odontológico. Para su correcto uso, seguir cuidadosamente
cada uno de los pasos que explica cada opción.
Pepito Pérez
Administrador del sistema
[email protected]
Tel 6990000 ext 1234
Móvil 315 3334455
Horario de atención: de lunes a viernes de 8 a.m. a 5 pm
Requisitos de hardware:
1. Computador con mínimo de 4 GB en RAM.
2. Espacio libre en disco de 500 MB
3. Impresora láser (para impresión de listados).
Requerimientos de
3
hardware y software Requisitos de software:
1. S
istema operativo Windows 7 o posterior, Linux
kernel 3.0 o MacOS versión 10.9 en adelante.
2. N
avegador Chrome versión 30 en adelante, Firefox
versión 20 en adelante o Safari versión 5 en adelante.
3. L
ector de archivos PDF como Acrobat Reader o
similar.
http://servidor_de_la_aplicacion/index.php
4 Ingreso al sistema
6 Mapa de navegación
Para consultar una cita hay que dar clic sobre el botón
“Consultar Cita” del menú principal. Aparecerá lo siguiente
en pantalla:
Glosario
ANS: acrónimo de Acuerdo de Niveles de Servicio. Define la política de tiempo de
respuesta y escalamiento de los casos o incidentes de soporte técnico.
GLPI: acrónimo de Gestión Libre de Parc Informatique. Software libre para al manejo de
casos o incidentes de soporte técnico.
Librería: conjunto de programas que apoyan un área específica y pueden ser usados por
los programadores en la etapa de desarrollo.
Mesa de ayuda: personal dedicado a dar soporte funcional y técnico a los usuarios de
una aplicación.
Bibliografía
Alred, G., Brusaw, C., Oliu, W. (2009). Handbook of technical writing. Boston: Bedford/
St. Martin.
IEEE Computer Society (2001). IEEE 1063-2001 Standard for Software User
Documentation. Recuperado de http://standards.ieee.org/findstds/standard/1063-2001.
html