@damenor/agent-docs 0.1.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +65 -29
  2. package/dist/index.js +3834 -217
  3. package/package.json +5 -2
  4. package/templates/modules/agents/.agents/agents/doc-designer.md +39 -37
  5. package/templates/modules/agents/.agents/agents/doc-maintainer.md +35 -35
  6. package/templates/modules/agents/.agents/agents/doc-reviewer.md +55 -46
  7. package/templates/modules/agents/.agents/agents/doc-writer.md +34 -33
  8. package/templates/modules/agents/.agents/agents/reviewer.md +114 -100
  9. package/templates/modules/agents/.agents/skills/doc-design/SKILL.md +176 -174
  10. package/templates/modules/agents/.agents/skills/doc-design/references/design-system-format.md +241 -247
  11. package/templates/modules/agents/.agents/skills/doc-maintain/SKILL.md +61 -51
  12. package/templates/modules/agents/.agents/skills/doc-maintain/references/triggers.md +171 -165
  13. package/templates/modules/agents/.agents/skills/doc-review/SKILL.md +39 -34
  14. package/templates/modules/agents/.agents/skills/doc-review/references/health-checklist.md +115 -112
  15. package/templates/modules/agents/.agents/skills/doc-scaffold/SKILL.md +19 -12
  16. package/templates/modules/agents/.agents/skills/doc-scaffold/references/diataxis-quick-ref.md +110 -110
  17. package/templates/modules/agents/.agents/skills/doc-write/SKILL.md +44 -16
  18. package/templates/modules/agents/.agents/skills/doc-write/references/adr-format.md +99 -93
  19. package/templates/modules/agents/.agents/skills/doc-write/references/diataxis-patterns.md +221 -200
  20. package/templates/base/AGENTS.md +0 -177
  21. package/templates/base/CHANGELOG.md +0 -86
  22. package/templates/base/README.md +0 -105
  23. package/templates/base/docs/CONTEXT.md +0 -111
  24. package/templates/base/docs/README.md +0 -131
  25. package/templates/base/docs/adr/TEMPLATE.md +0 -83
  26. package/templates/modules/design/docs/DESIGN.md +0 -253
  27. package/templates/modules/explanation/docs/explanation/agent-flow.md +0 -15
  28. package/templates/modules/explanation/docs/explanation/architecture.md +0 -138
  29. package/templates/modules/guides/docs/guides/deployment.md +0 -189
  30. package/templates/modules/guides/docs/guides/runbooks/TEMPLATE.md +0 -86
  31. package/templates/modules/guides/docs/guides/troubleshooting.md +0 -65
  32. package/templates/modules/operations/docs/operations/README.md +0 -115
  33. package/templates/modules/product/docs/product/overview.md +0 -90
  34. package/templates/modules/product/docs/roadmap.md +0 -80
  35. package/templates/modules/reference/docs/reference/api.md +0 -131
  36. package/templates/modules/reference/docs/reference/code-style.md +0 -275
  37. package/templates/modules/reference/docs/reference/configuration.md +0 -117
  38. package/templates/modules/reference/docs/reference/infrastructure.md +0 -191
  39. package/templates/modules/tutorials/docs/tutorials/environment-setup.md +0 -212
  40. package/templates/modules/tutorials/docs/tutorials/first-task.md +0 -246
  41. package/templates/modules/tutorials/docs/tutorials/quick-start.md +0 -146
@@ -1,101 +1,102 @@
1
1
  ---
2
- created: "2024-01-15"
2
+ created: '2024-01-15'
3
3
  status: active
4
4
  type: reference
5
- tags: [triggers, mantenimiento, sincronizacion, documentacion]
5
+ tags: [triggers, maintenance, synchronization, documentation]
6
6
  ---
7
7
 
