Anlisis

para
el desarrollo
Desarrollo de
aplicaciones
mviles
con APPcon
INVENTOR.
mvil
App Inventor.

Material
Actividad de aprendizaje 4

Manuales de usuario

Material
Actividad de aprendizaje 4

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Manuales de usuario

ndice

Introduccin
1. Mtodo 1: Crea la documentacin de usuario apropiada.
2. Mtodo 2: Componentes del manual de usuario.
3. Mtodo 3: Disea un manual de usuario legible.
4. Webgrafa.

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Introduccin
Los manuales de usuario son guas escritas en formatos impresos (en papel) o
en documentos electrnicos (PDF o XPS) que proporcionan instrucciones de
cmo hacer o utilizar algo. Si bien se piensa generalmente en las guas de
usuario como manuales para programas de computacin, las guas de usuario
pueden acompaar a computadoras y a otros dispositivos electrnicos, como
televisores, estreos, sistemas telefnicos, y reproductores MP3, y tambin
pueden acompaar a electrodomsticos y equipos de jardinera.
Los buenos manuales de usuario educan al usuario acerca de las
caractersticas del producto mientras les ensean cmo utilizar esas
caractersticas de manera efectiva, y estn dispuestos de tal forma para que
puedan leerse y consultarse fcilmente. A continuacin se presentan algunas
cosas para tener en cuenta a la hora de crear un contenido efectivo y disear la
disposicin para un manual de usuario.

Material
Actividad de aprendizaje 4

Manuales de usuario

Desarrollo de aplicaciones
mviles con APP INVENTOR.

1. Mtodo 1: Crea la documentacin de usuario apropiada.

1.1 Define quin es el usuario. Para escribir un manual de usuario
exitoso, debes desarrollar un perfil de tu usuario, ya sea de manera
formal, creando un perfil escrito, o de manera informal, tomndote
el tiempo de realizar suposiciones razonables acerca de las
caractersticas del usuario. Un perfil as es til cuando formas parte
de un equipo que est escribiendo la documentacin de usuario y
tambin puede ayudar a llevar al producto en s desde un concepto
hasta su forma final. Las cosas a tener en mente cuando formas un
perfil de usuario son:
Dnde utilizarn las personas la gua de usuario, como en su
casa, en la oficina, en un lugar de trabajo remoto o en el auto. Esto
puede determinar, no slo el contenido, sino tambin el estilo que
tome el manual de usuario.
Cmo utilizarn las personas la gua de usuario. Si los usuarios
consultarn el manual pocas veces o slo para buscar informacin,
debera tener un formato como el de un documento de consulta. Si,
al principio, los usuarios consultarn el manual con frecuencia, la
seccin de consulta debera estar acompaada por una seccin
titulada Cmo empezar y por instrucciones de las tareas ms
simples para las que se utilizar el producto.

Material
Actividad de aprendizaje 4

Manuales de usuario

Material
Actividad de aprendizaje 4

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Manuales de usuario

1. Mtodo 1: Crea la documentacin de usuario apropiada.

Cunta experiencia tienen los usuarios con el producto o con otros productos similares. Si el producto es nuevo o significativamente
diferente de otros productos similares, debers incluir una explicacin de cmo es distinto comparado con otros productos y tambin
instrucciones de cmo comenzar a utilizarlo. Si el producto est relacionado con algo que frecuentemente resulta problemtico para los
usuarios, como sucede con muchos programas de computacin, debers proporcionar una informacin adecuada y detallada de una forma
entendible.

Fuente: (wikihow, 2014)

Material
Actividad de aprendizaje 4

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Manuales de usuario

1. Mtodo 1: Crea la documentacin de usuario apropiada.

A veces es inevitable utilizar trminos tcnicos, como para un programa de computacin para crear grficos que incluye grficas de
Fibonacci, adems de los grficos de barras y circulares, que son ms comunes. En ese caso, es til definir el trmino y proporcionar algo de
informacin bsica al respecto, como explicar qu es un grfico de Fibonacci y para qu se usa en el anlisis financiero.

Fuente: (wikihow, 2014)

Desarrollo de aplicaciones
mviles con APP INVENTOR.

1. Mtodo 1: Crea la documentacin de usuario apropiada.

1.3 Explica el problema que el usuario intenta resolver, y

