• Author / Uploaded
• duvan

Citation preview

Manual de usuario 1.1

Componentes

1.1.1 Objetivo 1.1.2 Requisitos de conocimiento para manejar el sistema 1.1.3 Requerimientos de hardware y software 1.1.4 Estructura del software y reglas básicas para moverse en la aplicación 1.1.4.1 Ingreso al sistema 1.1.4.2 Interfaz gráfica 1.1.4.3 Mapa de navegación 1.1.4.4 Descripción 1.2 Consejos prácticos para crear manual de usuario 1.2.1 Establecer la documentación de usuario apropiada 1.2.2 Elementos del manual de usuario 1.2.3 Diseño de material de usuario legible

2.

Manual técnico

2.1 Componentes 2.1.1 Introducción 2.1.2 Objetivos general y específicos 2.1.3 Contenido técnico 2.1.3.1 Descripción de los procesos 2.1.3.2 Descripción de campos requeridos por pantalla 2.1.4 Plataforma de usuario 2.1.5 Interfaz gráfica 2.1.5.1 Mapa de navegación 2.1.5.2 Descripción paso a paso

Introducción al recurso educativo digital Para el desarrollo de cualquier aplicación es necesario contar con determinados manuales obligatorios para especificar el trabajo, tanto a nivel de usuario como a nivel técnico. Es por ello que se debe comprender en su contexto la palabra “manual” definida por la Real Academia de la lengua Española como un libro que contiene lo más sustancial de una materia, también como libro o cuaderno que sirve para hacer apuntes, y es allí en realidad donde aplica para la producción multimedia, ya que a través del proceso de construcción se observan, recopilan y apuntan los requerimientos básicos necesarios de funcionamiento y desarrollo del mismo; en busca de producir con estos datos un material que sirva de apoyo para dudas e inquietudes que pueda presentar los diferentes tipos de usuario. Este objeto de aprendizaje busca relacionar los aspectos básicos que debe tener en cuenta al momento de construir dichos manuales.

1.

Manual de usuario

en este manual son: 1.1.1 Objetivo Realizar un documento que sirva de guía al usuario, en el que se muestren las diferentes funcionalidades de la aplicación y que este logre manipular la herramienta correctamente. 1.1.2 Requisitos de conocimiento para manejar el sistema En este apartado se deben indicar si los usuarios que van a manejar el sistema, requieren conocimientos técnicos particulares, como algunos de los que se listan a continuación:

Este manual busca explicar paso a paso cada una de las operaciones que se pueden realizar en la aplicación, es un manual muy gráfico, con lenguaje de fácil interpretación; y se construye de tal manera, que sea de fácil comprensión para los “usuarios finales” de la aplicación. Se espera despejar todas las dudas del lector y que al final el usuario logre manejar la aplicación correctamente. 1.1 Componentes Algunos de los ítems que se deben relacionar

• Informática básica. • Sistemas operativos. • Conocer las políticas de seguridad de la institución como por ejemplo, las políticas de ingreso, validación de usuarios y manejo de contraseñas. • Estos también se pueden estructurar por perfiles de usuario. 1.1.3 Requerimientos de Hardware y Software Es necesario indicar las especificaciones técnicas del Hardware y Software que se deben utilizar para que el sistema funcione adecuadamente, estas es-

pecificaciones 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 indi car los requerimientos mínimos, los re-

ción, para cada uno de los usuarios que se tengan contemplados, teniendo siempre presente el manejo de las políticas de seguridad de la información.

En los requerimientos de Software, se debe aclarar si hay limitaciones en el sistema operativo, el gestor de bases de datos (Se debe mencionar el SMBD en el que se construyó la base de datos de la aplicación) y las demás herramientas necesarias para el buen funcionamiento del sistema de información, un ejemplo de estas herramientas adicionales podría ser la máquina virtual de JAVA, para el caso de las aplicaciones desarrolladas en JAVA.

1.1.4.3

comendados y los óptimos.

1.1.4.2 Interfaz gráfica En este capítulo se representa todo lo referente a la parte visual del aplicativo, con aspectos como, el mapa de navegación, la descripción del mismo y la descripción paso a paso de cada uno de los formularios que se manejan en el aplicativo. Mapa de navegación