8
- # Triggers — Referencia Completa
9
-
10
- ## Tabla Maestra: Evento → Doc a Actualizar
11
-
12
- | Evento | Doc a actualizar | Prioridad | Cómo detectar |
13
- |--------|-----------------|-----------|---------------|
14
- | Feature nueva | CONTEXT.md, docs/README.md, reference/ | Crítica | Nuevo módulo/archivo en src/ |
15
- | Feature nueva con decisión arq. | docs/adr/ | Alta | Se discutió arquitectura |
16
- | Feature nueva con nuevo endpoint | reference/api.md | Crítica | Nuevo archivo en routes/ |
17
- | Feature nueva con UI nueva | DESIGN.md | Alta | Nuevo componente UI |
18
- | Release | CHANGELOG.md, docs/guides/deployment.md | Crítica | git tag creado |
19
- | Release con breaking change | CHANGELOG.md ⚠️, reference/api.md | Crítica | API cambió retrocompatibilidad |
20
- | Incidente | operations/post-mortems/, operations/runbooks/ | Crítica | Alerta resuelta, outage |
21
- | Incidente con fix aplicable | how-to/troubleshooting.md | Alta | Fix reusable |
22
- | Incidente con config cambiada | reference/configuration.md | Alta | .env o config cambió |
23
- | Refactor | CONTEXT.md, explanation/architecture.md | Alta | Archivos renombrados/movidos |
24
- | Refactor con cambio de patrón | docs/adr/ | Alta | Patrón de diseño cambió |
25
- | Refactor que invalida ADR | ADR existente → status: deprecated | Alta | ADR ya no aplica |
26
- | Nuevo dev en equipo | tutorials/quick-start.md | Crítica si falla | Dev reporta confusión |
27
- | Nuevo dev encuentra errores | Cualquier doc afectada | Alta | Dev reporta info incorrecta |
28
- | Cambio de estilos/tokens | DESIGN.md | Crítica | CSS/theme cambió |
29
- | Cambio de estilos con nuevo componente | DESIGN.md (components) | Alta | Nuevo componente UI |
30
- | Nuevo endpoint | reference/api.md | Crítica | Nuevo archivo en routes/ |
31
- | Endpoint eliminado | reference/api.md | Crítica | Archivo eliminado de routes/ |
32
- | Endpoint modificado | reference/api.md | Crítica | Params/respuesta cambiaron |
33
- | Variable de entorno nueva | reference/configuration.md | Crítica | .env.example cambió |
34
- | Config eliminada | reference/configuration.md | Crítica | .env.example cambió |
35
- | Config con nuevo default | reference/configuration.md | Alta | Default cambió en código |
36
- | Término nuevo en dominio | CONTEXT.md | Crítica | Nuevo concepto en código |
37
- | Término eliminado | CONTEXT.md | Media | Concepto ya no existe |
38
- | Archivo de doc creado | docs/README.md | Crítica | Nuevo .md en docs/ |
39
- | Archivo de doc eliminado | docs/README.md | Crítica | .md eliminado de docs/ |
40
- | Dependencia agregada | docs/adr/ si es significativa | Alta | package.json cambió |
41
- | Dependencia eliminada | reference/ si aplica | Media | package.json cambió |
42
- | Dependencia con major upgrade | CHANGELOG.md, reference/ | Alta | package.json versión major↑ |
43
- | Schema de DB cambió | reference/database.md | Alta | Migración creada |
44
- | Nuevo evento/mensaje | reference/events.md | Alta | Nuevo tipo de evento |
45
- | Error nuevo con código | reference/errors.md | Alta | Nuevo código de error |
46
- | Proceso de deploy cambió | docs/guides/deployment.md | Crítica | CI/CD config cambió |
8
+ # Triggers — Complete Reference
9
+
10
+ ## Master Table: Event → Doc to Update
11
+
12
+ | Event | Doc to update | Priority | How to detect |
13
+ | ------------------------------- | ---------------------------------------------- | ----------------- | -------------------------------- |
14
+ | New feature | CONTEXT.md, docs/README.md, reference/ | Critical | New module/file in src/ |
15
+ | New feature with arq. decision | docs/adr/ | High | Architecture was discussed |
16
+ | New feature with new endpoint | reference/api.md | Critical | New file in routes/ |
17
+ | New feature with new UI | DESIGN.md | High | New UI component |
18
+ | Release | CHANGELOG.md, docs/guides/deployment.md | Critical | git tag created |
19
+ | Release with breaking change | CHANGELOG.md ⚠️, reference/api.md | Critical | API broke backward compatibility |
20
+ | Incident | operations/post-mortems/, operations/runbooks/ | Critical | Alert resolved, outage |
21
+ | Incident with applicable fix | how-to/troubleshooting.md | High | Reusable fix |
22
+ | Incident with changed config | reference/configuration.md | High | .env or config changed |
23
+ | Refactor | CONTEXT.md, explanation/architecture.md | High | Files renamed/moved |
24
+ | Refactor with pattern change | docs/adr/ | High | Design pattern changed |
25
+ | Refactor invalidating ADR | Existing ADR → status: deprecated | High | ADR no longer applies |
26
+ | New dev on team | tutorials/quick-start.md | Critical if fails | Dev reports confusion |
27
+ | New dev finds errors | Any affected doc | High | Dev reports incorrect info |
28
+ | Style/token change | DESIGN.md | Critical | CSS/theme changed |
29
+ | Style change with new component | DESIGN.md (components) | High | New UI component |
30
+ | New endpoint | reference/api.md | Critical | New file in routes/ |
31
+ | Endpoint removed | reference/api.md | Critical | File removed from routes/ |
32
+ | Endpoint modified | reference/api.md | Critical | Params/response changed |
33
+ | New env variable | reference/configuration.md | Critical | .env.example changed |
34
+ | Config removed | reference/configuration.md | Critical | .env.example changed |
35
+ | Config with new default | reference/configuration.md | High | Default changed in code |
36
+ | New domain term | CONTEXT.md | Critical | New concept in code |
37
+ | Term removed | CONTEXT.md | Medium | Concept no longer exists |
38
+ | Doc file created | docs/README.md | Critical | New .md in docs/ |
39
+ | Doc file deleted | docs/README.md | Critical | .md deleted from docs/ |
40
+ | Dependency added | docs/adr/ if significant | High | package.json changed |
41
+ | Dependency removed | reference/ if applicable | Medium | package.json changed |
42
+ | Dependency major upgrade | CHANGELOG.md, reference/ | High | package.json version major↑ |
43
+ | DB schema changed | reference/database.md | High | Migration created |
44
+ | New event/message | reference/events.md | High | New event type |
45
+ | New error with code | reference/errors.md | High | New error code |
46
+ | Deploy process changed | docs/guides/deployment.md | Critical | CI/CD config changed |
47
47
 