luego presenta una solucin para dicho problema.
Ofrecer una caracterstica del producto como una solucin a un
problema comn funciona bien cuando se promociona el
producto, pero una vez que el usuario tiene el producto, ste
debe saber cmo utilizar esa caracterstica. Identifica los
problemas especficos que el usuario enfrentar, mencinalos en
la gua de usuario, y luego aade las instrucciones para
resolverlos.
Si el problema es complejo, sepralo en partes ms pequeas.
Lista cada una de las partes con las instrucciones para resolverlo
o lidiar con l, y luego agrega sucesivamente cada parte
siguiente. Romper la informacin de esta manera se llama
fragmentar.

Material
Actividad de aprendizaje 4

Manuales de usuario

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Material
Actividad de aprendizaje 4

Manuales de usuario

2. Mtodo 2: Componentes del manual de usuario.

2.1. Incluye la portada y las cartulas adecuadas.
Se deber incluir una portada para cualquier gua de
usuario mayor a una hoja de referencia, y una cartula
para cualquier manual que cubra ms que la superficie de
una hoja de papel doblada (4 o ms pginas de largo).
Si el manual est protegido por los derechos de autor,
se debe incluir un aviso de derechos de autor en la
portada y en la cartula.
Si existen trminos y condiciones para usar el manual y
el producto asociado a ste, se colocan en la portada
interior.
2.2 Se colocan referencias a las documentaciones
relacionadas en el prefacio. Si la documentacin de
usuario es ms que un solo manual, se coloca aqu las
referencias a los dems documentos, con sus nmeros
de versiones correspondientes. El prefacio tambin es el
lugar en donde colocar, si la hubiera, una seccin cmo
utilizar esta gua.

Fuente: (wikihow, 2014)

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Material
Actividad de aprendizaje 4

Manuales de usuario

2. Mtodo 2: Componentes del manual de usuario.

2.3. Si el manual excede las 10 pginas, incluye un ndice de contenidos.

Fuente: (wikihow, 2014)

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Material
Actividad de aprendizaje 4

Manuales de usuario

2. Mtodo 2: Componentes del manual de usuario.

2.4. Se colocan las instrucciones o los procedimientos y
los materiales de consulta en el cuerpo del manual.
En la mayora de los casos, los procedimientos y los
materiales de consulta tienen sus propias secciones, aunque,
dentro de una seccin, se puede indicar al usuario que
consulte un contenido especfico de la otra. De este modo, el
usuario puede encontrar ms rpidamente la informacin que
est buscando.
Los procedimientos deben escribirse con una estructura
consistente a lo largo de la seccin de instrucciones del
manual. Comienza con un resumen de la tarea, luego
describe como debe hacer el usuario y qu resultados debe
observar. Los pasos deben ser numerados y comenzar con
acciones verbales del mismo modo que estn escritos los
pasos en cada seccin de este artculo.
Los materiales de consulta pueden incluir una lista de
opciones, consejos para la resolucin de problemas, y las
preguntas ms frecuentes. Los glosarios y los ndices pueden
aadirse cerca del final del manual, aunque se puede colocar
una lista de trminos utilizados frecuentemente al principio.
Se puede omitir el ndice si el manual tiene menos de 20
pginas.

Fuente: (wikihow, 2014)

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Material
Actividad de aprendizaje 4

Manuales de usuario

2. Mtodo 2: Componentes del manual de usuario.

2.5. Se usan imgenes grficas para respaldar al texto cuando sea necesario.
Las imgenes grficas, o las capturas de pantalla pueden ilustrar algunos puntos en el manual mejor que un texto, en especial en procedimientos
complejos en los cuales el usuario necesita una confirmacin visual de que estn llevando a cabo los pasos correctamente. Las imgenes
grficas pueden crearse utilizando programas de diseo asistido por computadora (CAD, por sus siglas en ingls) o programas de diseo grfico,
cmaras digitales y programas de edicin de fotografas, o en el caso de las capturas de pantalla, se puede utilizar la funcin de captura que
viene instalada en la computadora, o un programa de manejo de grficos con una funcin de captura de pantallas.
Una vez que se haya creado una imagen grfica, se guarda en un formato tan comprimido como el procesador de textos o el programa de
autoedicin que permita utilizar. Tambin se debe reducir el tamao fsico de la imagen hasta alcanzar uno que pueda encajar ms fcilmente
en la pgina proveyendo simultneamente el detalle necesario para el usuario (de ser necesario, quizs debas separar la imagen en partes para
mostrar las partes relevantes junto al texto que respaldan).
Si se utiliza muchas imgenes grficas en los procedimientos, se hacen de un tamao consistente, ya sea en las mismas medidas de ancho
y alto o en la misma proporcin de reduccin respecto al tamao original. Esto har que las imgenes luzcan ms atractivas para el usuario. Del
mismo modo, cuando se tome capturas de pantalla en una computadora, se verifica que la computadora muestre la misma combinacin de
colores cuando se capturen las imgenes.
Aunque los programas de diseo grfico como el Photoshop o el Paint Shop Pro ofrecen funciones de captura de pantalla decentes, los
programas de captura especializados como el Snagit tambin permiten modificar, catalogar y comentar fcilmente las capturas de pantalla.

