A menudo llenos de jerga, acrónimos e instrucciones que requieren un doctorado para comprender, los manuales de usuario de software a veces se escriben desde el punto de vista de un desarrollador en lugar de un usuario. Como resultado, la guía puede hacer suposiciones sobre el nivel de habilidad del lector que a menudo son incorrectas. El primer paso para escribir un buen manual del usuario es lograr que el proceso de escritura sea lo más alejado posible de los ingenieros.
El desarrollador de software sabe más que nadie lo que hace que el software funcione, pero eso no significa que el desarrollador deba escribir la guía. Por el contrario, es una clara desventaja. Más importante que una comprensión profunda del funcionamiento interno del software es comprender quién será el usuario final, cuál es su nivel educativo y cómo ese usuario final utilizará el software. En la mayoría de los casos, los usuarios finales no necesitan conocer los puntos más finos de la programación y el funcionamiento de back-end del software, solo necesitan saber cómo usarlo para facilitar su trabajo.
Pruebas de usuario
El manual del usuario debe estar orientado en gran medida a las tareas, en lugar de ser muy descriptivo. Debido a que el manual está escrito para ayudar a los usuarios a entender cómo ejecutar tareas específicas, el escritor también debe comprender esas tareas y, como resultado, es absolutamente esencial realizar cada paso discreto de cada función. No es necesario que el escritor sepa necesariamente cómo se creó el programa desde un punto de vista de diseño o desarrollo, pero es esencial tener un conocimiento práctico sólido de todas sus características. Al ejecutar cada tarea, tómese el tiempo para anotar cada paso, incluidos los clics, los menús desplegables y otras acciones.
El proceso de entrevista
Si bien la desarrolladora no debe ser la encargada de escribir el manual, seguirá siendo un recurso valioso para la escritora y, antes de que comience la escritura, planee una reunión de inicio entre la redactora, la desarrolladora y los ingenieros, y los posibles usuarios finales para ayudar a informar a la El trabajo del escritor desde el principio. Las entrevistas con expertos e ingenieros en el tema deben ser grabadas, con transcripciones hechas para su posterior consulta.
Imágenes
Un manual de usuario no debe ser demasiado pesado en el texto. Más bien, incorporar el uso liberal de gráficos y clips de pantalla. La descripción de una acción es mucho más clara con direcciones basadas en texto acompañadas de un clip de pantalla que ilustra claramente esa dirección. Incluya las vistas anteriores y posteriores, para mostrar cómo se ve la pantalla antes de realizar cada acción, y qué sucede después de que se haya realizado la acción. Una sencilla utilidad de captura de pantalla, como la herramienta Snipping Tool incluida en Microsoft Windows, funciona bien para capturar estas imágenes. Asegúrese de numerar cada imagen e incluya un título que lo describa brevemente. Centrarlo inmediatamente debajo del párrafo que primero introduce el concepto representado en la imagen.
Formateo
La comunicación clara en un documento técnico requiere planificación y una cuidadosa observancia de las normas en toda la guía. Los estándares tanto en la presentación como en el lenguaje y la nomenclatura ayudan a evitar confusiones. Las plantillas están disponibles y pueden ser un buen punto de partida para la uniformidad, aunque ciertamente se pueden adaptar para adaptarse a cada situación. Usar un margen de una pulgada con una sola columna se adapta mejor a la necesidad de agregar gráficos; una configuración de dos columnas puede aparecer demasiado llena y puede hacer que la ubicación de las imágenes sea confusa.
Versiones y seguimiento
Más que cualquier otro tipo de documento, es probable que una guía del usuario del software pase por varias iteraciones antes de que se complete, y es probable que pase por un proceso de revisión por parte de varios interesados. El uso de la función Rastrear cambios en Microsoft Word es una manera fácil de realizar un seguimiento de los comentarios y cambios de cada individuo. La creación de varias versiones después de cada ciclo de revisión, cada una con un nombre de archivo diferente, también ayuda al proceso y garantiza que todos los interesados estén satisfechos con el resultado final.
