El material de soporte del usuario final es habitualmente necesario en cualquier sistema que tenga una interfaz con que
los usuarios interactuarán; los sistemas que se incrustan principalmente y que tienen poca, o no tienen, interfaz de
usuario, pueden omitir este producto de trabajo, aunque puede ser aplicable y útil incluso donde las API necesitan
documentarse.
Este producto de trabajo a menudo engloba uno o más de los documentos y productos de trabajo siguientes:
-
Manuales de usuario
-
Manuales de funcionamiento
-
Manuales de mantenimiento
-
Demostraciones en línea
-
Sistema de ayuda en línea
-
Ayuda según contexto
-
Notas del release
La documentación del usuario proporciona instrucciones para utilizar el software. Proporciona documentación para todos
los tipos de usuarios.
Utilice guiones de uso como base para sus manuales de usuario.
El manual de usuario lo pueden escribir los escritores técnicos, que reciben las entradas de los desarrolladores, o lo
puede escribir el equipo de prueba, cuyos miembros es posible que entiendan la perspectiva del usuario.
Una razón para asignar el manual de usuario al equipo de prueba es que se puede generar en paralelo con desarrollo y
que puede evolucionar pronto como perspectiva tangible y relevante de los criterios de evaluación. Los errores y las
soluciones pobres en la interfaz de usuario y el modelo de guión de uso se pueden detectar y corregir durante las
primeras iteraciones del proyecto, cuando los cambios resultan más baratos.
Escribiendo el manual de usuario, los verificadores conocerán el sistema bien antes de iniciar las pruebas a gran
escala. Además, proporciona una base necesaria para los planes de prueba y los guiones de prueba, y para la
construcción del conjunto de aplicaciones de prueba automatizados.
En qué momento del ciclo de desarrollo se debe empezar a producir el manual de usuario depende del tipo de sistema. Los
sistemas con interfaces complejas o con mucha interacción de los usuarios requerirá versiones anteriores del manual de
usuario y, por lo tanto, los primeros prototipos de la interfaz. Los sistemas incorporados con poca interfaz humana
probablemente no requerirán un inicio temprano de la documentación del usuario.
|