Clasificación y organización de elementos.

MANUAL
TÉCNICO

1.0
sión
Ver

MANUAL DEL
USUARIO Y TÉCNICO
 MANUAL DEL
USUARIO Y TÉCNICO

MANUALES
MANU DE LA APLICACIÓN

INTRODUCCIÓN.

Para trabajar este tema, es fundamental tomar como referente el término Manual, donde
la Real Academia de la Lengua lo define, Manual , Libro en que se compendia lo más
sustancial de una materia, aunque nosotros no hablamos de materia, como tal, este
término si es aplicado a nuestro Sistema de Información, “Compendio de lo más sustancial
de nuestro sistema de información”

En este objeto de aprendizaje se relacionaran algunos de los aspectos básicos que se

deben tener en cuenta al momento de construir el manual de usuario y el manual técnico.
 MANUAL DEL
USUARIO Y TÉCNICO

ESTRUCTURA DE CONTENIDOS
ESTRU

1. 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
2. MANUAL TÉCNICO
2.1. Componentes
2.1.1. Objetivos general y especificos
2.1.2. Contenido técnico
2.1.2.1. Descripción de los procesos
2.1.2.2. Descripción de campos requeridos por pantalla
2.1.3. Plataforma de usuario.
2.1.4. Interfaz Gráfica
2.1.4.1. Mapa de navegación
2.1.4.2. Descripción paso a paso

BIBLIOGRAFÍA
GLOSARIO
CRÉDITOS
 MANUAL DEL
USUARIO Y TÉCNICO
Clasificación y organización de elementos

MAPA DE CONTENIDO
 MANUAL DEL
USUARIO Y TÉCNICO

DESARROLLO DE CONTENIDO

1. MANUAL DE USUARIO

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.

n 1.0
sió
Ver

1.1. Componentes

Algunos de los ítems que se deben relacionar 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 correctamete.

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:

• 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.

 MANUAL DEL
USUARIO Y TÉCNICO

1.1.3. Requerimientos de hardware y software

Es necesario indicar las especificacio-

nes técnicas del hardware y software
que se deben utilizar para que el siste-
ma funcione adecuadamente, estas
especificaciones ya fueron definidas
en los documentos de diseño y valida-
das posteriormente durante el proce-
so de construcción de la aplicación.
En cuanto al Hardware se pueden
indicar los requerimientos mínimos,
los recomendados y los óptimos.

En cuanto a los requerimientos de

Software, se debe aclarar si hay limita-
ciones en cuanto al sistema operativo,
el gestor de bases de datos (Se debe
mencionar el SMBD en el que se cons-
truyó la base de datos de la aplica-
ción) y las demás herramientas nece-
sarias para el buen funcionamiento
del Sistema de Información, un ejem-
plo de estas herramientas adicionales
podía ser la máquina virtual de JAVA,
para el caso de las aplicaciones desa-
rrolladas en JAVA.

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.
 MANUAL DEL
USUARIO Y TÉCNICO

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 informació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.

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.

1.1.4.3. Mapa de navegación

 MANUAL DEL
USUARIO Y TÉCNICO

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 incor-
porar algunos ejemplos, puede ser presentada por módulos o perfiles de usuario.
MANUAL DEL
USUARIO Y TÉCNICO
MANUAL DEL
USUARIO Y TÉCNICO
 MANUAL DEL
USUARIO Y TÉCNICO

2. MANUAL TÉCNICO

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 posibili-
tar el mantenimiento de la misma, es importan-
te plantear el objetivo de la multimedia y
describir el problema que se pretende resolver
o la necesidad que se piensa suplir.

En este documento se debe presentar una

breve descripción de la multimedia desarrolla-
da, que contemple el contexto, estructura o
módulos que la componen, muchos de los
ítems de este documento son basados en algu-
nos de los docuemntos que se han ido traba-
jando a lo largo de este proceso de formación,
como por ejemplo, el story board, diseño gráfi-
co, usabilidad y accesabilidad, casos de uso,
navegación, fallos posibles, entre otros.