Si el cliente, maneja varias versiones de sistemas operativos se debe dejar estipulado lo necesario para realizar la instalación y configuración sobre cada una de las versiones de sistemas operativos. 1.1.4 Estructura del software y reglas básicas para moverse en la aplicación 1.1.4.1 Ingreso al sistema Se debe explicar detalladamente la forma de ingresar al sistema de informa-

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 cual 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. 1.1.4.4 Descripción Describe paso a paso los procesos, con sus respectivas pantallas, se recomienda incorporar algunos ejemplos, puede ser presentada por módulos o perfiles de usuario. 1.2 Consejos prácticos para crear manual de usuario 1.2.1 Establecer la documentación de usuario apropiada • Definir quién es el usuario: Determinar que el perfil del lector del manual permite globalizar el contenido, formato y estilo del mismo. • Escribir para ayudar: El objetivo principal del manual es orientar al lector, por tal razón es importante manejar lenguaje sencillo y comprensible, mantener al mínimo e inclusive nulo el uso de lenguaje técnico, si es necesario se debe

ofrecer una breve explicación del término o hacer uso de abreviaturas o nomenclaturas para contextualizar al lector. • Explica el problema para ofrecer una solución: Al desarrollar el producto se puede detallar los posibles problemas que se presentarán al momento de manipular la aplicación, estos se deben mencionar y ofrecer el proceso para solucionar. 1.2.2 Elementos del manual de usuario • Portada y caratulas adecuadas: Es importante agregar portada al manual para contextualizar al lector y mencionar avisos importantes como nombre del proyecto, imagen alusiva, derechos de autor, los términos y condiciones, correo y teléfonos de contacto, etc. • Usar referencias relacionadas: Para los casos en que el material requiere de explicaciones extensas o confusas es necesario realizar referencias a otros materiales que puedan servir de apoyo o base para dominar la información. • Extensión del documento: La extensión del documento determina su accesibilidad, razón por la que si este tiene más de diez páginas es necesario hacer uso del índice de contenido. • Cuerpo del material: La estructura de los contenidos facilita o dificulta la

consulta dentro del manual, es por ello que se recomienda incluir instrucciones, procedimientos y materiales de consulta genéricos en el cuerpo del material y en secciones diferentes, los temas específicos o particulares. • Imágenes o gráficas representativas: Para explicaciones puntuales o complejas del producto es necesario utilizar imágenes para respaldar el texto, lo que genera un aspecto atractivo y claro mejorando la comprensión del lector. 1.2.3 Diseño de material de usuario legible • Aplicación de fuente legible: Se recomienda el uso de tipos de letra claras, sin trazos ni decorados adicionales como lo son Arial, Times New Roman, Baskerville con tamaño 10 o 12. Estos hacen ver el texto sencillo, limpio y poco recargado. • Distribución apropiada: El orden de presentación facilita la observación de la información por tanto es necesario definir el uso adecuado de títulos, subtítulos, encabezado y pie de página, referencias, paginación, tabulados, sombreados y bordes. • Encuadernación: De acuerdo a la cantidad de páginas del manual se debe definir el tipo de encuadernación dentro de las cuales se tiene el engrapado convencional, encuadernación con espiral,

grapado en lomo, wire-o entre otros. • Herramientas de procesadores: La galería de estilos que ofrecen los procesadores de texto son útiles para ahorrar tiempo y ofrecer un aspecto atractivo e impactante al documento.

2.

Manual técnico

tende resolver o la necesidad que se piensa suplir. En este documento se debe presentar una breve descripción de la multimedia desarrollada, que contemple el contexto, estructura o módulos que la componen, muchos de los ítems de este escrito son basados en algunos de los documentos que se han ido trabajando a lo largo de este proceso de formación, como por ejemplo, el storyboard, diseño gráfico, usabilidad y accesabilidad, casos de uso, navegación, fallos posibles, entre otros. 2.1 Componentes Algunos de los componentes necesarios de este documento son: 2.1.1 Introducción Contiene una descripción breve de la multimedia desarrollada, define su función principal e incluye las diferentes partes que componen la aplicación. 2.1.2 Objetivos general y específicos Se debe de describir el objetivo general de la multimedia y los objetivos específicos que se cumplieron con el desarrollo de la misma. 2.1.3 Contenido técnico Para este contenido se debe definir con antelación el alcance que tendrá dicho manual, evitar el uso de adjetivos calificativos (bonito, excelente, bueno, etc.), tener clara la estructura de presentación de información y los esquemas a utilizar dentro de la explicación.

Este manual va dirigido al área de soporte técnico de la organización o a quien haga sus veces, ya que en él se detallan aspectos sobre la estructura de la multimedia que le permitirá entender su funcionamiento global y posibilitar el mantenimiento de la misma, es importante plantear el objetivo de la multimedia y describir el problema que se pre-