48
48
  ---
49
49
 
50
- ## Niveles de Prioridad
50
+ ## Priority Levels
51
51
 
52
- ### 🔴 CríticaActualizar inmediatamente
52
+ ### 🔴 CriticalUpdate immediately
53
53
 
54
- La documentación incorrecta causa problemas reales:
54
+ Incorrect documentation causes real problems:
55
55
 
56
- - **Sin reference/api.md actualizada** → Integradores usan endpoints incorrectos
57
- - **Sin CHANGELOG** → No se sabe qué cambió entre versiones
58
- - **CONTEXT.md incorrecto** → Términos ambiguos causan bugs de comunicación
59
- - **DESIGN.md desincronizado** → Inconsistencias visuales en producción
60
- - **configuration.md desactualizada** → Deploy con variables incorrectas
61
- - **Post-mortem no escrito** → Se repite el mismo incidente
56
+ - **Outdated reference/api.md** → Integrators use wrong endpoints
57
+ - **No CHANGELOG** → Unknown changes between versions
58
+ - **Incorrect CONTEXT.md** → Ambiguous terms cause communication bugs
59
+ - **DESYNCED DESIGN.md** → Visual inconsistencies in production
60
+ - **Outdated configuration.md** → Deploy with wrong variables
61
+ - **Missing post-mortem** → Same incident repeats
62
62
 
63
- **Tiempo esperado**: Actualizar dentro de la misma tarea/PR.
63
+ **Expected time**: Update within the same task/PR.
64
64
 
65
- ### 🟡 AltaActualizar esta semana
65
+ ### 🟡 HighUpdate this week
66
66
 
67
- La documentación faltante causa fricción pero no rompe nada:
67
+ Missing documentation causes friction but doesn't break anything:
68
68
 
69
- - **ADR faltante** → Decisiones sin contexto para nuevos devs
70
- - **How-to faltante** → Preguntas repetitivas al equipo
71
- - **Explanation faltante** → Confusión sobre decisiones pasadas
72
- - **Tutorial desactualizado** → Onboarding más lento
69
+ - **Missing ADR** → Decisions without context for new devs
70
+ - **Missing how-to** → Repetitive questions to the team
71
+ - **Missing explanation** → Confusion about past decisions
72
+ - **Outdated tutorial** → Slower onboarding
73
73
 
74
- **Tiempo esperado**: Actualizar dentro del sprint.
74
+ **Expected time**: Update within the sprint.
75
75
 
76
- ### 🟢 MediaActualizar cuando sea posible
76
+ ### 🟢 MediumUpdate when possible
77
77
 
78
- La documentación podría mejorarse pero no es urgente:
78
+ Documentation could be improved but isn't urgent:
79
79
 