2.1. Componentes

Algunos de los componentes de este documento son:

2.1.1. Objetivos general y especificos

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.2.Contenido técnico

2.1.2.1. Descripción de los procesos

En este ítem, se describen los procesos a los cuales va a apoyar la multimedia, general-
mente 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 reque-
rimientos funcionales.
 MANUAL DEL
USUARIO Y TÉCNICO

ja a partir de contenido estático es decir al momento que un usuario solicita un contenido a

partir de un enlace o un botón este contenido es siempre el mismo, mientras que el contenido
dinámico, de acuerdo al momento y al requerimiento del usuario la información cambia o es
actualizada mediante los contenidos almacenados en la base de datos.
 MANUAL DEL
USUARIO Y TÉCNICO

2.1.2.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.3. 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 multime-
dia 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 XXX, los cuales trabajan sobre el sistema operativo XXX y
posteriores.

2.1.4. 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 y 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 multmedia.

2.1.4.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 mues-
tran los menús, submenús y pantallas a las que los lleva cada uno de ellos.

2.1.4.2. Descripción paso a paso

Describe paso a paso los procesos, así como pantallas, botones, cuadros de texto, panta-
lla, botón, etc. es decir, se muestra lo que hay detrás de la interfaz del usuario.
 MANUAL DEL
USUARIO Y TÉCNICO

Glosario

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 mas robustos que otros, pero que cumplen con el
objetivo de estar almacenados para su consulta.

Caché: Hace referencia a un sistema de buffer 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 inclu-
sión igualitaria en la sociedad

Dominio: Se define como el nombre con el cual se accede a un contenido en internet. Los nom-
bres 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 esta 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úcleo o core, de acuerdo al software que se este 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

 MANUAL DEL
USUARIO Y TÉCNICO

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, arrendamiento o cualquier figura de terceriza-
ción que genere violación a las políticas aceptadas en ese tipo de licencia.

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 solici-
tarle 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 garanti-
zarle al usuario una experiencia positiva en cuanto a usabilidad y accesabilidad.

Navegación: Es la acción de interactuar con un dispositvo que pueda recuperar una información
en el formato que este disponible, mediante una herramienta de navegación como el navegador
o software web. (Internet explorer, Mozilla Firefox, Google chrome, etc)

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 mar-
nera reemplaza a las direcciones ip, por nombres y permite 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, a diferencia del código html que traba
 MANUAL DEL
USUARIO Y TÉCNICO

Recursos Bibliográficos MANUAL DEL

EcuRed Conocimiento con todos y para todos, Recuperado 2013, 26 de noviembre, Disponible
en: http://www.ecured.cu/index.php/Manual_de_usuario

Manual_de_usuario. Recuperado 2013, 26 de noviembre. Disponible en www-bilib.es

Clasificación
ClasificaciónYyOrganización
organización De
de elementos.
Elementos.
 MANUAL DEL
USUARIO Y TÉCNICO

Control De Documento.
Construcción Objeto De Aprendizaje.
Clasificación Y Organización De Elementos

Experto temático: Magda Milena García Gamboa.

Asesor pedagógico: Luis Antonio Suárez Martínez.

Maria Teresa Camargo Serrano.

Producción Multimedia: John Fredy Garavito.

Programador: Roberto Chajin Ortíz.

Líder expertos temáticos: Tatiana Acosta Patiño.

Líder línea de producción: Santiago Lozada Garcés.

cc $ Atribución, no comercial, compartir igual

Este material puede ser

distribuido, copiado y exhibido
por terceros si se muestra en los
créditos. No se puede obtener
ningún beneficio comercial y las
obras derivadas tienen que estar
bajo los mismos términos de
licencia que el trabajo original. cc
Creative Commons

Firefox® es una marca registrada de Mozilla Foundation en

los Estados Unidos y / o en otros países.

R
 ClasificaciónYyOrganización
Clasificación organización De
de elementos.
Elementos.
USUARIO Y PROGRAMADOR
MANUAL DEL

.0
i ó n1
s
Ver