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: >4 Documentación senior — multi-archivo, Google-style docstrings, ADR.5 GATE OBLIGATORIO post-task: revisar si hay que actualizar docs del proyecto.6 Trigger: Siempre después de cada task (revisar si docs cambiaron),7 o al escribir documentación/generar docstrings/estructurar docs.8license: MIT9metadata:10 source: https://skillmd.com/skills/leandrobenjaminl/lend-ai-docs11 author: Leandro Benjamin L.12 version: "3.0"13---1415# Skill: lend-ai-docs1617Documentación senior. Código sin docs es deuda técnica.1819## Trigger (SIEMPRE post-task)2021- **Terminaste de trabajar → revisá si hay docs que actualizar**22- Creaste o modificaste una función pública → docstring23- Cambiaste estructura, agregaste features, modificaste AGENTS.md24- Tomaste una decisión de arquitectura → ADR25- El proyecto no tiene documentación → arrancala2627## Post-Task Docs Review (GATE OBLIGATORIO)2829Después de CADA task, antes de commit, revisá:3031```321. ¿Cambió la estructura del proyecto?33 ├── Nuevo agente/skill → AGENTS.md34 ├── Nueva feature pública → README35 └── Cambio arquitectónico → ARCHITECTURE.md36372. ¿Cambió la funcionalidad?38 ├── Nueva API/ruta → README o docs de la API39 ├── Nueva funcionalidad visible → CHANGELOG40 └── Nuevo flag de configuración → README41423. ¿Decisión técnica con tradeoffs?43 └── ADR en docs/adr/ (fecha, contexto, opciones, decisión)44454. Si no hay nada que actualizar → seguí tranqui46```4748## Workflow LEND49501. ANALIZAR51 ├── Tipo: docstring (API pública), README (proyecto), ADR (decisión), guía (cómo usar)52 ├── Audiencia: ¿desarrollador, usuario, operador?53 ├── Estado: ¿docs desde cero o actualizar existentes?54 └── Lenguaje: inglés técnico US para código y commits55562. REVISAR (post-task automático, sin menú)57 ├── ¿Hay cambios que afectan docs? (ver checklist arriba)58 ├── Si NO → seguí59 └── Si SÍ → determinar qué docs tocar60613. HACER62 ├── Google-style: Args, Returns, Raises, Examples (cuando aplica)63 ├── README: qué hace, cómo instalar, cómo usar, configuración64 ├── ARCHITECTURE: estructura, agentes, skills, decisiones técnicas65 ├── ADR: título, contexto, opciones, decisión, consecuencias66 └── Inglés técnico US, claro y directo67684. VERIFICAR69 ├── La documentación es útil sin leer el código70 ├── Los ejemplos funcionan (ejecutables)71 └── No hay información desactualizada7273## Cognitive Load Patterns (diseñar docs que reduzcan carga mental)7475| Patrón | Regla |76|--------|-------|77| **Lead with answer** | Empezá con el outcome, no con el viaje. El lector necesita saber YA qué resuelve esto. |78| **Progressive disclosure** | Mostrá lo esencial primero. Detalles y edge cases después, colapsados o linkeados. |79| **Chunking** | Agrupá en secciones de 3-5 ítems. Nadie procesa una pared de texto. |80| **Signposting** | Cada sección anticipa qué vas a encontrar. "Esto cubre: instalación, configuración, primeros pasos." |81| **Recognition over recall** | No hagas que el lector recuerde info de 3 secciones atrás. Repetí o linkeá. |82| **Review empathy** | Diseñá para el que revisa tu PR: qué leer primero, qué está out of scope, cómo llegaste acá. |8384## Default doc shape8586```87# Outcome Title (lo que se logra, no lo que se hace)8889## Quick path (2-3 pasos para el 80% de los casos)9091## Details table (para el 20% que necesita más)9293| Qué | Cómo | Cuándo |94|-----|------|--------|95| ... | ... | ... |9697## Checklist (accionable, con checkboxes)9899- [ ] Step 1100- [ ] Step 2101102## Next step (una sola acción clara)103```104105## PR review doc guidelines106107- **What to review first**: los archivos de alto impacto, con justificación108- **What's out of scope**: lo que NO está en este PR (no hagas adivinar al reviewer)109- **Chain context**: si esto es parte de una cadena de PRs, linkealos110- **Test plan**: qué se testeó manualmente y qué automáticamente