@qubiit/lmagent 2.5.0

package/workflows/documentation.md

@@ -0,0 +1,232 @@
+---
+description: Workflow para documentar código y APIs
+level: 1
+personas: [technical-writer, backend-engineer]
+---
+
+# Documentation Workflow
+
+Este workflow guía la creación y mantenimiento de documentación.
+
+## Tipos de Documentación
+
+| Tipo | Audiencia | Ubicación |
+|------|-----------|-----------|
+| README | Nuevos contribuidores | Raíz del proyecto |
+| API Docs | Desarrolladores consumidores | `/docs/api/` |
+| Architecture | Equipo técnico | `/docs/architecture/` |
+| User Guide | Usuarios finales | Wiki / Docs site |
+| Inline Docs | Desarrolladores | En el código |
+
+---
+
+## README Template
+
+```markdown
+# {Nombre del Proyecto}
+
+{Badges}
+
+{Una línea describiendo qué hace}
+
+## Features
+- Feature 1
+- Feature 2
+
+## Quick Start
+{Comandos para empezar}
+
+## Installation
+{Instrucciones detalladas}
+
+## Usage
+{Ejemplos básicos}
+
+## Documentation
+{Links a docs más detalladas}
+
+## Contributing
+{Cómo contribuir}
+
+## License
+{Licencia}
+```
+
+---
+
+## API Documentation
+
+### Usar OpenAPI/Swagger
+
+```python
+# FastAPI genera automáticamente
+@app.get("/docs")  # Swagger UI
+@app.get("/redoc") # ReDoc
+```
+
+### Documentar Endpoints
+
+```python
+@router.post(
+    "/users",
+    response_model=UserResponse,
+    status_code=201,
+    summary="Create a new user",
+    description="Creates a new user with the provided data. Requires authentication.",
+    responses={
+        201: {"description": "User created successfully"},
+        400: {"description": "Invalid request data"},
+        409: {"description": "Email already exists"},
+    }
+)
+async def create_user(data: UserCreate):
+    """
+    Create a new user.
+    
+    - **email**: Valid email address (required)
+    - **name**: User's display name (required)
+    - **role**: User role, defaults to 'user'
+    """
+    ...
+```
+
+---
+
+## Inline Documentation
+
+### Python Docstrings
+
+```python
+def calculate_tax(amount: Decimal, rate: Decimal) -> Decimal:
+    """
+    Calculate tax for a given amount.
+    
+    Args:
+        amount: The base amount before tax
+        rate: Tax rate as a decimal (e.g., 0.21 for 21%)
+        
+    Returns:
+        The calculated tax amount
+        
+    Raises:
+        ValueError: If amount or rate is negative
+        
+    Example:
+        >>> calculate_tax(Decimal("100"), Decimal("0.21"))
+        Decimal("21.00")
+    """
+```
+
+### TypeScript JSDoc
+
+```typescript
+/**
+ * Formats a date for display.
+ * 
+ * @param date - The date to format
+ * @param locale - Optional locale, defaults to 'es-AR'
+ * @returns Formatted date string
+ * 
+ * @example
+ * formatDate(new Date()) // "21 de enero de 2024"
+ */
+export function formatDate(date: Date, locale = 'es-AR'): string {
+  ...
+}
+```
+
+---
+
+## Architecture Documentation
+
+### ADR Template
+
+```markdown
+# ADR-{N}: {Título}
+
+## Status
+Proposed | Accepted | Deprecated
+
+## Context
+{Qué problema estamos resolviendo}
+
+## Decision
+{Qué decidimos hacer}
+
+## Consequences
+{Qué implica esta decisión}
+```
+
+### System Diagram
+
+```markdown
+## System Architecture
+
+```mermaid
+graph TB
+    Client[Web Client] --> API[API Gateway]
+    API --> Auth[Auth Service]
+    API --> Users[Users Service]
+    Users --> DB[(PostgreSQL)]
+```
+```
+
+---
+
+## Changelog
+
+### Keep a Changelog Format
+
+```markdown
+# Changelog
+
+## [Unreleased]
+
+### Added
+- New feature X
+
+### Changed
+- Updated dependency Y
+
+### Fixed
+- Bug in Z
+
+## [1.0.0] - 2024-01-21
+
+### Added
+- Initial release
+```
+
+---
+
+## Documentation Checklist
+
+```markdown
+## Para cada release
+- [ ] README actualizado
+- [ ] CHANGELOG actualizado
+- [ ] API docs generados
+- [ ] Migration guide (si breaking changes)
+
+## Para código nuevo
+- [ ] Docstrings en funciones públicas
+- [ ] Tipos bien documentados
+- [ ] Ejemplos de uso
+
+## Para features grandes
+- [ ] ADR si hay decisiones arquitectónicas
+- [ ] Diagrama de flujo
+- [ ] User guide
+```
+
+---
+
+## Tools
+
+| Tool | Uso |
+|------|-----|
+| Swagger/OpenAPI | API REST |
+| MkDocs | Documentation sites |
+| Mermaid | Diagramas |
+| Docusaurus | Docs con React |
+| Storybook | Component docs |

