CommunityProgramación y desarrollogithub.com

Juan23/docdiet

Realiza una revisión y actualización de documentación bajo demanda y acotada, manteniendo la documentación canónica precisa y concisa.

¿Qué es docdiet?

Este skill está diseñado para ejecutar revisiones y actualizaciones puntuales de documentación únicamente cuando el usuario lo solicita explícitamente, normalmente invocando `$docdiet`. No se activa automáticamente, sino que actúa bajo demanda sobre el alcance definido por el usuario. Su propósito es mantener la documentación canónica precisa y concisa, evitando auditorías o cambios no solicitados. Soporta archivos `.md`, `.mdx`, `.rst` y `.adoc`, además de `README*` y `CONTRIBUTING*` en la raíz del repositorio, con exclusiones claras para contenido generado, versiones, licencias, etc. Su enfoque es reemplazar texto obsoleto en lugar de acumular, limpiar solo lo que la tarea expone y no expandir el alcance más allá de lo autorizado. También incluye protecciones especiales para archivos marcados con `disable-agentic-editing: true` en su frontmatter.

Compatible con~Claude Code~Codex CLI~Cursor✓Antigravity
npx skills add https://github.com/Juan23/lean-skills/tree/main/skills/docdiet

Installed? Explore more Programación y desarrollo skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

$docdiet

Usa este skill solo cuando el usuario solicite explícitamente una revisión, limpieza o actualización de documentación (normalmente invocando $docdiet). Es un skill independiente y bajo demanda, no un enlace automático por tarea. Revisa o actualiza únicamente el alcance de documentación mencionado por el usuario o claramente expuesto por el cambio solicitado; no inicies una auditoría no relacionada.

Una solicitud explícita como $docdiet all docs o $docdiet project-wide autoriza un pase acotado a nivel de proyecto. En ese modo, el alcance se limita a archivos de documentación bajo la raíz del repositorio con extensiones .md, .mdx, .rst o .adoc, además de los archivos README* y CONTRIBUTING* en la raíz. Excluye directorios y archivos generados o provenientes de terceros, registros de cambios/notas de publicación, licencias o material legal, códigos de conducta y archivos protegidos del repositorio. El descubrimiento se limita a un listado rg --files usando esas extensiones y exclusiones, con un máximo de 200 rutas; inspecciona solo las rutas devueltas por ese listado. Usa como máximo una búsqueda de referencia adicional exacta y con límite de rutas (rg -l -F) para un concepto público modificado. Si se alcanza el límite o el límite de búsqueda, informa el resto no revisado en lugar de expandir el alcance.

Reglas de decisión

  1. Filtrar alcance primero. Si no se menciona ningún archivo de documentación o sección, no se está tocando documentación, y ninguna renombración/eliminación pública necesita una verificación de referencia, detente. No inspecciones documentación para decidir si inspeccionar documentación.
  2. Editar la fuente canónica. Documenta solo información duradera que desarrolladores, usuarios, operadores o mantenedores necesiten: contratos, configuración, operaciones, restricciones, invariantes, comportamiento no obvio, migraciones y advertencias críticas. Omite trivialidades de implementación, estado temporal, historial de depuración, hechos inferidos y resúmenes de finalización.
  3. Reemplazar, no acumular. Actualiza la explicación existente, elimina texto obsoleto y enlaza a una fuente canónica cuando otro documento necesite una referencia. Mantén detalles históricos solo para migración, compatibilidad o justificación arquitectónica.
  4. Mantener la limpieza local. Al editar un archivo de documentación, limpia solo la sección tocada y el texto cercano que tenga evidencia clara de estar desactualizado, duplicado, contradictorio, reemplazado, engañoso, innecesariamente verboso o vinculado al concepto modificado/eliminado. Si la evidencia requiere una investigación sustancial, déjalo como está.
  5. Acotar búsquedas de referencia. Para un concepto público renombrado, eliminado o modificado, se permite como máximo una búsqueda exacta con límite de rutas. Prefiere rg -l -F con patrones de documentación e informa solo los nombres de archivo, no las líneas completas coincidentes. Fuera del modo explícito de proyecto completo descrito anteriormente, no inventaries documentos no relacionados, explores árboles de documentación, ejecutes verificaciones de enlaces en todo el repositorio, investigues historial no relacionado ni crees un agente de limpieza.
  6. Crear archivos raramente. Agrega un archivo de documentación solo para información duradera y distinta sin un hogar canónico adecuado ya conocido por la tarea.

Protección

No reescribas oportunistamente documentos generados, registros de cambios/notas de publicación, licencias o material legal, códigos de conducta, documentación de terceros o archivos protegidos del repositorio. Respeta las instrucciones del repositorio y preserva el frontmatter y metadatos significativos.

Si un archivo Markdown contiene:

---
disable-agentic-editing: true
---

no lo modifiques a menos que el usuario solicite explícitamente ese archivo. Este marcador es una convención de docdiet: ninguna herramienta lo impone, las instrucciones del repositorio no pueden eliminar su protección, y solo una solicitud explícita de ese archivo la anula. Verifica la protección solo para archivos candidatos; no escanees el repositorio en busca de marcadores.

Finalización

Si se tocó documentación, verifica estáticamente solo el archivo/sección tocado: el comportamiento final está documentado donde sea necesario, el texto obsoleto se eliminó solo con evidencia, los ejemplos y comandos aún coinciden con la implementación, y el contenido protegido no se modificó. En modo de proyecto completo, aplica estas verificaciones a cada archivo tocado; no amplíes la validación a una verificación de enlaces o ejemplos en todo el repositorio. No ejecutes ejemplos o comandos a menos que la tarea de implementación ya lo requiera. Luego detente.

Documenta lo que perdura. Reemplaza en lugar de acumular. Limpia lo que la tarea expone. No caces.

Skills relacionados