Desarrollo de aplicaciones
mviles con APP INVENTOR.

3. Mtodo 3: Se disea un manual de usuario legible.

3.1. Se escogen algunas fuentes legibles. Aunque las computadoras
permiten utilizar muchas fuentes diferentes, el objetivo de un manual de
usuario es ser fcilmente legible. Para lograr esto, lo mejor es elegir un nmero
reducido de fuentes que se vean bien juntas. Las fuentes pueden dividirse en
dos grupos: las fuentes serif y las fuentes sans serif.
Las fuentes serif tienen pequeas lneas de adorno al final de los trazos
principales que forman la letra. Algunas fuentes serif son Times New Roman,
Baskerville, y Book Antiqua. Las fuentes serif funcionan mejor en grandes
fragmentos de texto impresos en el cuerpo principal del manual de usuario en
un tamao de 10 o 12 puntos.
Las fuentes sans serif solo tienen trazos que forman las letras, sin adornos.
Algunas fuentes sans serif son Arial, Calibri y Century Gothic. Las fuentes sans
serif se pueden utilizar en grandes fragmentos de texto en tamaos de 8 a 10
puntos en un PDF o en un manual en internet, aunque la falta de serifs hace
que las oraciones escritas en tamaos de 12 puntos o ms sean difciles de
leer. Sin embargo, se pueden utilizar de manera efectiva en tamaos ms
grandes para los ttulos y encabezados, y adems son muy buenas en
tamaos ms pequeos para pies de pgina y nmeros en columnas y tablas.

Material
Actividad de aprendizaje 4

Manuales de usuario

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Material
Actividad de aprendizaje 4

Manuales de usuario

3. Mtodo 3: Se disea un manual de usuario legible.

Por lo general, se debe elegir fuentes simples

como Arial o Times New Roman para el manual de
usuario, aunque se puede elegir una fuente
decorativa para las citas apartadas o los ttulos; si
se escribe un manual de usuario para un
videojuego con una temtica fantstica o de
ciencia ficcin (en el caso de las citas al margen,
a menudo se puede utilizar alguna de las fuentes
sencillas y mostrar la cita apartada en cursiva).
Una vez que se haya elegido las fuentes que se
van a utilizar, se crea una pgina de muestra para
verificar que las fuentes se vean bien juntas en el
papel. Tambin se debe presentar esta muestra a
la persona que va ha aprobar la apariencia del
manual antes de continuar escribindolo.
Fuente: (wikihow, 2014)

Desarrollo de aplicaciones
mviles con APP INVENTOR.

Material
Actividad de aprendizaje 4

Manuales de usuario

3. Mtodo 3: Se disea un manual de usuario legible.

3.2. Se analiza bien la distribucin. Una vez que se haya elegido las fuentes del manual de usuario, se deber decidir dnde se coloca cada
cosa dentro de las pginas.
Por lo general, es conveniente que se coloque el ttulo del manual o del captulo en el encabezado o en el pie de pgina, colocndose el ttulo
del manual en la pgina izquierda y el ttulo del captulo en la pgina derecha. Tambin es conveniente que se coloque el nmero de pgina en
el encabezado o en el pie de pgina, ya sea en el lado externo (del encabezado o del pie de pgina) o en el centro (nicamente en el pie de
pgina). Es conveniente diferenciar la primera pgina de cada seccin o captulo de las otras pginas colocndose su nmero de pgina en el
centro del pie de pgina y en las pginas siguientes, se coloca en la esquina exterior del encabezado.

Es conveniente que se ubique el texto de las referencias de las imgenes en colores o en recuadros sombreados para separarlo del resto del
texto. Se asegura elegir un color o un nivel de sombreado que permita leer el texto con facilidad.
Se dejan unos mrgenes razonablemente amplios a los lados, con un espacio extra en los bordes en los cuales se vaya a unir todas las
pginas.

Desarrollo de aplicaciones
mviles con APP INVENTOR.

