Document Service

Convierte una base de código en CODEBASE_ANALYSIS.md con citas file:line y diagramas Mermaid

Por awslabs · awslabs/agent-plugins

Probado · Funciona ★ 9.2/10

Document Service — Convierte una base de código en CODEBASE_ANALYSIS.md con citas file:line y diagramas Mermaid

Qué hace

Analiza una base de código existente y escribe un único CODEBASE_ANALYSIS.md que cubre arquitectura, ciclo de vida de solicitudes, modelos de datos, despliegue, configuración, seguridad, modos de fallo y cadenas de tiempo de espera, con una cita file:line clicable detrás de cada afirmación y diagramas Mermaid en línea. Ejecuta una pipeline impulsada por un esquema (árbol de archivos, detección de proyectos, lecturas profundas por sección, pasada de discrepancias) y añade manejo específico de AWS para CDK, CloudFormation y Terraform. Se activa en solicitudes como "documentar este servicio", "analizar esta base de código", "heredé este código" o "esta base de código no tiene documentación"; está fuera del alcance de las revisiones de código y las explicaciones de funciones individuales.

Informe de la prueba

Construí un servicio AWS de ejemplo de 7 archivos (FastAPI + pila CDK + 2 pruebas unitarias + un README que miente sobre la arquitectura) en un directorio temporal, luego escribí dos documentos para él: BASELINE.md sin el cuerpo de la habilidad y CODEBASE_ANALYSIS.md siguiendo estrictamente SKILL.md y references/technical-doc-template.md. La línea base era una descripción limpia pero plana con cero citas que informaba "las pruebas cubren dos casos, se ejecutan con pytest"; la ejecución de la habilidad — porque exige verificar afirmaciones cuantitativas mediante la ejecución — me hizo ejecutar score_receipt, lo que mostró que test_risky_merchant_bumps_score afirma >0.5 mientras que la función devuelve 0.4394, es decir, la suite está en rojo. Sus tablas obligatorias de Discrepancias y Modos de Fallo también sacaron a la luz cuatro afirmaciones falsas del README (Lambda/Aurora/Cognito/exportación nocturna vs Fargate/DynamoDB/token de portador estático/código muerto), API_TOKEN nunca cableado en el bloque de entorno CDK, por lo que el servicio desplegado se autenticaría con el literal "dev-token", ContainerImage.fromAsset("../") sin Dockerfile en el repositorio, y una ruta GET /receipts no autenticada — ninguna de las cuales aparece en la línea base. Instalación verificada en un HOME temporal (git clone + cp colocó SKILL.md en ~/.claude/skills/document-service/SKILL.md); los 8 archivos reference/*.md referenciados devolvieron HTTP 200; no se encontraron blobs curl|sh, base64, exfiltración de secretos o texto de inyección. No ejercitado: la delegación de draw.io a aws-architecture-diagram (no instalado, se usó el fallback de Mermaid como se documenta), la exportación de PNG de drawio (no en PATH), los servidores AWS MCP y la ruta de reanudación .codebase-documentor-progress.md para repositorios grandes.

Probado el: 2026-07-21 · Claude Code 2.x (agent harness)

Instalación

git clone --depth 1 https://github.com/awslabs/agent-plugins.git /tmp/document-service-src
mkdir -p ~/.claude/skills
cp -R /tmp/document-service-src/plugins/codebase-documentor-for-aws/skills/document-service ~/.claude/skills/document-service
# Installs SKILL.md + references/ (8 files: template, citation format, discovery/framework/exclusion patterns, error scenarios, recursive analysis, business context).
# No API keys or runtime deps required for the core workflow; drawio CLI is optional (PNG export is skipped if absent).
# Optional: the skill tries the `aws-architecture-diagram` skill (deploy-on-aws plugin) for draw.io output and falls back to inline Mermaid when it is not installed.
# Optional MCP enrichment (awsknowledge HTTP + awsiac via uvx) ships with the parent plugin, not with this skill dir. To get those too, install the whole plugin instead:
#   /plugin install codebase-documentor-for-aws@agent-plugins-for-aws
# Usage: "document this service" or "analyze <dir> and generate technical docs" -> writes CODEBASE_ANALYSIS.md into the target directory.

Comandos y prompts de ejemplo

  • /document-serviceConvierte una base de código en CODEBASE_ANALYSIS.md con citas file:line y diagramas Mermaid

Los skills se activan con peticiones en lenguaje natural, sin comandos que memorizar. Tras instalarlo, prompts como estos lo activan (en inglés):

  • Document this service's architecture from the code
  • Generate technical docs for this inherited codebase
  • Visualize the CDK architecture with source citations