Inicio

¿Qué es esto?¶

Bienvenido a la guía de trabajo que te permitirá integrar un agente de IA en tu flujo de desarrollo de software, optimizando la documentación, el análisis y la creación de nuevas funcionalidades.
Esta metodología está diseñada para que el agente tenga el contexto necesario y pueda generar resultados alineados con los estándares de tu equipo.

📌 Paso 1: Identificación y Documentación del Proyecto¶

En esta etapa ejecutaremos un agente en el proyecto para detectar los aspectos clave:

🔄 Flujos funcionales
⚙️ Aspectos técnicos
🌐 Endpoints y APIs
🗄️ Estructura de datos y modelos
🧩 Dependencias y librerías principales
🏗️ Patrones arquitectónicos usados

📄 Entregable: proyecto.md

Consejo

Mantén la documentación del proyecto siempre actualizada. Un agente con información obsoleta puede generar código incorrecto, incoherente o incompleto.

Formato recomendado

Usa encabezados claros (##), listas y ejemplos de código para que el agente pueda interpretar mejor el contenido.

📌 Paso 2: Análisis Funcional del Requerimiento¶

Aquí deberemos contar con un documento funcional que describa claramente lo que se desea construir:

Puede ser un archivo Markdown (.md) o Texto plano (.txt)
Debe incluir:
- Objetivo del requerimiento
- Casos de uso
- Reglas de negocio
- Ejemplos o escenarios
- Dependencias con otros módulos o sistemas

📂 Ubicación: /context

Importante

Si este documento es ambiguo o incompleto, el agente no podrá producir un resultado óptimo.
Dedica tiempo a definir con precisión el alcance y las restricciones.

📌 Paso 3: Guías de Buenas Prácticas¶

Antes de comenzar a codificar, debemos tener listas nuestras guías de referencia:

🖥️ Buenas prácticas de desarrollo (en la tecnología objetivo)
🧪 Buenas prácticas de testing
📜 Convenciones de código y formato
🔐 Recomendaciones de seguridad
📦 Estructura de proyecto estándar

📂 Ubicación: /context

Consejo Pro

Incluye ejemplos de código y convenciones aceptadas por el equipo para alinear el trabajo del agente con tus estándares.
También puedes agregar casos de test de ejemplo para guiar la generación automática de pruebas.

📌 Paso 4: Preparación del Contexto y Ejecución¶

Una vez que tenemos todos los archivos listos:

📥 Importar al agente todos los documentos de la carpeta /context
🚀 Comenzar la fabricación del feature
🔍 Revisar y validar el output inicial del agente
🔄 Ajustar y reiterar hasta cumplir los criterios de aceptación

Secuencia típica

1. Preparar `proyecto.md`
2. Preparar `analisis_funcional.md`
3. Preparar guías de buenas prácticas
4. Cargar carpeta `/context` al agente
5. Solicitar implementación de la nueva funcionalidad
6. Revisar, ajustar y aprobar

🗂️ Estructura Recomendada de la Carpeta `/context`¶

/context
│── proyecto.md                    # Documentación técnica inicial del proyecto
│── analisis_funcional.md           # Documento funcional del requerimiento
│── buenas_practicas_desarrollo.md  # Guía de buenas prácticas de desarrollo
│── buenas_practicas_testing.md     # Guía de buenas prácticas de testing
│── convenciones_codigo.md          # Estándares y formato de código
│── ejemplos_tests.md               # Casos de test de referencia