GUÍA DOCUMENTACIÓN TÉCNICA E HISTORIAS DE USUARIO.

Realizar la documentación técnica del proyecto PIA, según los siguientes parámetros: 

Aquí una descripción de lo que normalmente debe contener cada sección de una documentación técnica:

1. Descripción del proyecto: explicación general sobre qué es el proyecto, su propósito, alcance y objetivos principales.
2. Introducción: presentación más detallada del proyecto, tecnologías usadas, requerimientos y una visión general de la arquitectura.
3. Arquitectura del sistema: diagrama y descripción detallada de los componentes del sistema, cómo interactúan, flujos de datos, etc.(que se uso en frontend, backend y db)
4. Especificación de bases de datos: descripción de las bases de datos usadas, modelos de datos, tablas, relaciones, etc.
5. Interfaces de usuario: prototipos y especificaciones de las interfaces de usuario y experiencia de cliente.
6. API´s Librerías, framework: documentación técnica de los API usados Descripción y uso. ejemplo: fastapi, uvicorn, jinja2, bootstrap...etc.
7. Endpoints: listado y descripción de cada endpoint del API, métodos HTTP, parámetros, cuerpos de solicitud y respuesta.
8. Repositorios git: Link del repositorio y descripción de ramas.
9. Mantenimiento: guía para dar mantenimiento al sistema, release notes, actualizaciones, solución de problemas comunes.
10. Conclusiones: resumen de lo realizado, cumplimiento de objetivos y trabajo futuro.
11. Recomendaciones: sugerencias para mejorar el sistema, ampliaciones, mejoras, etc.
12. FAQ/Manual de usuario: preguntas frecuentes y guía detallada para usuarios finales.

HISTORIAS DE USUARIO.

Las historias de usuario son descripciones breves de una funcionalidad que se desea tener en un sistema de software desde la perspectiva de un usuario. Se utilizan comúnmente en metodologías ágiles como Scrum para gestionar los requisitos del software.

Algunas características clave de las historias de usuario:

• Describen una función que será valiosa para el usuario final. Por ejemplo: "Como usuario, quiero poder restablecer mi contraseña si la olvido".
• Son escritas en un lenguaje simple, no técnico.
• Son lo suficientemente breves para caber generalmente en una nota adhesiva.
• Se enfocan en lo que el usuario quiere lograr, no en cómo implementarlo.
• Suelen seguir un formato similar a: "Como [tipo de usuario], quiero [acción] para [beneficio]".
• Se asignan a iteraciones o sprints específicos del proyecto.
• Se estiman y priorizan junto con el equipo.
• Evolucionan y se dividen en tareas más pequeñas a medida que se desarrolla el proyecto.

En resumen, las historias de usuario son una técnica muy útil para traducir necesidades de negocio en requisitos de software que guían el desarrollo ágil. Ayudan a mantener el enfoque en el usuario final.

EJEMPLO Y CONCEJOS.

Paso 1. Identifica el perfil

Identifica el perfil del usuario final evaluando a tu público objetivo. Considera sobre quién impactará la función de software. 

A continuación, te presentamos algunas preguntas que tanto tu equipo como tú deben hacerse a la hora de identificar el perfil del usuario:

• ¿Para quién estamos creando esta función de software?

• ¿Qué tipo de características del producto quiere el usuario final?

• ¿Cuáles son los datos demográficos y psicográficos del usuario final?

Puede haber varios perfiles en una historia de usuario determinada dependiendo del tamaño del público objetivo. 

Ejemplo de perfil: Kat, una gerenta de proyecto que dirige a un equipo de 10 personas.

Paso 2. Describe la necesidad

Describe cómo el usuario final usará tu función de software y por qué. Esto es fundamental para que tu equipo entienda por qué el público objetivo elegiría usar tu función. 

Ten en cuenta estas preguntas cuando analices la intención del usuario final:

• ¿Qué está tratando de lograr el usuario final?

• ¿Cómo ayudará tu función de software al usuario final a lograr sus objetivos?

Evita centrarte en las características específicas; en cambio, considera lo que el usuario final está buscando y la manera en que tu software lo ayudará a alcanzar sus objetivos. 

Ejemplo de necesidad: Ayudar a los miembros del equipo a comprender cómo las tareas individuales contribuyen a los objetivos comerciales más amplios.

Paso 3. Define el propósito

Define el propósito analizando el panorama general del lanzamiento del software. Considera cómo la función de software se ajusta a tus objetivos internos. 

Pregúntate lo siguiente para ayudar a definir el propósito:

• ¿Cuál es el beneficio de la función de software?

• ¿Cuál es el problema que se está resolviendo?

• ¿Cómo encaja esto en metas más amplias?

El propósito aquí es definir el valor de tu función de software en relación con los objetivos generales.

Ejemplo de propósito: Aumentar la eficiencia al crear un camino claro.

Lee: Gestión de entregas: los cinco pasos de un proceso exitoso

Ejemplos de historias de usuario

Para que comprendas las historias de usuario ágiles un poco más, hemos reunido algunos ejemplos. Cuanto más efectivas sean tus historias de usuario, más valor podrás generar para el usuario final. 

Te presentamos tres ejemplos que representan diferentes escenarios de historias de usuario: 

Ejemplo de historia de usuario nro. 1: Desarrollo de productos 

• Como gerente de producto, quiero una manera en que los miembros del equipo puedan entender cómo las tareas individuales contribuyen a los objetivos comerciales más amplios para aumentar la eficiencia.

Ejemplo de historia de usuario nro. 2: Experiencia del cliente

• Como cliente recurrente, espero que mi información quede guardada para crear una experiencia de pago más fluida.

Ejemplo de historia de usuario nro. 3: Aplicación móvil

• Como usuario frecuente de la aplicación, quiero una forma de simplificar la información relevante de la manera más rápida posible. 

En los tres ejemplos, puedes ver lo importante que es plantear actualizaciones de software desde la perspectiva del usuario final. De esta manera, las actualizaciones se realizan teniendo en cuenta el beneficio del cliente.

Consejos para lograr una historia de usuario efectiva

Además de los tres pasos descritos anteriormente, una historia de usuario efectiva debe seguir las 3 “C” y el acrónimo INVEST (invertir). Ambos te permitirán llevar tus historias de usuario a un nivel superior, lo que genera actualizaciones de software más efectivas. 

Profundicemos en cada uno de estos para que comprendas mejor los criterios de una historia de usuario efectiva.