Saltar a contenido

Doc-Gen

Plugin generico de documentacion automatizada para cualquier proyecto del ecosistema Inteliside o proyecto externo. Detecta automaticamente el tipo de proyecto (marketplace, SDD o generico), audita la documentacion existente contra el codigo real, y genera o actualiza documentacion dual: legible para humanos con parrafos narrativos y parseable por agentes de IA con tablas estructuradas y frontmatter semantico. Todo en espanol por defecto.

Prerequisitos

  • Claude Code con soporte de plugins
  • Acceso de lectura al proyecto a documentar

Opcionales (enriquecen la documentacion)

  • Engram -- si esta configurado, doc-gen consulta decisiones y convenciones guardadas en memoria persistente
  • GitHub CLI (gh) -- para generar changelogs desde git history

Skills

El plugin expone 6 skills que cubren todo el ciclo de vida de la documentacion: desde la auditoria inicial hasta la sincronizacion continua. Cada skill detecta automaticamente el tipo de proyecto y adapta su comportamiento.

Skill Descripcion Invocacion Tools permitidos
doc-auditar Detecta tipo de proyecto, compara docs existentes vs codigo real. Genera reporte de gaps, docs desactualizados, huerfanos y faltantes. /doc-gen:doc-auditar Read, Glob, Grep, Bash, Write
doc-modulo Genera o actualiza documentacion de un modulo, plugin, feature o componente especifico. Produce doc dual humano + agente IA con frontmatter semantico. /doc-gen:doc-modulo [path] Read, Glob, Grep, Write
doc-proyecto Genera documentacion completa del proyecto: index, arquitectura, docs de cada modulo/plugin y glosario. Usa subagentes para paralelizar. /doc-gen:doc-proyecto Read, Glob, Grep, Bash, Agent, Write
doc-catalogo Genera indice de documentacion. En marketplace lista plugins, en proyecto lista modulos/features. Produce docs/index.md. /doc-gen:doc-catalogo Read, Glob, Grep, Write
doc-changelog Genera changelog desde git log entre tags o fechas. Agrupa commits por plugin/modulo y tipo (feat, fix, chore). /doc-gen:doc-changelog [desde] [hasta] Read, Glob, Grep, Bash, Write
doc-sync Re-sincroniza toda la documentacion contra el estado actual del codigo. Detecta docs desactualizados y los regenera. /doc-gen:doc-sync Read, Glob, Grep, Bash, Write

Notas de frontmatter: - Los 6 skills usan context: fork para aislamiento de contexto. - doc-auditar, doc-modulo, doc-proyecto y doc-sync declaran model: sonnet (requieren razonamiento sobre estructura). - doc-catalogo y doc-changelog declaran model: haiku (tareas mas simples de lectura y formateo). - Solo doc-proyecto tiene Agent en allowed-tools — lanza subagentes con tools restringidos (Read, Glob, Grep, Write) para paralelizar generacion de docs de plugins/modulos. - Todos los skills tienen user-invocable: true.

Flujo de trabajo

El flujo tipico depende de la fase del proyecto. Doc-gen detecta automaticamente el modo de operacion basandose en la estructura del proyecto.

Modos de deteccion automatica

Doc-gen examina la estructura del proyecto para determinar que documentar y como:

Modo Como lo detecta Que documenta
marketplace Existe .claude-plugin/marketplace.json Plugins, skills, agents, contratos, references
proyecto-sdd Existe .sdd/ o specs SDD en Engram Features, specs, diseno, arquitectura
proyecto-generico Fallback Estructura de archivos, dependencias, modulos, CLAUDE.md

Flujo recomendado

  1. Primera vez en un proyecto: /doc-gen:doc-proyecto -- genera documentacion completa
  2. Despues de implementar una feature: /doc-gen:doc-modulo {path} -- actualiza doc del modulo afectado
  3. Verificacion periodica: /doc-gen:doc-sync -- detecta docs desactualizados y los regenera
  4. Antes de un release: /doc-gen:doc-changelog -- genera changelog desde git
  5. Para navegar la documentacion: /doc-gen:doc-catalogo -- genera o actualiza el indice