package/workflows/generate-prd.md

@@ -0,0 +1,320 @@
+---
+description: Workflow para generar un PRD completo (Product Requirements Document)
+level: 2
+personas: [product-manager, architect]
+bmad_feature: true
+---
+
+# PRD Generator Workflow (BMAD-style)
+
+Este workflow genera un Product Requirements Document completo usando IA.
+
+## Pre-requisitos
+
+1. Leer [AGENTS.md](../AGENTS.md)
+2. Leer [personas/product-manager.md](../personas/product-manager.md)
+3. Tener una idea o concepto inicial del producto/feature
+
+## Información Requerida
+
+Para generar un PRD completo, necesito:
+
+1. **Nombre del producto/feature**: ¿Cómo se llama?
+2. **Problema a resolver**: ¿Qué problema resuelve? ¿Para quién?
+3. **Contexto**: ¿Por qué ahora? ¿Qué existe actualmente?
+4. **Usuarios objetivo**: ¿Quiénes son los usuarios?
+5. **Métricas de éxito**: ¿Cómo sabremos si tuvo éxito?
+
+---
+
+## Proceso de Generación
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                    PRD GENERATION FLOW                          │
+└─────────────────────────────────────────────────────────────────┘
+
+    ┌──────────────────────────────────────────────────────────┐
+    │  1. DISCOVERY                                            │
+    │  • Entender el problema                                  │
+    │  • Identificar usuarios                                  │
+    │  • Analizar contexto                                     │
+    └────────────────────────┬─────────────────────────────────┘
+                             │
+                             ▼
+    ┌──────────────────────────────────────────────────────────┐
+    │  2. DEFINITION                                           │
+    │  • Definir scope                                         │
+    │  • Priorizar features                                    │
+    │  • Establecer métricas                                   │
+    └────────────────────────┬─────────────────────────────────┘
+                             │
+                             ▼
+    ┌──────────────────────────────────────────────────────────┐
+    │  3. SPECIFICATION                                        │
+    │  • User Stories                                          │
+    │  • Acceptance Criteria                                   │
+    │  • Mockups/Wireframes                                    │
+    └────────────────────────┬─────────────────────────────────┘
+                             │
+                             ▼
+    ┌──────────────────────────────────────────────────────────┐
+    │  4. VALIDATION                                           │
+    │  • Review con stakeholders                               │
+    │  • Ajustes                                               │
+    │  • Aprobación                                            │
+    └──────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Template del PRD
+
+```markdown
+# PRD: {Nombre del Producto/Feature}
+
+## 1. Información General
+
+| Campo | Valor |
+|-------|-------|
+| **Nombre** | {nombre} |
+| **Versión PRD** | 1.0 |
+| **Autor** | {autor} |
+| **Fecha** | {fecha} |
+| **Estado** | Draft / In Review / Approved |
+
+## 2. Resumen Ejecutivo
+
+### 2.1 Problema
+{Descripción clara del problema que se resuelve}
+
+### 2.2 Solución Propuesta
+{Descripción de alto nivel de la solución}
+
+### 2.3 Objetivo
+{Qué queremos lograr}
+
+## 3. Contexto
+
+### 3.1 Background
+{Por qué es importante, historia, contexto de negocio}
+
+### 3.2 Estado Actual
+{Cómo se hace actualmente, problemas del approach actual}
+
+### 3.3 Oportunidad
+{Qué oportunidad representa este producto/feature}
+
+## 4. Usuarios
+
+### 4.1 Usuarios Objetivo
+
+#### Persona 1: {Nombre}
+| Campo | Descripción |
+|-------|-------------|
+| **Rol** | {rol} |
+| **Demografía** | {edad, ubicación, etc.} |
+| **Necesidades** | {qué necesita} |
+| **Pain Points** | {problemas actuales} |
+| **Goals** | {qué quiere lograr} |
+
+#### Persona 2: {Nombre}
+{Repetir estructura}
+
+### 4.2 Casos de Uso Principales
+
+| ID | Nombre | Usuario | Descripción |
+|----|--------|---------|-------------|
+| UC-01 | {nombre} | {persona} | {descripción} |
+| UC-02 | {nombre} | {persona} | {descripción} |
+
+## 5. Scope
+
+### 5.1 In Scope
+- {Feature 1}
+- {Feature 2}
+- {Feature 3}
+
+### 5.2 Out of Scope
+- {Feature X} - {Razón}
+- {Feature Y} - {Razón}
+
+### 5.3 Fases
+
+| Fase | Features | Timeline |
+|------|----------|----------|
+| MVP | {features} | {time} |
+| V2 | {features} | {time} |
+| V3+ | {features} | {time} |
+
+## 6. Requisitos Funcionales
+
+### 6.1 Epic: {Nombre del Epic}
+
+#### US-001: {Nombre de la Historia}
+**Como** {tipo de usuario}
+**Quiero** {acción}
+**Para** {beneficio}
+
+**Criterios de Aceptación:**
+- [ ] Dado {contexto}, cuando {acción}, entonces {resultado}
+- [ ] Dado {contexto}, cuando {acción}, entonces {resultado}
+
+**Prioridad:** Must Have / Should Have / Could Have
+**Story Points:** {X}
+
+---
+
+#### US-002: {Nombre de la Historia}
+{Repetir estructura}
+
+## 7. Requisitos No Funcionales
+
+### 7.1 Performance
+- Tiempo de carga: < {X}ms
+- Throughput: {X} requests/segundo
+- Latencia P99: < {X}ms
+
+### 7.2 Seguridad
+- Autenticación: {método}
+- Autorización: {método}
+- Encriptación: {especificación}
+
+### 7.3 Escalabilidad
+- Usuarios concurrentes: {número}
+- Datos: {volumen esperado}
+
+### 7.4 Disponibilidad
+- Uptime: {%}
+- RPO: {tiempo}
+- RTO: {tiempo}
+
+## 8. Métricas de Éxito
+
+### 8.1 OKRs
+
+**Objective**: {objetivo}
+
+| Key Result | Target | Actual | Status |
+|------------|--------|--------|--------|
+| {KR1} | {valor} | - | 🔴 |
+| {KR2} | {valor} | - | 🔴 |
+| {KR3} | {valor} | - | 🔴 |
+
+### 8.2 KPIs para Tracking
+
+| KPI | Baseline | Target | Método de Medición |
+|-----|----------|--------|-------------------|
+| {KPI1} | {valor} | {valor} | {cómo medir} |
+| {KPI2} | {valor} | {valor} | {cómo medir} |
+
+## 9. Dependencias & Riesgos
+
+### 9.1 Dependencias
+
+| Dependencia | Tipo | Dueño | Status |
+|-------------|------|-------|--------|
+| {Dep1} | Técnica/Negocio/Externa | {nombre} | {status} |
+
+### 9.2 Riesgos
+
+| Riesgo | Probabilidad | Impacto | Mitigación |
+|--------|--------------|---------|------------|
+| {Riesgo1} | Alta/Media/Baja | Alto/Medio/Bajo | {acción} |
+
+### 9.3 Asunciones
+- {Asunción 1}
+- {Asunción 2}
+
+## 10. Timeline
+
+### 10.1 Milestones
+
+| Milestone | Fecha | Entregables |
+|-----------|-------|-------------|
+| Design Complete | {fecha} | Wireframes, Tech Design |
+| Development Complete | {fecha} | Feature code, unit tests |
+| QA Complete | {fecha} | Test report, bugs fixed |
+| Launch | {fecha} | Production deployment |
+
+### 10.2 Gantt (opcional)
+
+```mermaid
+gantt
+    title Project Timeline
+    dateFormat  YYYY-MM-DD
+    section Design
+    Wireframes           :a1, 2024-01-01, 5d
+    Tech Design          :a2, after a1, 3d
+    section Development
+    Backend              :b1, after a2, 10d
+    Frontend             :b2, after a2, 10d
+    section Testing
+    QA                   :c1, after b1 b2, 5d
+    section Launch
+    Deployment           :d1, after c1, 1d
+```
+
+## 11. Apéndices
+
+### A. Mockups/Wireframes
+{Incluir imágenes o links}
+
+### B. Tech Design Reference
+{Link al documento de arquitectura}
+
+### C. Research & Data
+{Links a estudios, análisis, etc.}
+
+---
+
+## Historial de Cambios
+
+| Versión | Fecha | Autor | Cambios |
+|---------|-------|-------|---------|
+| 1.0 | {fecha} | {autor} | Initial version |
+```
+
+---
+
+## Preguntas Guía
+
+Al generar un PRD, hacer estas preguntas:
+
+### Discovery
+1. ¿Cuál es el problema principal que resolvemos?
+2. ¿Quién tiene este problema? ¿Qué tan frecuente es?
+3. ¿Cómo lo resuelven actualmente?
+4. ¿Cuánto les cuesta el problema (tiempo, dinero, frustración)?
+
+### Definition
+5. ¿Cuál es nuestra solución en una oración?
+6. ¿Qué hace nuestra solución que otras no hacen?
+7. ¿Cuál es el alcance mínimo para resolver el problema (MVP)?
+8. ¿Qué features pueden esperar a V2?
+
+### Metrics
+9. ¿Cómo sabremos si tiene éxito?
+10. ¿Qué métricas moverá este producto?
+11. ¿Cuánto movimiento es "suficiente" para declarar éxito?
+
+### Risk
+12. ¿Qué podría salir mal?
+13. ¿Qué dependemos de otros para lograr esto?
+14. ¿Qué asumimos que es verdad?
+
+---
+
+## Checklist de PRD Completo
+
+- [ ] Problema claramente definido
+- [ ] Usuarios identificados con personas
+- [ ] Scope definido (in/out)
+- [ ] User Stories con acceptance criteria
+- [ ] Requisitos no funcionales
+- [ ] Métricas de éxito (OKRs/KPIs)
+- [ ] Dependencias listadas
+- [ ] Riesgos identificados con mitigaciones
+- [ ] Timeline con milestones
+- [ ] Revisado por stakeholders
+- [ ] Aprobado para desarrollo