3. Mtodo 3: Se disea un manual de usuario legible.

3.3. Elegir el tipo de encuadernacin para el manual de usuario. Si el manual de
usuario tiene ms de 4 pginas, se hace necesario unir las pginas de algn modo.
Aunque los documentos de uso interno pueden engraparse en las esquinas, los
manuales de usuario de uso externo que se entregan con un producto pueden
encuadernarse en una de estas 3 formas:
Engrapar a los lados resulta apropiado para los manuales compuestos por hojas de
papel dobladas de 21 x 27,5 cm (8,5 x 11 pulgadas), 21 x 35 cm (8,5 x 14 pulgadas) o 27,5
x 42,5 cm (11 x 17 pulgadas). La mayora de los manuales baratos de 48 pginas o
menos se encuadernan de este modo.
Es ms comn utilizar el cosido a caballo para las guas de consulta para terceros que
para los manuales de usuario que se entregan con los productos que no sean
automviles, aunque algunas guas de usuario ms largas se encuadernan de este modo
(inicialmente, cuando JASC software produca el Paint Shop Pro, entregaban manuales
de usuario encuadernados mediante el cosido a caballo).
La encuadernacin con espirales es ms adecuada para las guas de usuario que estn
diseadas para entornos ms hostiles como en exteriores, en donde los manuales
encuadernados con grapas o cosidos a caballo se desarmaran. Algunos manuales
encuadernados con espirales tambin pueden tener pginas laminadas para evitar que
se arruine el manual si se moja o se ensucia.

Material
Actividad de aprendizaje 4

Manuales de usuario

Desarrollo de aplicaciones
mviles con APP INVENTOR.

3. Mtodo 3: Se disea un manual de usuario legible.

3.4. Armar una plantilla de documento para el manual de usuario.
Muchos procesadores de texto y programas de autoedicin ofrecen la posibilidad
de crear plantillas de documentos para los manuales de usuario, as que a
medida que se escriba, el texto se mostrar automticamente en la fuente que se
haya elegido para la parte del manual en la que se este trabajando (de hecho,
este artculo fue escrito inicialmente utilizando una plantilla de Microsoft Word).
La mayora de estos programas tambin incluyen un conjunto de plantillas
predefinidas que se puede modificar segn la necesidad, en vez de crear la
plantilla desde el comienzo.
Los procesadores de texto y los programas de autoedicin tambin ofrecen la
posibilidad de crear estilos, que son tipos y tamaos de fuente predefinidos para
los ttulos, los pies de pginas, los encabezados y el cuerpo del texto. Se puede
elegir uno de los nombres de estilo predefinidos (por ejemplo, Encabezado1,
Normal, Cita) o cree su propio estilo con su propio nombre. Si se tiene muchos
estilos para la misma clase de texto, se sigue las convenciones para los nombres
de estilo tanto como sea posible (por ejemplo, Microsoft Word llama a los estilos
de texto para los ttulos como Ttulo1, Ttulo2, etc., para todos los ttulos desde
el principal hasta varios niveles de subttulos). Se debe Intenta crear
anticipadamente todos los estilos que se pueda necesitar, as no tendr que
detenerse para crearlos mientras est escribiendo realmente el manual.

Material
Actividad de aprendizaje 4

Manuales de usuario

Desarrollo de aplicaciones
mviles con APP INVENTOR.

4. Webgrafa.
User manual bluestacks (2014). Consultado el 15 de Agosto de 2014, en
http://stackoverflow.com/questions/241422/tips-to-create-a-useful-user-manual
Articles Logical (2014). Consultado el 17 de Agosto de 2014, en
http://pubs.logicalexpressions.com/pub0009/lpmarticle.asp?id=278
manual writing (2014). Consultado el 18 de Agosto de 2014, en
http://www.asktog.com/columns/017ManualWriting.html
best user (2014). Consultado el 19 de Agosto de 2014, en
http://headrush.typepad.com/creating_passionate_users/2007/03/the_best_user_t.html
guides & tutorials (2014). Consultado el 21 de Agosto de 2014, en
http://klariti.com/technical-writing/User-Guides-Tutorial.shtml

Material
Actividad de aprendizaje 4

Manuales de usuario

Desarrollo de aplicaciones
mviles con APP INVENTOR.

5. Bibliografa.
Rodney Ruff, (2009). Over 10 years of experience in writing help files and user manuals. Omaha, USA.

Material
Actividad de aprendizaje 4

Manuales de usuario