Extrae decisiones arquitectónicas, contratos de API y patrones de uso directamente del código para producir documentación precisa que se mantiene en sync con la implementación. Documentation-from-code trata el código como la fuente de verdad y genera prosa desde él en lugar de mantener documentación como un artefacto separado que diverge con el tiempo.
Casos de uso
- Generando documentación de referencia de API desde specs de OpenAPI o anotaciones de código automáticamente en lugar de escribirla a mano
- Manteneiendo archivos README que describen accurately el codebase después de refactors sin actualización manual
- Creando architecture decision records (ADRs) desde patrones de código e historial de commits cuando la justificación de la decisión original no está documentada
- Onboarding un nuevo ingeniero y queriendo documentación automatizada precisa que refleje el estado actual del codebase en lugar del estado de hace seis meses
- Produciendo guías de uso desde code examples embebidos en tests o archivos de ejemplo
Funciones principales
- Parsea function signatures, type annotations y code comments para extraer la superficie de API pública y su comportamiento documentado
- Extrae patrones de uso de API desde archivos de test y code examples, identificando las formas más comunes y recomendadas de usar cada función
- Genera draft de documentación en el formato target (Markdown, OpenAPI, README) directamente desde el código parseado
- Verifica la documentación generada contra el comportamiento actual del código ejecutando los ejemplos documentados y confirmando que todavía funcionan
- Configura un check de CI que falla cuando la documentación generada está fuera de sync con el código, enforceando que la documentación no puede quedarse atrás
Relacionados
Relacionados
3 Entradas indexadas
Receiving code review
Estructura cómo respondes al feedback de revisión de código para que el proceso de revisión se mantenga enfocado, respetuoso y productivo. Esta habilidad separa feedback sustantivo de-nitpicks, rastrea seguimientos sin perderlos y produce un registro que hace los merges más rápidos y los post-mortems más claros.
Requesting code review
Enmarca un pull request para que los revisores entiendan el perfil de riesgo, qué ha sido probado y dónde enfocar su atención limitada. Esto produce revisiones más rápidas y útiles porque los revisores pasan menos tiempo reconstruyendo contexto y más tiempo evaluando los cambios reales.
AI product requirement writing
Escribe documentos de requisitos de producto que agentes de IA pueden actuar fiablemente, con restricciones explícitas, casos edge y criterios de aceptación que minimizan la brecha entre lo que quieres y lo que el agente construye. Esta habilidad cierra la ambigüedad de specs de producto en lenguaje natural y la precisión que los agentes de IA requieren para producir resultados consistentes.