80
- - **Término en CONTEXT.md que ya no aplica** → Limpieza
81
- - **Ejemplo que podría ser mejor** → Mejora incremental
82
- - **Referencia cruzada faltante** → Navegación más fácil
80
+ - **CONTEXT.md term that no longer applies** → Cleanup
81
+ - **Example that could be better** → Incremental improvement
82
+ - **Missing cross-reference** → Easier navigation
83
83
 
84
- **Tiempo esperado**: Backlog, hacer cuando haya tiempo.
84
+ **Expected time**: Backlog, do when there's time.
85
85
 
86
86
  ---
87
87
 
88
- ## Ejemplos por Trigger
88
+ ## Examples by Trigger
89
89
 
90
- ### Ejemplo 1: Post-feature — Nuevo módulo de notificaciones
90
+ ### Example 1: Post-feature — New notifications module
91
+
92
+ **Code changes**:
91
93
 
92
- **Cambios en código**:
93
94
  ```
94
95
  src/notifications/
95
- ├── notification.service.ts (nuevo)
96
- ├── notification.controller.ts (nuevo)
97
- ├── templates/ (nuevo)
98
- └── events/ (nuevo)
96
+ ├── notification.service.ts (new)
97
+ ├── notification.controller.ts (new)
98
+ ├── templates/ (new)
99
+ └── events/ (new)
99
100
  ```
100
101
 
101
102
  **Docs a actualizar**:
@@ -122,190 +123,195 @@ src/notifications/
122
123
  5. ¿ADR necesario? → Solo si la implementación implica una decisión arquitectónica
123
124
  ```
124
125
 
125
- ### Ejemplo 2: Post-release — v2.1.0
126
+ ### Example 2: Post-release — v2.1.0
126
127
 
127
- **Qué cambió**:
128
- - 3 features nuevas
129
- - 2 bugs corregidos
130
- - 1 breaking change en API
128
+ **What changed**:
131
129
 
132
- **Docs a actualizar**:
130
+ - 3 new features
131
+ - 2 bugs fixed
132
+ - 1 breaking change in API
133
+
134
+ **Docs to update**:
133
135
 
134
136
  ```markdown
135
- 1. CHANGELOG.md → Agregar entrada:
137
+ 1. CHANGELOG.md → Add entry:
136
138
 
137
139
  ## [2.1.0] - 2024-03-15
138
140
 
139
141
  ### Added
140
- - Módulo de notificaciones
141
- - Exportación a CSV
142
- - Filtros avanzados en búsqueda
142
+
143
+ - Notifications module
144
+ - CSV export
145
+ - Advanced search filters
143
146
 
144
147
  ### Changed
145
- - El endpoint /api/users ahora retorna `avatarUrl` en vez de `avatar`
148
+
149
+ - /api/users endpoint now returns `avatarUrl` instead of `avatar`
146
150
 
147
151
  ### Fixed
148
- - Timeout en queries de reportes grandes
149
- - Error 500 al crear usuario sin email
152
+
153
+ - Timeout in large report queries
154
+ - Error 500 when creating user without email
150
155
 
151
156
  ### Breaking ⚠️
152
- - GET /api/users: campo `avatar` renombrado a `avatarUrl`
153
157
 
154
- 2. reference/api.md Actualizar campo renombrado
158
+ - GET /api/users: field `avatar` renamed to `avatarUrl`
155
159
 
156
- 3. docs/guides/deployment.md → Solo si cambió el proceso de deploy
160
+ 2. reference/api.md → Update renamed field
161
+
162
+ 3. docs/guides/deployment.md → Only if deployment process changed
157
163
  ```
158
164
 
159
- ### Ejemplo 3: Post-incident — Timeout en base de datos
165
+ ### Example 3: Post-incident — Database timeout
160
166
 
161
- **Qué pasó**: La app estuvo caída 30 minutos por queries sin timeout
167
+ **What happened**: App was down for 30 minutes due to queries without timeout
162
168
 
163
- **Docs a actualizar**:
169
+ **Docs to update**:
164
170
 
165
171
  ```markdown
166
- 1. operations/post-mortems/2024-03-15-db-timeout.md → Crear post-mortem completo
172
+ 1. operations/post-mortems/2024-03-15-db-timeout.md → Create full post-mortem
167
173
 
168
- 2. reference/configuration.md → Agregar:
169
- - DB_QUERY_TIMEOUT: Timeout máximo para queries (default: 30s)
174
+ 2. reference/configuration.md → Add:
175
+ - DB_QUERY_TIMEOUT: Max query timeout (default: 30s)
170
176
 
