Al escribir la documentación procesal, tengo la opción de escribir las instrucciones paso a paso completas con referencias a un apéndice de ilustraciones,
Por ejemplo:
1. Do task 1 (see Fig. 1)
2. Do task 2 (see Fig. 2)
Illustrations
-------------
+-------+
| Fig 1 |
+-------+
+-------+
| Fig 2 |
+-------+
o acompañar cada paso con una ilustración, casi como si los pasos fueran las leyendas de las ilustraciones,
Por ejemplo:
+-------+
| Fig 1 |
+-------+
1. Do Task 1.
+-------+
| Fig 2 |
+-------+
2. Do Task 2.
¿Hay alguna investigación que muestre qué método es más efectivo para la persona que intenta aprender el material? ¿Cuáles son algunas de las consideraciones que debo hacer al elegir un método sobre el otro?
Si hace alguna diferencia, cada documento tiene entre 10 y 15 páginas, aproximadamente el 25% de las cuales son texto y el 75% son ilustraciones.
Primero, pregúntese si todas las ilustraciones son necesarias (es decir, ¿estas capturas de pantalla ilustran una pantalla con un botón en ellas?).
Al lector le molestará mucho tener que alternar entre el procedimiento y el diagrama. No tengo ningún enlace para mostrarle eso, pero he realizado pruebas reales con usuarios y el resultado abrumador es tener la ilustración en línea con el procedimiento, incluso si esa misma ilustración se duplica en 15 procedimientos diferentes.
Sin embargo, si está hablando de software, es una mejor práctica tener información incrustada en la pantalla del software (ya sea una información sobre herramientas o un tutorial emergente) que hacer que el usuario busque la información en la documentación (porque no lo hará). ).
EDITAR: Mantener ese tipo de documentación se convierte en una carga para el escritor, especialmente si no ha colocado las ilustraciones por referencia y cada una debe actualizarse individualmente.
Mónica Celio