Framework/Docs
Docs

Documentacion operativa del framework

Estas paginas explican el proposito, el momento de uso y el output esperado de cada artefacto del framework. Los archivos reales para equipos y agentes viven en Templates.

Documento

Contexto de negocio

Contextualiza el problema de negocio, alcance, restricciones e impacto de la iniciativa.

Output

Problema claro, Alcance visible, Restricciones identificadas

Cuando usarlo

Siempre en el paso 0 del framework: product discovery.

Documento

Historia de usuario

Documento base para expresar la necesidad del usuario, el objetivo del negocio y el alcance funcional.

Output

Necesidad funcional clara, Valor esperado, Escenario principal

Cuando usarlo

En el paso 1 del framework, despues del discovery inicial.

Documento

Criterios de aceptacion

Define el comportamiento esperado de la funcionalidad con reglas verificables y orientadas a validacion.

Output

Comportamiento verificable, Casos positivos, Casos invalidos

Cuando usarlo

Despues de redactar la historia de usuario y antes de pedir implementacion al agente.

Documento

Plan de pruebas

Lista escenarios, casos de prueba y evidencia esperada para validar el cambio con profundidad tecnica.

Output

Escenarios felices, Casos borde, Cobertura esperada

Cuando usarlo

En el paso 2 del framework junto con criterios de aceptacion, y se actualiza antes del PR.

Documento

Arquitectura

Resume decisiones tecnicas, componentes impactados, integraciones y riesgos de implementacion.

Output

Solucion propuesta, Componentes impactados, Riesgos tecnicos

Cuando usarlo

En el paso 3 del framework, previo a implementation planning.

Documento

Modelo de datos

Documenta entidades, campos, relaciones, migraciones y reglas de persistencia necesarias para la feature.

Output

Entidades afectadas, Reglas de integridad, Migraciones necesarias

Cuando usarlo

En el paso 3 del framework cuando la solucion toca persistencia o integridad.

Documento

Contrato API

Define endpoints, payloads, errores, permisos y ejemplos de intercambio entre cliente y servidor.

Output

Endpoints claros, Payloads definidos, Errores esperados

Cuando usarlo

En el paso 3 del framework cuando la feature crea, cambia o consume APIs.

Documento

Prompt de implementacion

Prompt base para delegar implementacion a un agente con contexto suficiente, restricciones y criterios de salida.

Output

Objetivo claro para el agente, Restricciones tecnicas, Resultado esperado

Cuando usarlo

En el paso 4 del framework, cuando la documentacion tecnica minima ya esta lista.

Documento

Execution plan

Plan operativo para dividir la implementacion, los archivos a tocar, los riesgos y el orden sugerido para ejecutar con agentes.

Output

Bloques de trabajo, Orden de ejecucion, Verificaciones intermedias

Cuando usarlo

En el paso 4 del framework, junto con prompt_implementacion.md.

Documento

Checklist de PR

Checklist operativo para revisar cambios, cobertura, riesgos y preparacion del merge.

Output

Cobertura revisada, Riesgos visibles, Merge mejor preparado

Cuando usarlo

En el paso 6 del framework, antes de aprobar o fusionar un pull request.

Documento

Reporte de pruebas

Consolida resultados de unit tests, integration tests, lint, typecheck, coverage y observaciones tecnicas.

Output

Estado tecnico consolidado, Fallos detectados, Riesgos abiertos

Cuando usarlo

En el paso 7 del framework, despues de implementar y ajustar el cambio.

Documento

Evidencia UAT

Recoge validacion funcional con negocio, decisiones tomadas y observaciones previas al release.

Output

Escenarios aprobados, Observaciones de negocio, Aprobacion final

Cuando usarlo

En el paso 8 del framework, durante la validacion funcional con negocio.

Documento

Release notes

Resume que cambia, como se despliega, impactos esperados y consideraciones operativas del release.

Output

Resumen del cambio, Riesgos operativos, Monitoreo post release

Cuando usarlo

En el paso 9 del framework, antes o durante el despliegue.

Documento

Retrospective

Captura aprendizajes, vacios del framework y mejoras recomendadas despues de cerrar la iniciativa.

Output

Aprendizajes capturados, Huecos del framework, Acciones de mejora

Cuando usarlo

En el paso 10 del framework, despues del release y la estabilizacion inicial.