GUI-TDT-005 Agregar requeriemento a manual de usuario
v 1.0
Objetivo
El propósito de esta guía es proporcionar orientación a los miembros del departamento Black Dot al momento de agregar o actualizar un requerimiento en el manual de usuario. En este caso, se mostrará cómo agregar un requerimiento al manual de usuario de Talent 360.
Contenido
Analizar requerimiento
Se deberá analizar los criterios de aceptación del requerimiento para poder entenderlo y documentarlo correctamente.
Se recomienda seguir el flujo para tener un mejor entendimiento del requerimiento.
Separar requerimiento
Separar en pasos el requerimiento para que el usuario pueda seguirlo de manera sencilla.
Se recomienda crear un paso por cada acción que el usuario deba realizar.
Agregar requerimiento
- Ingresar Manual de cliente Talent 360.
- Buscar la sección correspondiente al módulo que se desea documentar o actualizar. En caso de no existir, crear una nueva sección.
- Agregar cada paso del requerimiento explicando de manera clara y concisa lo que el usuario debe hacer.
- Agregar imágenes a cada paso para que el usuario pueda visualizar lo que debe hacer.
- Agregar en el pie de imagen un identificador así como una breve descripción de lo que se muestra en la imagen.
Uso de palabras
Se recomienda utilizar un lenguaje claro y sencillo para que el usuario final pueda entender fácilmente el manual. Dirigirse al usuario en segunda persona.
Control de cambios
Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
---|---|---|---|---|---|
v 1.0 | Creación de la guía. | N/A | Diego Sandoval | Diego Llaca | 19/05/2024 |