2.1.3.1 Descripción de los procesos En este ítem, se describen los procesos a los cuales va a apoyar la multimedia, generalmente en el levantamiento de los requerimientos con el cliente se debe realizar un mapa de procesos de la empresa; o se puede seleccionar algunos de los diagramas ilustrativos de los requerimientos como pueden ser el diagrama de casos de uso o una lista de requerimientos funcionales.

XXX, los cuales trabajan sobre el sistema operativo XXX y posteriores. Dentro de dichos procesos se debe tener en cuenta: • Contenido estático: Es aquel que a la solicitud del usuario ya sea por medio de un botón o enlace, su contenido es el mismo. • Contenido dinámico: Es aquel que a la solicitud del usuario ya sea por botón o enlace, el contenido cambia por actualización por ejemplo los datos almacenados en una base de datos. 2.1.3.2 Descripción de campos requeridos por pantalla Debe explicar los campos que utilizan en cada formulario, anexar la presentación de cada una de las pantallas. 2.1.4 Plataforma de usuario En este numeral se relacionan las diferentes herramientas utilizadas para el desarrollo de la multimedia, el software que fue usado, la versión, en el caso de trabajar con multimedia de tipo online, el lenguaje de programación, el sistema manejador de bases de datos, las librerías, y todas las herramientas necesarias para que la multimedia funcione correctamente. Un ejemplo podría ser: El proyecto fue desarrollado en lenguaje XXX interactuando con el gestor de bases de datos

2.1.5 Interfaz gráfica En este capítulo se representa todo lo referente a la parte visual de la multimedia, todo desde el punto de vista técnico, de diseño y no desde el punto de vista del usuario, con aspectos como, el mapa de navegación, la descripción del mismo y la descripción paso a paso de cada una de las pantallas que se manejan en la multimedia. 2.1.5.1 Mapa de navegación Muestra a partir de una gráfica la relación con cada uno de las pantallas de la aplicación, esto permite saber cómo llegar a determinada parte de la multimedia. En este se muestran los menús, submenús y pantallas a las que los lleva cada uno de ellos. 2.1.5.2 Descripción paso a paso Describe paso a paso los procesos, así como pantallas, botones, cuadros de texto, pantalla, botón, etc. es decir, se muestra lo que hay detrás de la interfaz del usuario.

LÍNEA DE PRODUCCIÓN PROGRAMA NOMBRE DEL OBJETO DISEÑADORES GRÁFICOS PROGRAMADORES

GUIONISTAS-PRODUCTOR DE MEDIOS AUDIOVISUALES ASESORA PEDAGÓGICA LÍDER DE LA LÍNEA DE PRODUCCIÓN

Producción de Multimedia Guía elaboración manual del usuario y técnico Luis Carlos Reyes Parada Caren Xiomara Carvajal Pérez Julián Alberto Camargo Fonseca Nilda Inés Camargo Suescún Nancy Astrid Barón López Milady Tatiana Villamil Castellanos John Freddy Vargas Barrera Dolly Esperanza Parra Lozano Jheison Edimer Muñoz Ramírez Janet Lucía Villalba Triana Shirley Andrea Ovalle Barreto Zulma Yurany Vianchá Rodríguez

EXPERTOS TEMÁTICOS EXPERTOS TEMÁTICOS Versión 1: Magda Milena García Versión 2: Sandra Aydeé López Contador (2017)

FAVA - Formación en Ambientes Virtuales de Aprendizaje SENA - Servicio Nacional de Aprendizaje

9

FAVA - Formación en Ambientes Virtuales de Aprendizaje

SENA - Servicio Nacional de Aprendizaje

10

Accesabilidad: Posibilidad de acceso, en la cual se contempla tanto la posibilidad de acceder a un contenido por personas con limitaciones individuales, discapacidades, dominio del idioma, o limitaciones derivadas del contexto de acceso como software o hardware. Arquitectura de la información: Es definida como el arte y la ciencia de organizar espacios de información con el fin de ayudar a los usuarios a satisfacer sus necesidades de información. La actividad de organizar comporta la estructuración, clasificación y rotulado de los contenidos de la multimedia. Base de datos: Sistema estructurado que permite la escritura, almacenamiento y consulta de datos. Generalmente los datos están relacionados o construidos bajo un mismo contexto. Existen varios gestores de bases de datos, algunos más robustos que otros, pero que cumplen con el objetivo de estar almacenados para su consulta.