Integracion con otros plugins

Doc-gen se complementa con cada plugin del ecosistema en momentos especificos del ciclo de desarrollo:

Plugin Cuando usar doc-gen
SDD-Wizards Despues del PRD wizard -> doc-gen genera la doc inicial del proyecto
ATL Inteliside Despues de implementar una feature -> doc-gen actualiza la doc del modulo
SDD-Legacy Despues del onboarding -> doc-gen documenta el baseline del legacy
RE-Wizard Despues de ingenieria inversa -> doc-gen crea la doc del proyecto target
UX-Studio Despues del Design Spec -> doc-gen documenta el design system
N8N-Studio Despues de crear workflows -> doc-gen documenta las automatizaciones

Contratos de datos

Engram

Sin contrato formal documentado. Doc-gen consulta Engram de forma oportunista: si esta configurado, lee decisiones y convenciones para enriquecer la documentacion generada.

GitHub

Sin contrato formal documentado. Doc-gen usa gh CLI opcionalmente para obtener git history al generar changelogs.

Hooks

El plugin incluye un hook que sugiere actualizar la documentacion cuando se modifican archivos relevantes de plugins.

Evento Matcher Tipo Timeout Descripcion
PostToolUse Write prompt 15s Despues de escribir un archivo, si es un SKILL.md, agent .md, plugin.json o README.md de un plugin, sugiere correr /doc-gen:doc-modulo {path} para mantener la documentacion al dia. Si el archivo no es relevante, no dice nada.

Formato de salida

Toda la documentacion generada por doc-gen sigue un estandar dual humano + agente IA con estas caracteristicas:

  • Frontmatter YAML con metadata semantica: tipo, cubre, no-cubre, depende-de, relacionado
  • Parrafo narrativo seguido de tabla estructurada en cada seccion (narrativa para el humano, tabla para el agente)
  • Headings de nivel 2 (##) predecibles para navegacion programatica
  • Marca temporal (actualizado: YYYY-MM-DD) en cada documento

Configuracion para proyectos

Copiar plugins/doc-gen/examples/CLAUDE.md a la raiz del proyecto. La configuracion incluye:

doc-gen:
  idioma: es                    # es | en
  directorio: docs/             # donde genera la documentacion
  incluir-changelog: true       # generar changelog desde git
  incluir-engram: true          # enriquecer con memoria de Engram
  excluir:                      # paths a ignorar
    - node_modules/
    - dist/
    - .git/

Invocacion del plugin:

# Como parte del marketplace
claude --plugin-dir ./plugins/doc-gen

# Combinado con otros plugins
claude --plugin-dir ./plugins/doc-gen --plugin-dir ./plugins/atl-inteliside

Limitaciones conocidas

  • No tiene agentes (subagentes) -- todos los skills corren en el contexto principal; los que usan Agent en tools pueden delegar lecturas pero no tienen agentes dedicados definidos en agents/
  • El hook PostToolUse es de tipo prompt, no command -- es sugestivo, no deterministico; Claude puede ignorarlo si el contexto es largo
  • doc-sync regenera todo -- no tiene diff incremental; re-lee todas las fuentes y reescribe los docs que detecta desactualizados
  • doc-changelog depende de conventional commits -- si el proyecto no usa feat:, fix:, chore:, el agrupamiento pierde precision
  • No tiene references/ ni docs/ propios -- las instrucciones completas viven dentro de cada SKILL.md
  • doc-modulo requiere argumento -- si no se pasa path, pregunta al usuario (no auto-detecta el ultimo modulo modificado)
  • Maximo soporte de frontmatter -- el formato de salida es estricto; proyectos que necesiten otro formato deben adaptar los skills