docs(methodology): commit inicial del método de trabajo con agentes
This commit is contained in:
83
methodology/TEMPLATES/BRIEF_TEMPLATE.md
Normal file
83
methodology/TEMPLATES/BRIEF_TEMPLATE.md
Normal file
@@ -0,0 +1,83 @@
|
||||
# Sprint N — [Nombre descriptivo]
|
||||
|
||||
> **Propósito:** [una oración que describe qué cambia con este sprint]
|
||||
>
|
||||
> **Justificación:** [por qué ahora, qué costo evita o qué oportunidad captura]
|
||||
|
||||
---
|
||||
|
||||
## 0. Contexto crítico
|
||||
|
||||
[Cualquier información del producto, marca, o cliente que aplica transversalmente a todas las etapas. Reglas no negociables que el agente debe respetar.]
|
||||
|
||||
---
|
||||
|
||||
## 1. Alcance del sprint
|
||||
|
||||
### Sí entra
|
||||
- [Feature o cambio 1]
|
||||
- [Feature o cambio 2]
|
||||
- ...
|
||||
|
||||
### NO entra
|
||||
- [Cosa que podría parecer en alcance pero NO]
|
||||
- [Feature postergada con razón]
|
||||
- ...
|
||||
|
||||
---
|
||||
|
||||
## 2. Decisiones tomadas previamente
|
||||
|
||||
| Decisión | Fuente / Justificación |
|
||||
|---|---|
|
||||
| [Decisión 1] | [Sprint o documento donde se decidió] |
|
||||
| [Decisión 2] | [...] |
|
||||
|
||||
---
|
||||
|
||||
## 3. Roadmap del sprint
|
||||
|
||||
Lista ordenada de etapas con expectativa calibrada de cada una:
|
||||
|
||||
| Etapa | Qué hace | Output esperado al final |
|
||||
|---|---|---|
|
||||
| 1 | [Descripción breve] | [Qué se ve, qué se mide] |
|
||||
| 2 | [...] | [...] |
|
||||
| ... | | |
|
||||
|
||||
---
|
||||
|
||||
## 4. Definition of Done del sprint completo
|
||||
|
||||
```
|
||||
[ ] [Criterio mensurable 1]
|
||||
[ ] [Criterio mensurable 2]
|
||||
[ ] [Tests verdes esperados N]
|
||||
[ ] [Validación visual con usuario]
|
||||
[ ] [Documentación actualizada]
|
||||
[ ] [Tag de release X]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Archivos que se crean / modifican (preview)
|
||||
|
||||
### Nuevos
|
||||
- [Archivo + propósito]
|
||||
|
||||
### Modificados
|
||||
- [Archivo + qué cambia en él]
|
||||
|
||||
---
|
||||
|
||||
## 6. Lo que NO entra en este sprint (postergado)
|
||||
|
||||
- [Cosa importante que considerada y rechazada para este sprint, con justificación]
|
||||
|
||||
---
|
||||
|
||||
## Notas finales para el agente
|
||||
|
||||
- [Recordatorios específicos del sprint]
|
||||
- [Cosas con las que el agente puede confundirse, aclaradas]
|
||||
- [Reglas operativas que aplican durante el sprint]
|
||||
105
methodology/TEMPLATES/ETAPA_PROMPT_TEMPLATE.md
Normal file
105
methodology/TEMPLATES/ETAPA_PROMPT_TEMPLATE.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Sprint N — Etapa X: [Nombre descriptivo de la etapa]
|
||||
|
||||
> **Objetivo:** [una oración que describe qué hace esta etapa específica]
|
||||
>
|
||||
> **Pre-requisitos:** [qué tiene que estar listo antes de arrancar; típicamente etapas previas]
|
||||
>
|
||||
> **Etapa siguiente:** [qué viene después, para que el agente NO arranque eso sin OK]
|
||||
|
||||
---
|
||||
|
||||
## 1. Pre-tareas (si aplica)
|
||||
|
||||
[Actualizaciones a artefactos previos antes de la implementación. Por ejemplo: actualizar un audit, completar un documento de Etapa anterior.]
|
||||
|
||||
### 1.1 [Pre-tarea 1]
|
||||
|
||||
[Descripción concreta de qué hacer]
|
||||
|
||||
### 1.2 [Pre-tarea 2]
|
||||
|
||||
[...]
|
||||
|
||||
---
|
||||
|
||||
## 2. Decisiones ya tomadas (no consultar de nuevo)
|
||||
|
||||
| Decisión | Justificación |
|
||||
|---|---|
|
||||
| [Decisión 1] | [Por qué se eligió esto y no la alternativa] |
|
||||
| [Decisión 2] | [...] |
|
||||
|
||||
---
|
||||
|
||||
## 3. Tarea principal
|
||||
|
||||
### 3.1 [Subtarea 1]
|
||||
|
||||
**Ubicación:** [archivo o módulo]
|
||||
|
||||
**Descripción concreta:** [qué se implementa]
|
||||
|
||||
**Snippet de referencia** (si aplica):
|
||||
```typescript
|
||||
// código de referencia
|
||||
```
|
||||
|
||||
### 3.2 [Subtarea 2]
|
||||
|
||||
[...]
|
||||
|
||||
---
|
||||
|
||||
## 4. Tests obligatorios
|
||||
|
||||
### 4.1 Tests unitarios
|
||||
|
||||
[Lista de casos a cubrir, con inputs y outputs esperados]
|
||||
|
||||
### 4.2 Tests E2E o visuales (si aplica)
|
||||
|
||||
[Lo que requiere validación end-to-end]
|
||||
|
||||
---
|
||||
|
||||
## 5. Aplicación en múltiples lugares (si aplica)
|
||||
|
||||
[Si la tarea involucra cambios en múltiples capas, listarlas explícitamente]
|
||||
|
||||
a) [Capa 1]: [qué cambia]
|
||||
b) [Capa 2]: [qué cambia]
|
||||
c) [Capa 3]: [qué cambia]
|
||||
|
||||
---
|
||||
|
||||
## 6. Entregables (Definition of Done)
|
||||
|
||||
```
|
||||
[ ] [Criterio 1 — mensurable y específico]
|
||||
[ ] [Tests pasando: N esperados]
|
||||
[ ] [Build limpio]
|
||||
[ ] [Validación visual con artefactos concretos]
|
||||
[ ] [Documentación actualizada si aplica]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. Reporte final a entregar
|
||||
|
||||
Cuando termines, devolveme:
|
||||
|
||||
1. [Métrica concreta 1 — ej: tabla de tests con resultados]
|
||||
2. [Artefacto visible 1 — ej: screenshot del componente]
|
||||
3. [Artefacto visible 2 — ej: PDF presentado con present_files]
|
||||
4. [Cantidad final de algo mensurable]
|
||||
5. **Hallazgos no esperados** — cualquier descubrimiento que merezca decisión arquitectónica
|
||||
|
||||
---
|
||||
|
||||
## 8. Reglas operativas (recordatorios)
|
||||
|
||||
1. **No declares etapa terminada sin validación visual** del artefacto final.
|
||||
2. **No racionalizar problemas** — si algo no cuadra, investigar causa raíz.
|
||||
3. **No tocar [lo que esta etapa NO debe tocar]** — está agendado para Etapa Y.
|
||||
4. **No avanzar a Etapa siguiente sin OK explícito.**
|
||||
5. **Si encontrás contradicción** entre este prompt y la realidad del código (un archivo no está donde decía, una función cambió de signature, etc.): **PARÁ y consultá**, no asumas.
|
||||
100
methodology/TEMPLATES/REPORT_TEMPLATE.md
Normal file
100
methodology/TEMPLATES/REPORT_TEMPLATE.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Sprint N — Etapa X: Reporte final
|
||||
|
||||
> Reporte capturado al cierre de la etapa. Útil para auditoría y para reconstruir contexto en sesiones futuras.
|
||||
>
|
||||
> Generado por el agente, validado por el humano antes del commit.
|
||||
|
||||
---
|
||||
|
||||
## 1. Resumen de cambios
|
||||
|
||||
### Archivos creados/modificados
|
||||
|
||||
| Archivo | Acción | Líneas | Propósito |
|
||||
|---|---|---|---|
|
||||
| [path] | Creado/Modificado | +N/-M | [descripción breve] |
|
||||
|
||||
---
|
||||
|
||||
## 2. Tests
|
||||
|
||||
### Resultados
|
||||
|
||||
- Tests previos: N (sin regresión)
|
||||
- Tests nuevos: M
|
||||
- Total: N+M verdes
|
||||
|
||||
### Tests nuevos agregados
|
||||
|
||||
| Test | Caso | Resultado |
|
||||
|---|---|---|
|
||||
| [nombre] | [input → output esperado] | ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 3. Artefactos visibles generados
|
||||
|
||||
| Artefacto | Tamaño | Validación | Path |
|
||||
|---|---|---|---|
|
||||
| [PDF / screenshot / archivo] | XX KB | ✓ visualizado | [path] |
|
||||
|
||||
---
|
||||
|
||||
## 4. Verificación programática (si aplica)
|
||||
|
||||
### Análisis de píxeles / contenido / métricas
|
||||
|
||||
[Resultados concretos: qué se midió y qué dio]
|
||||
|
||||
### Text extraction (si aplica)
|
||||
|
||||
[Palabras clave esperadas confirmadas en el output]
|
||||
|
||||
---
|
||||
|
||||
## 5. Validado vs Asumido
|
||||
|
||||
### Verificado
|
||||
- [Lista de cosas efectivamente comprobadas]
|
||||
|
||||
### Asumido (no validado en esta etapa)
|
||||
- [Lista de cosas que se asumen funcionando pero no se probaron explícitamente]
|
||||
|
||||
---
|
||||
|
||||
## 6. Hallazgos no esperados
|
||||
|
||||
[Cualquier descubrimiento durante la implementación que merezca decisión arquitectónica, aunque no esté en el DoD]
|
||||
|
||||
- **Hallazgo 1:** [descripción]
|
||||
- Impacto: [cuál]
|
||||
- Decisión requerida: [qué tiene que decidir el humano]
|
||||
- Sugerencia del agente: [recomendación]
|
||||
|
||||
---
|
||||
|
||||
## 7. Patrones aprendidos (cosecha para methodology/)
|
||||
|
||||
[Si durante esta etapa surgió un patrón nuevo o se validó uno existente, registralo acá. El humano decide si pasa a `methodology/PATTERNS.md`.]
|
||||
|
||||
- **Patrón candidato:** [descripción]
|
||||
- Categoría: [A/B/C/D/E]
|
||||
- Deriva de: [Principio N]
|
||||
- Indicador de aplicación correcta: [...]
|
||||
- Indicador de violación: [...]
|
||||
|
||||
---
|
||||
|
||||
## 8. Definition of Done — checklist final
|
||||
|
||||
```
|
||||
[x] Criterio 1 cumplido
|
||||
[x] Criterio 2 cumplido
|
||||
[ ] Criterio 3 — pendiente porque [razón]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Próximo paso
|
||||
|
||||
[Qué viene después: etapa siguiente, decisión pendiente del humano, etc.]
|
||||
Reference in New Issue
Block a user