Caché: Hace referencia a un sistema de bu5er para alojar información de consulta continua para tenerla disponible cuando se acceda nuevamente y reduzca el consumo de ancho de banda y a su vez reduzca el tiempo y peso de carga de una página web. Discapacidad: También llamada incapacidad, es la condición que presentan algunas personas con deficiencias físicas, materiales o mentales, que presentan obstáculos para gozar de una inclusión Igualitaria en la sociedad. Dominio: Se define como el nombre con el cual se accede a un contenido en internet. Los nombres de dominio resuelven la conexión al servidor mediante los DNS (Domain Name System), que son el sistema de traducción de una nombre a una IP, ya que internet está construido a partir de direcciones IP, sin embargo es más fácil recordar un nombre que un número además que existen servidores con IP compartida entonces se limitaría el crecimiento de las páginas web. Extensiones: Gramaticalmente hace referencia a extenderse, orientado a los cms, son trozos de código complementando una función inicial o creando una nueva, orientado a trabajar bajo un nú-

FAVA - Formación en Ambientes Virtuales de Aprendizaje

cleo o core, de acuerdo al software que se esté manejando, por tanto extiende su función o alcance inicial. GPL: General Public Licence ó su traducción en español, Licencia Publica General, es la licencia mediante la cual se distribuye el desarrollo o software de código abierto en todo el mundo. Su filosofía se basa en la protección de los derechos del usuario, usar, compartir, estudiar y modificar. GNU: Es otra manera de referirse a la licencia GPL. Hosting: Es el servicio de alojamiento de archivos en un servidor para ser accesados mediante internet. Licencia: Se define como el contrato legal, donde se especifican los derechos de uso de algo, en el caso del software existen licencias Open Source como la GPL o GNU que determinan el uso libre de desarrollos de código abierto, al igual que existen licencias de paga para software propietario, que permiten el uso pero no la distribución, venta, arrenda-miento o cualquier tercerización que ge-nere violación a las políticas aceptadas en ese tipo de licencia.

SENA - Servicio Nacional de Aprendizaje

11

Mapa del sitio: Es un listado de las páginas accesibles de una página web completa. Esta lista contiene los hipervínculos a cada una de las páginas. Menú de navegación: Es lo que permite a un usuario interactuar con la multimedia, revisar y solicitarle información en el momento que considere pertinente, la recomendación es que el menú siempre este en el mismo lugar, y conserve la misma apariencia visual, esto con el fin de garantizarle al usuario una experiencia positiva en cuanto a usabilidad y accesabilidad. Navegación: Es la acción de interactuar con un dispositivo que pueda recuperar una información en el formato que esté disponible, mediante una herramienta de navegación como el navegador o software web. (Internet explorer, Mozilla Fi-refox, Google chrome, etc)

acceder a una información alojada en un servidor. Sql: Es un sistema de gestión de base de datos, multiusuario, distribuido bajo la licencia GNU o GPL, también existe una versión de paga para los proyectos corporativos. Servidor: En el escenario de internet, el servidor actúa como un ente que provee servicios a otros entes, en este caso usuarios. Como alojamiento de archivos. Php: Es un lenguaje de programación de código del lado del servidor diseñado especialmente para ambiente web con desarrollo de contenido dinámico,

Usabilidad: Hace referencia a la facilidad de uso de cualquier herramienta creada por mano de obra de humanos para el uso de humanos. Url: En inglés uniform resource locator, es un sistema de cadena de caracteres que de alguna manera reemplaza a las direcciones ip, por nombres y permite

FAVA - Formación en Ambientes Virtuales de Aprendizaje

SENA - Servicio Nacional de Aprendizaje

12

Definicion.de. (2017). Manual de Usuario. Recuperado de https://definicion.de/manual-de-usuario/ Scribd. (2010). Guia Manual Tecnico Distribuido. Recuperado de https://es.scribd.com/document/290685524/Guia-Manual-Tecnico-Distribuido Slideshare. (2011). Manuales de Usuario y Tecnico. Recuperado de https://es.slideshare.net/Dolphinus/manuales-de-usuario-y-tecnico Real Academia Española. (s.f.). manual. Recuperado de http://dle.rae.es/?id=OHuzGA3 Wiki How. (s.f.). Como hacer un manual de usuario. Recuperado de http://es.wikihow.com/hacer-un-manual-de-usuario

FAVA - Formación en Ambientes Virtuales de Aprendizaje

SENA - Servicio Nacional de Aprendizaje

13