Directrices de autoría de hojas de apuntes
Las hojas de apuntes y las hojas de apuntes compuestas permiten a un usuario conseguir un objetivo completando una
secuencia de pasos. Estas directrices indican cuándo utilizar las hojas de apuntes y la mejor manera de escribir una hoja de apuntes.
Cuándo crear hojas de apuntes
Las hojas de apuntes son muy adecuadas para tareas que constan de pasos que
conducen a un objetivo tangible, como por ejemplo a la construcción de una aplicación
simple. El objetivo debe estar bien definido para que el usuario
pueda ver el éxito de la operación cuando se hayan realizado todos los pasos de la hoja de apuntes. Las guías de
aprendizaje son a menudo buenas candidatas a hojas de apuntes, en una guía de aprendizaje, el objetivo es realizar una
tarea específica. Las hojas de apuntes contienen normalmente hasta 10 pasos y pueden realizarse en media hora o menos.
Para tareas más prolongadas, considere la posibilidad de utilizar una hoja de apuntes compuesta.
Cuándo crear hojas de apuntes compuestas
Las hojas de apuntes compuestas se utilizan para guiar al usuario a través de una tarea demasiado larga para
describirla en una sola hoja de apuntes o que tiene varios objetivos. Una hoja de apuntes compuesta puede utilizarse
para describir una secuencia de tareas en la que cada una se basa en la precedente.
Cuándo no utilizar hojas de apuntes
Las hojas de apuntes funcionan mejor cuando un problema puede resolverse a través de una secuencia de pasos simples. Las hojas de apuntes no son un sustituto del sistema de ayuda que permite la creación de páginas HTML con gráficos
enriquecidos y acceso aleatorio a la información mediante la búsqueda y los hiperenlaces. Las hojas de apuntes no están
pensadas para las tareas en las que es necesario que el usuario introduzca mucho texto.
Directrices para crear una hoja de apuntes
- Elija un título breve y significativo.
- Utilice enlaces al sistema de ayuda en las tareas de la hoja de apuntes siempre que sea posible para proporcionar
contexto o información más detallada
- Considere la posibilidad de reescribirla como hoja de apuntes compuesta si hay más de 10 pasos.
- Utilice mandatos siempre que sea posible para realizar tareas tediosas simples como por ejemplo abrir
perspectivas, abrir recursos o ejecutar asistentes. Asegúrese también de proporcionar una descripción de cómo conseguir
el mismo efecto sin utilizar el mandato.
- Asegúrese de que los mandatos puedan saltarse si el usuario decide seguir los pasos manualmente
- Especifique dialog="true" para los pasos que abren diálogos. Esto hará que la hoja de apuntes se abra
en una "bandeja" a la derecha de la mayoría de diálogos.
- Organice los pasos de forma que el usuario vea frecuentemente signos de éxito. Una hoja de apuntes que hace
varios cambios en el código fuente Java y que después lanza una aplicación puede reescribirse de forma que la
aplicación se lance después de cada cambio del código fuente.
- Asegúrese de que el usuario entiende por qué está realizando cada paso.
- En lugar de describir varias formas de realizar un paso, elija la más simple y que necesite una descripción
más reducida.
- Utilice códigos de salto de línea (<br/>) para mejorar la legibilidad.
- Pueden utilizarse subelementos para dividir los pasos en pasos más pequeños.
- No todas las hojas de apuntes requerirán subelementos.
- Inicie el texto de la etiqueta del subelemento utilizando una palabra de acción como por ejemplo
"Entrar", "Expandir",
"Seleccionar", etc
- Para las etiquetas de subelemento, identifique con claridad el texto utilizando comillas para permitir que los
usuarios diferencien el texto de la instrucción del texto de la interfaz que deben localizar y con el que deben
interactuar.
- Cada subelemento debe ser responsable de una tarea atómica como por ejemplo entrar un valor.
- Añada siempre un elemento <onCompletion> al último paso de una hoja de apuntes.
- Pruebe las hojas de apuntes con tamaños diferentes para la vista de la hoja de
apuntes.
- Pruebe las hojas de apuntes con la vista de anotaciones de error abierta a fin de
visualizar si se registran avisos en las anotaciones.
Directrices para crear una hoja de apuntes compuesta
- Una hoja de apuntes compuesta debe contener tareas relacionadas por un tema común.
- Cada tarea dentro de una hoja de apuntes debe tener un objetivo definido.
- Utilice los elementos <onCompletion> para reconocer el éxito.
- Los nombres de las tareas deben ser breves y concisos.
- Los problemas complejos pueden resolverse utilizando tareas que se basan en las tareas precedentes.
- Utilice skip="true" si una tarea es opcional.
- Por coherencia, asegúrese de que la introducción de la hoja de apuntes y el nombre coinciden con la introducción
y el nombre especificados en la hoja de apuntes compuesta.
- Para las descripciones de tarea, identifique claramente el texto de la interfaz utilizando el formato en negrita.
- Las secuencias solo deben utilizarse cuando sea importante marcar el orden por el que puedan iniciarse las tareas.
Enlaces relacionados
Trabajar con
hojas de apuntes
Trabajar
con hojas de apuntes compuestas
Hojas de apuntes simples
Hojas de apuntes compuestas