171
- 3. how-to/troubleshooting.md → Agregar:
172
- - "Cómo diagnosticar timeouts de base de datos"
177
+ 3. how-to/troubleshooting.md → Add:
178
+ - "How to diagnose database timeouts"
173
179
 
174
- 4. operations/runbooks/database-timeout.md → Crear runbook si no existe
180
+ 4. operations/runbooks/database-timeout.md → Create runbook if it doesn't exist
175
181
  ```
176
182
 
177
- ### Ejemplo 4: Post-refactor — Renombrar UserService a AccountService
183
+ ### Example 4: Post-refactor — Rename UserService to AccountService
178
184
 
179
- **Qué cambió**: Se renombró la clase y se movió de carpeta
185
+ **What changed**: Class was renamed and moved to a different folder
180
186
 
181
- **Docs a actualizar**:
187
+ **Docs to update**:
182
188
 
183
189
  ```markdown
184
- 1. docs/CONTEXT.md → Actualizar:
185
- - UserService → AccountService (renombrado)
186
- - Marcar UserService como deprecated si hay referencia externa
190
+ 1. docs/CONTEXT.md → Update:
191
+ - UserService → AccountService (renamed)
192
+ - Mark UserService as deprecated if there are external references
187
193
 
188
- 2. docs/explanation/architecture.md → Actualizar diagramas/referencias
194
+ 2. docs/explanation/architecture.md → Update diagrams/references
189
195
 
190
- 3. reference/api.md → Verificar si endpoints cambiaron de nombre
196
+ 3. reference/api.md → Check if endpoints were renamed
191
197
 
192
- 4. docs/adr/ → ¿El refactor merece un ADR? Solo si cambió el patrón
198
+ 4. docs/adr/ → Does the refactor deserve an ADR? Only if the pattern changed
193
199
  ```
194
200
 
195
- ### Ejemplo 5: Post-design-change — Nuevo sistema de colores
201
+ ### Example 5: Post-design-change — New color system
196
202
 
197
- **Qué cambió**: Se actualizó la paleta de colores en Tailwind config
203
+ **What changed**: Color palette was updated in Tailwind config
198
204
 
199
- **Docs a actualizar**:
205
+ **Docs to update**:
200
206
 
201
207
  ```markdown
202
- 1. DESIGN.md → Usar skill doc-design para:
203
- - Re-extraer colores de Tailwind config
204
- - Actualizar sección colors en frontmatter
205
- - Verificar que los tokens de componentes siguen siendo válidos
208
+ 1. DESIGN.md → Use doc-design skill to:
209
+ - Re-extract colors from Tailwind config
210
+ - Update colors section in frontmatter
211
+ - Verify component tokens are still valid
206
212
 
207
- 2. docs/CONTEXT.md → Si hay nuevos términos de diseño
213
+ 2. docs/CONTEXT.md → If there are new design terms
208
214
 
209
- 3. CHANGELOG.md → Si el cambio es visible para usuarios
215
+ 3. CHANGELOG.md → If the change is visible to users
210
216
  ```
211
217
 
212
- ### Ejemplo 6: Post-API-change — Nuevo endpoint de búsqueda
218
+ ### Example 6: Post-API-change — New search endpoint
213
219
 
214
- **Qué cambió**: Se agregó GET /api/search con query params
220
+ **What changed**: GET /api/search was added with query params
215
221
 
216
- **Docs a actualizar**:
222
+ **Docs to update**:
217
223
 
218
224
  ```markdown
219
- 1. reference/api.md → Agregar:
225
+ 1. reference/api.md → Add:
220
226
 
221
227
  ### GET /api/search
222
228
 
223
- | Parámetro | Tipo | Requerido | Descripción |
224
- |-----------|------|-----------|-------------|
225
- | q | string | | Término de búsqueda |
226
- | limit | number | No | Resultados máximos (default: 20) |
227
- | offset | number | No | Paginación (default: 0) |
228
- | type | string | No | Filtrar por tipo (user, post, comment) |
229
+ | Parameter | Type | Required | Description |
230
+ | --------- | ------ | -------- | ------------------------------------ |
231
+ | q | string | Yes | Search term |
232
+ | limit | number | No | Max results (default: 20) |
233
+ | offset | number | No | Pagination (default: 0) |
234
+ | type | string | No | Filter by type (user, post, comment) |
229
235
 
