Cluedoc: una habilidad de agente para redactar documentación que ayuda a entender el codebase

¿Están cansados del código que los agentes de programación generan sin parar? ¿Ya se rindieron con eso de entender su software?

Cuando un agente escribe el código, entenderlo se vuelve la tarea más importante. Si ustedes no teclearon ni una sola línea y el codebase sigue cambiando, ¿cómo saben qué hace realmente el sistema y si la siguiente modificación es segura? Aunque el agente haga el trabajo por ustedes, para guiarlo en la dirección correcta hace falta al menos una comprensión mínima del sistema que están construyendo.

Por eso creamos Cluedoc. Cluedoc es una Agent Skill que hace que los agentes de programación redacten documentos fáciles de leer para personas. La documentación de Cluedoc está hecha para ser leída. Se enfoca en conceptos de alto nivel, dejando fuera los detalles demasiado técnicos.

Cluedoc ve el sistema como un árbol de funcionalidades (feature) y escribe un documento (paper) por cada funcionalidad. Los documentos existen dentro del codebase como Markdown puro y se mantienen siempre actualizados dentro del loop de trabajo. No hace falta servidor ni base de datos.

La landing page enlazada es en sí misma un documento de Cluedoc sobre Cluedoc. También hay documentos de ejemplo generados para Flask, Cobra y Commander, así que vale la pena echarles un vistazo.