SkillProof tested Claude skills

Document Service

Trasforma una codebase in CODEBASE_ANALYSIS.md con citazioni file:linea e diagrammi Mermaid.

di awslabs · awslabs/agent-plugins

Promosso ★ 9.2/10

Document Service — Trasforma una codebase in CODEBASE_ANALYSIS.md con citazioni file:linea e diagrammi Mermaid.

Cosa fa

Analizza una codebase esistente e scrive un singolo CODEBASE_ANALYSIS.md che copre architettura, ciclo di vita delle richieste, modelli di dati, deployment, configurazione, sicurezza, modalità di fallimento e catene di timeout, con una citazione file:linea cliccabile dietro ogni affermazione e diagrammi Mermaid inline. Esegue una pipeline guidata da una bozza (albero di file, rilevamento del progetto, letture approfondite per sezione, passaggio di discrepanza) e aggiunge la gestione specifica per AWS per CDK, CloudFormation e Terraform. Si attiva su richieste come "documenta questo servizio", "analizza questa codebase", "ho ereditato questo codice" o "questa codebase non ha documentazione"; è escluso dalle revisioni di codice e dalle spiegazioni di singole funzioni.

Rapporto di test

Ho costruito un servizio AWS di esempio di 7 file (FastAPI + stack CDK + 2 unit test + un README che mente sull'architettura) in una directory temporanea, quindi ho scritto due documenti per esso: BASELINE.md senza il corpo della skill e CODEBASE_ANALYSIS.md seguendo rigorosamente SKILL.md e references/technical-doc-template.md. La baseline era una descrizione pulita ma piatta con zero citazioni che riportava "i test coprono due casi, eseguiti con pytest"; l'esecuzione della skill — perché richiede di verificare affermazioni quantitative tramite esecuzione — mi ha fatto effettivamente eseguire score_receipt, che ha mostrato che test_risky_merchant_bumps_score asserisce >0.5 mentre la funzione restituisce 0.4394, cioè la suite è rossa. Le sue tabelle obbligatorie Discrepancies e Failure Modes hanno anche evidenziato quattro affermazioni false nel README (Lambda/Aurora/Cognito/esportazione notturna vs Fargate/DynamoDB/token bearer statico/codice morto), API_TOKEN mai collegato nel blocco ambiente CDK in modo che il servizio deployato si autenticherebbe sul letterale "dev-token", ContainerImage.fromAsset("../") senza Dockerfile nel repo, e una route GET /receipts non autenticata — nessuna delle quali appare nella baseline. Installazione verificata in una HOME temporanea (git clone + cp ha posizionato SKILL.md in ~/.claude/skills/document-service/SKILL.md); tutti gli 8 file reference/*.md referenziati hanno restituito HTTP 200; nessun curl|sh, blob base64, esfiltrazione di segreti o testo di iniezione trovato. Non esercitato: la delega draw.io a aws-architecture-diagram (non installato, fallback Mermaid usato come documentato), esportazione PNG drawio (non nel PATH), i server AWS MCP e il percorso di ripristino .codebase-documentor-progress.md per grandi repo.

Testato il: 2026-07-21 · Claude Code 2.x (agent harness)

Installazione

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.

Comandi e prompt di esempio

  • /document-serviceTrasforma una codebase in CODEBASE_ANALYSIS.md con citazioni file:linea e diagrammi Mermaid.

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

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

Rapporto completo →