Skill: lend-ai-docs
Documentación senior. Código sin docs es deuda técnica.
Trigger (SIEMPRE post-task)
- Terminaste de trabajar → revisá si hay docs que actualizar
- Creaste o modificaste una función pública → docstring
- Cambiaste estructura, agregaste features, modificaste AGENTS.md
- Tomaste una decisión de arquitectura → ADR
- El proyecto no tiene documentación → arrancala
Post-Task Docs Review (GATE OBLIGATORIO)
Después de CADA task, antes de commit, revisá:
1. ¿Cambió la estructura del proyecto?
├── Nuevo agente/skill → AGENTS.md
├── Nueva feature pública → README
└── Cambio arquitectónico → ARCHITECTURE.md
2. ¿Cambió la funcionalidad?
├── Nueva API/ruta → README o docs de la API
├── Nueva funcionalidad visible → CHANGELOG
└── Nuevo flag de configuración → README
3. ¿Decisión técnica con tradeoffs?
└── ADR en docs/adr/ (fecha, contexto, opciones, decisión)
4. Si no hay nada que actualizar → seguí tranqui
Workflow LEND
ANALIZAR
├── Tipo: docstring (API pública), README (proyecto), ADR (decisión), guía (cómo usar)
├── Audiencia: ¿desarrollador, usuario, operador?
├── Estado: ¿docs desde cero o actualizar existentes?
└── Lenguaje: inglés técnico US para código y commits
REVISAR (post-task automático, sin menú)
├── ¿Hay cambios que afectan docs? (ver checklist arriba)
├── Si NO → seguí
└── Si SÍ → determinar qué docs tocar
HACER
├── Google-style: Args, Returns, Raises, Examples (cuando aplica)
├── README: qué hace, cómo instalar, cómo usar, configuración
├── ARCHITECTURE: estructura, agentes, skills, decisiones técnicas
├── ADR: título, contexto, opciones, decisión, consecuencias
└── Inglés técnico US, claro y directo
VERIFICAR
├── La documentación es útil sin leer el código
├── Los ejemplos funcionan (ejecutables)
└── No hay información desactualizada
Cognitive Load Patterns (diseñar docs que reduzcan carga mental)
| Patrón |
Regla |
| Lead with answer |
Empezá con el outcome, no con el viaje. El lector necesita saber YA qué resuelve esto. |
| Progressive disclosure |
Mostrá lo esencial primero. Detalles y edge cases después, colapsados o linkeados. |
| Chunking |
Agrupá en secciones de 3-5 ítems. Nadie procesa una pared de texto. |
| Signposting |
Cada sección anticipa qué vas a encontrar. "Esto cubre: instalación, configuración, primeros pasos." |
| Recognition over recall |
No hagas que el lector recuerde info de 3 secciones atrás. Repetí o linkeá. |
| Review empathy |
Diseñá para el que revisa tu PR: qué leer primero, qué está out of scope, cómo llegaste acá. |
Default doc shape
# Outcome Title (lo que se logra, no lo que se hace)
## Quick path (2-3 pasos para el 80% de los casos)
## Details table (para el 20% que necesita más)
| Qué | Cómo | Cuándo |
|-----|------|--------|
| ... | ... | ... |
## Checklist (accionable, con checkboxes)
- [ ] Step 1
- [ ] Step 2
## Next step (una sola acción clara)
PR review doc guidelines
- What to review first: los archivos de alto impacto, con justificación
- What's out of scope: lo que NO está en este PR (no hagas adivinar al reviewer)
- Chain context: si esto es parte de una cadena de PRs, linkealos
- Test plan: qué se testeó manualmente y qué automáticamente
1---2name: lend-ai-docs3description: Generates and maintains project documentation: Google-style docstrings, README, architecture docs, and ADRs, with a mandatory post-task review gate to keep docs current.4license: MIT5---67# Skill: lend-ai-docs89Documentación senior. Código sin docs es deuda técnica.1011## Trigger (SIEMPRE post-task)1213- **Terminaste de trabajar → revisá si hay docs que actualizar**14- Creaste o modificaste una función pública → docstring15- Cambiaste estructura, agregaste features, modificaste AGENTS.md16- Tomaste una decisión de arquitectura → ADR17- El proyecto no tiene documentación → arrancala1819## Post-Task Docs Review (GATE OBLIGATORIO)2021Después de CADA task, antes de commit, revisá:2223```241. ¿Cambió la estructura del proyecto?25 ├── Nuevo agente/skill → AGENTS.md26 ├── Nueva feature pública → README27 └── Cambio arquitectónico → ARCHITECTURE.md28292. ¿Cambió la funcionalidad?30 ├── Nueva API/ruta → README o docs de la API31 ├── Nueva funcionalidad visible → CHANGELOG32 └── Nuevo flag de configuración → README33343. ¿Decisión técnica con tradeoffs?35 └── ADR en docs/adr/ (fecha, contexto, opciones, decisión)36374. Si no hay nada que actualizar → seguí tranqui38```3940## Workflow LEND41421. ANALIZAR43 ├── Tipo: docstring (API pública), README (proyecto), ADR (decisión), guía (cómo usar)44 ├── Audiencia: ¿desarrollador, usuario, operador?45 ├── Estado: ¿docs desde cero o actualizar existentes?46 └── Lenguaje: inglés técnico US para código y commits47482. REVISAR (post-task automático, sin menú)49 ├── ¿Hay cambios que afectan docs? (ver checklist arriba)50 ├── Si NO → seguí51 └── Si SÍ → determinar qué docs tocar52533. HACER54 ├── Google-style: Args, Returns, Raises, Examples (cuando aplica)55 ├── README: qué hace, cómo instalar, cómo usar, configuración56 ├── ARCHITECTURE: estructura, agentes, skills, decisiones técnicas57 ├── ADR: título, contexto, opciones, decisión, consecuencias58 └── Inglés técnico US, claro y directo59604. VERIFICAR61 ├── La documentación es útil sin leer el código62 ├── Los ejemplos funcionan (ejecutables)63 └── No hay información desactualizada6465## Cognitive Load Patterns (diseñar docs que reduzcan carga mental)6667| Patrón | Regla |68|--------|-------|69| **Lead with answer** | Empezá con el outcome, no con el viaje. El lector necesita saber YA qué resuelve esto. |70| **Progressive disclosure** | Mostrá lo esencial primero. Detalles y edge cases después, colapsados o linkeados. |71| **Chunking** | Agrupá en secciones de 3-5 ítems. Nadie procesa una pared de texto. |72| **Signposting** | Cada sección anticipa qué vas a encontrar. "Esto cubre: instalación, configuración, primeros pasos." |73| **Recognition over recall** | No hagas que el lector recuerde info de 3 secciones atrás. Repetí o linkeá. |74| **Review empathy** | Diseñá para el que revisa tu PR: qué leer primero, qué está out of scope, cómo llegaste acá. |7576## Default doc shape7778```79# Outcome Title (lo que se logra, no lo que se hace)8081## Quick path (2-3 pasos para el 80% de los casos)8283## Details table (para el 20% que necesita más)8485| Qué | Cómo | Cuándo |86|-----|------|--------|87| ... | ... | ... |8889## Checklist (accionable, con checkboxes)9091- [ ] Step 192- [ ] Step 29394## Next step (una sola acción clara)95```9697## PR review doc guidelines9899- **What to review first**: los archivos de alto impacto, con justificación100- **What's out of scope**: lo que NO está en este PR (no hagas adivinar al reviewer)101- **Chain context**: si esto es parte de una cadena de PRs, linkealos102- **Test plan**: qué se testeó manualmente y qué automáticamente
LeandroBenjaminL