230
- 2. docs/CONTEXT.md → Si hay términos nuevos (ej: SearchIndex, QueryParser)
236
+ 2. docs/CONTEXT.md → If there are new terms (e.g.: SearchIndex, QueryParser)
231
237
 
232
- 3. how-to/ → Si hay un flujo de uso común que documentar
238
+ 3. how-to/ → If there's a common usage flow to document
233
239
  ```
234
240
 
235
241
  ---
236
242
 
237
- ## Cómo Detectar Qué Cambió
243
+ ## How to Detect What Changed
238
244
 
239
- ### Por tipo de archivo
245
+ ### By file type
240
246
 
241
- | Archivo cambió | Qué verificar | Docs afectadas |
242
- |---------------|---------------|----------------|
243
- | `src/**/*.ts` | Nuevas clases, funciones, interfaces | CONTEXT.md, reference/ |
244
- | `src/routes/**` | Nuevos/modified endpoints | reference/api.md |
245
- | `src/components/**` | Nuevos/modified componentes | DESIGN.md |
246
- | `*.css`, `tailwind.config.*` | Tokens de diseño | DESIGN.md |
247
- | `.env*`, `config/*` | Variables de configuración | reference/configuration.md |
248
- | `migrations/**` | Cambios en schema | reference/database.md |
249
- | `docker-compose.*`, `Dockerfile*` | Cambios de infra | deployment.md |
250
- | `package.json` | Dependencias nuevas/eliminadas | docs/adr/ si es significativa |
251
- | `*.test.*` | Generalmente no afecta docs | — |
252
- | `docs/**` | Ya es doc → verificar docs/README.md | docs/README.md |
247
+ | File changed | What to check | Affected docs |
248
+ | --------------------------------- | ---------------------------------- | -------------------------- |
249
+ | `src/**/*.ts` | New classes, functions, interfaces | CONTEXT.md, reference/ |
250
+ | `src/routes/**` | New/modified endpoints | reference/api.md |
251
+ | `src/components/**` | New/modified components | DESIGN.md |
252
+ | `*.css`, `tailwind.config.*` | Design tokens | DESIGN.md |
253
+ | `.env*`, `config/*` | Configuration variables | reference/configuration.md |
254
+ | `migrations/**` | Schema changes | reference/database.md |
255
+ | `docker-compose.*`, `Dockerfile*` | Infrastructure changes | deployment.md |
256
+ | `package.json` | New/removed dependencies | docs/adr/ if significant |
257
+ | `*.test.*` | Generally doesn't affect docs | — |
258
+ | `docs/**` | Already doc → check docs/README.md | docs/README.md |
253
259
 
254
- ### Por comando git
260
+ ### By git command
255
261
 
256
262
  ```bash
257
- # Ver qué archivos cambiaron
263
+ # See what files changed
258
264
  git diff --name-only HEAD~1 HEAD
259
265
 
260
- # Ver solo archivos de código (no docs)
266
+ # See only code files (not docs)
261
267
  git diff --name-only HEAD~1 HEAD -- ':(exclude)docs/' ':(exclude)*.md'
262
268
 
263
- # Ver cambios en estilos
269
+ # See style changes
264
270
  git diff --name-only HEAD~1 HEAD -- '*.css' 'tailwind.config.*' '*.scss'
265
271
 
266
- # Ver cambios en rutas/API
272
+ # See route/API changes
267
273
  git diff --name-only HEAD~1 HEAD -- 'src/routes/' 'src/controllers/'
268
274
 
269
- # Ver cambios en config
275
+ # See config changes
270
276
  git diff --name-only HEAD~1 HEAD -- '.env*' 'config/' 'docker-compose.*'
271
277
  ```
272
278
 
273
279
  ---
274
280
 
275
- ## Patrones de Actualización por Lotes
281
+ ## Batch Update Patterns
276
282
 
277
- ### Fin de sprint
283
+ ### End of sprint
278
284
 
279
285
  ```
280
286
  1. git diff --name-only sprint-start..sprint-end
281
- 2. Agrupar por tipo: features, fixes, refactors, config
282
- 3. Para cada grupo, aplicar los triggers correspondientes
283
- 4. Actualizar CHANGELOG.md con TODO lo del sprint
284
- 5. Ejecutar doc-review al final
287
+ 2. Group by type: features, fixes, refactors, config
288
+ 3. For each group, apply the corresponding triggers
289
+ 4. Update CHANGELOG.md with EVERYTHING from the sprint
290
+ 5. Run doc-review at the end
285
291
  ```
286
292
 
287
- ### Post-merge de múltiples PRs
293
+ ### Post-merge of multiple PRs
288
294
 
289
295
  ```
290
- 1. Listar PRs mergeados desde la última actualización
291
- 2. Para cada PR, identificar el trigger
292
- 3. Acumular cambios por doc afectada
293
- 4. Actualizar cada doc UNA VEZ con todos los cambios
294
- 5. No actualizar el mismo doc múltiples veces
296
+ 1. List PRs merged since last update
297
+ 2. For each PR, identify the trigger
298
+ 3. Accumulate changes by affected doc
299
+ 4. Update each doc ONCE with all changes
300
+ 5. Don't update the same doc multiple times
295
301
  ```
296
302
 
297
- ### Hotfix en producción
303
+ ### Hotfix in production
298
304
 
299
305
  ```
300
- 1. El hotfix es prioridad CRÍTICA
301
- 2. Actualizar CHANGELOG.md inmediatamente
302
- 3. Actualizar reference/ si afecta API
303
- 4. Crear post-mortem si fue incidente
306
+ 1. The hotfix is CRITICAL priority
307
+ 2. Update CHANGELOG.md immediately
308
+ 3. Update reference/ if it affects API
309
+ 4. Create post-mortem if it was an incident
304
310
  5. doc-review post-hotfix
305
311
  ```
306
312
 
307
313
  ---
308
314
 
309
- ## Regla de Oro
315
+ ## Golden Rule
310
316
 
311
- **Si cambiaste código, cambiaste documentación. Si no actualizaste la documentación, la tarea no está terminada.**
317
+ **If you changed code, you changed documentation. If you didn't update the documentation, the task is not done.**
@@ -10,7 +10,7 @@ description: >
10
10
  license: Apache-2.0
11
11
  metadata:
12
12
  author: damenordev
13
- version: "1.0"
13
+ version: '1.0'
14
14
  ---
15
15
 
16
16
  # doc-review
@@ -29,13 +29,13 @@ metadata:
29
29
 
30
30
  It's not enough to ask "does the file exist?". Check:
31
31
 
32
- | Issue | What to look for |
33
- |-------|------------------|
34
- | Empty docs | Files with only frontmatter and title |
35
- | Stale docs | Files without `last-reviewed` in >3 months |
36
- | TODO/TBD | Search for `TODO`, `TBD`, `FIXME`, `PENDING` in content |
37
- | Placeholder | Search for "pending content", "add here", empty sections |
38
- | Broken wikilinks | `[[link]]` that doesn't resolve to an existing file |
32
+ | Issue | What to look for |
33
+ | ---------------- | -------------------------------------------------------- |
34
+ | Empty docs | Files with only frontmatter and title |
35
+ | Stale docs | Files without `last-reviewed` in >3 months |
36
+ | TODO/TBD | Search for `TODO`, `TBD`, `FIXME`, `PENDING` in content |
37
+ | Placeholder | Search for "pending content", "add here", empty sections |
38
+ | Broken wikilinks | `[[link]]` that doesn't resolve to an existing file |
39
39
 
40
40
  ### RULE #2: Validate Diátaxis coverage
41
41
 
@@ -90,6 +90,7 @@ If an entire quadrant is missing, it is a CRITICAL gap.
90
90
  ### 1. Completeness
91
91
 
92
92
  **What to check**:
93
+
93
94
  - Documentation files that should exist but don't
94
95
  - Empty sections within existing files
95
96
  - Code features without corresponding documentation
@@ -105,6 +106,7 @@ If an entire quadrant is missing, it is a CRITICAL gap.
105
106
  ### 2. Currency
106
107
 
107
108
  **What to check**:
109
+
108
110
  - Files not updated in >3 months (check if relevant code changed)
109
111
  - References to obsolete versions/libraries
110
112
  - CHANGELOG.md outdated vs git tags
@@ -120,6 +122,7 @@ If an entire quadrant is missing, it is a CRITICAL gap.
120
122
  ### 3. Consistency
121
123
 
122
124
  **What to check**:
125
+
123
126
  - CONTEXT.md vs code: terms match
124
127
  - DESIGN.md vs styles: tokens match
125
128
  - ADRs vs implementation: what the ADR says is what's in code
@@ -137,6 +140,7 @@ If an entire quadrant is missing, it is a CRITICAL gap.
137
140
  ### 4. Coverage
138
141
 
139
142
  **What to check**:
143
+
140
144
  - Diátaxis: all 4 quadrants are covered
141
145
  - Features: each public feature has at least one associated doc
142
146
  - API: all endpoints are documented
@@ -153,6 +157,7 @@ If an entire quadrant is missing, it is a CRITICAL gap.
153
157
  ### 5. Quality
154
158
 
155
159
  **What to check**:
160
+
156
161
  - Real content vs placeholder (no TODO, no "pending")
157
162
  - Clear and correct writing
158
163
  - Runnable examples in tutorials/how-tos
@@ -176,12 +181,12 @@ Total score = Completeness (30) + Currency (20) + Consistency (20) + Coverage (2
176
181
 
177
182
  ### Scale
178
183
 
179
- | Score | Status | Action |
180
- |-------|--------|--------|
181
- | 90-100 | 🟢 Healthy | Maintain, periodic review |
182
- | 70-89 | 🟡 Acceptable | Prioritized improvements identified |
183
- | 50-69 | 🟠 Deficient | Requires significant work |
184
- | 0-49 | 🔴 Critical | Fundamental documentation missing |
184
+ | Score | Status | Action |
185
+ | ------ | ------------- | ----------------------------------- |
186
+ | 90-100 | 🟢 Healthy | Maintain, periodic review |
187
+ | 70-89 | 🟡 Acceptable | Prioritized improvements identified |
188
+ | 50-69 | 🟠 Deficient | Requires significant work |
189
+ | 0-49 | 🔴 Critical | Fundamental documentation missing |
185
190
 
186
191
  ## Report Format
187
192
 
@@ -194,14 +199,14 @@ Total score = Completeness (30) + Currency (20) + Consistency (20) + Coverage (2
194
199
 
195
200
  ## Summary by Dimension
196
201
 
197
- | Dimension | Score | Maximum |
198
- |-----------|-------|---------|
199
- | Completeness | 22 | 30 |
200
- | Currency | 15 | 20 |
201
- | Consistency | 14 | 20 |
202
- | Coverage | 12 | 20 |
203
- | Quality | 9 | 10 |
204
- | **Total** | **72** | **100** |
202
+ | Dimension | Score | Maximum |
203
+ | ------------ | ------ | ------- |
204
+ | Completeness | 22 | 30 |
205
+ | Currency | 15 | 20 |
206
+ | Consistency | 14 | 20 |
207
+ | Coverage | 12 | 20 |
208
+ | Quality | 9 | 10 |
209
+ | **Total** | **72** | **100** |
205
210
 
206
211
  ## Critical Issues 🔴
207
212
 
@@ -222,18 +227,18 @@ Total score = Completeness (30) + Currency (20) + Consistency (20) + Coverage (2
222
227
 
223
228
  ## Detail by File
224
229
 
225
- | File | Status | Issues |
226
- |------|--------|--------|
227
- | README.md | ✅ OK | — |
228
- | CHANGELOG.md | ⚠️ Outdated | Missing release 2.1.0 |
229
- | docs/CONTEXT.md | ⚠️ Incomplete | 5 terms missing |
230
- | docs/DESIGN.md | 🔴 Out of sync | 3 tokens don't match |
231
- | docs/README.md | ✅ OK | — |
232
- | reference/api.md | 🔴 Missing | Does not exist |
233
- | tutorials/ | ✅ OK | — |
234
- | how-to/ | ⚠️ Empty | No content |
235
- | explanation/ | ✅ OK | — |
236
- | docs/adr/ | ⚠️ Incomplete | 3 ADRs without status |
230
+ | File | Status | Issues |
231
+ | ---------------- | -------------- | --------------------- |
232
+ | README.md | ✅ OK | — |
233
+ | CHANGELOG.md | ⚠️ Outdated | Missing release 2.1.0 |
234
+ | docs/CONTEXT.md | ⚠️ Incomplete | 5 terms missing |
235
+ | docs/DESIGN.md | 🔴 Out of sync | 3 tokens don't match |
236
+ | docs/README.md | ✅ OK | — |
237
+ | reference/api.md | 🔴 Missing | Does not exist |
238
+ | tutorials/ | ✅ OK | — |
239
+ | how-to/ | ⚠️ Empty | No content |
240
+ | explanation/ | ✅ OK | — |
241
+ | docs/adr/ | ⚠️ Incomplete | 3 ADRs without status |
237
242
  ```
238
243
 
239
244
  ## Review Process