Document Service

Zet een codebase om in CODEBASE_ANALYSIS.md met file:line citaten en Mermaid diagrammen

Getest · Werkt ★ 9.2/10

Wat het doet

Analyseert een bestaande codebase en schrijft een enkel CODEBASE_ANALYSIS.md dat architectuur, request lifecycle, datamodellen, deployment, configuratie, beveiliging, failure modes en timeout chains behandelt, met een klikbare file:line citaat achter elke claim en inline Mermaid diagrammen. Het draait een outline-gestuurde pipeline (file tree, project detectie, per-sectie diepe lezingen, discrepantie pass) en voegt AWS-specifieke afhandeling toe voor CDK, CloudFormation en Terraform. Activeert bij verzoeken zoals "documenteer deze service", "analyseer deze codebase", "ik heb deze code geërfd", of "deze codebase heeft geen docs"; het is uitgesloten van code reviews en single-function uitleg.

Testrapport

Een 7-bestands voorbeeld AWS service gebouwd (FastAPI + CDK stack + 2 unit tests + een README die liegt over de architectuur) in een scratch dir, en vervolgens twee docs ervoor geschreven: BASELINE.md zonder de skill body en CODEBASE_ANALYSIS.md strikt volgens SKILL.md en references/technical-doc-template.md. De baseline was een schone maar vlakke beschrijving zonder citaten die rapporteerde "tests dekken twee gevallen, draai met pytest"; de skill run — omdat het het verifiëren van kwantitatieve claims door uitvoering vereist — dwong me om score_receipt daadwerkelijk uit te voeren, wat aantoonde dat test_risky_merchant_bumps_score beweert >0.5 terwijl de functie 0.4394 retourneert, d.w.z. de suite is rood. De verplichte Discrepancies en Failure Modes tabellen brachten ook vier valse README claims aan het licht (Lambda/Aurora/Cognito/nightly export vs Fargate/DynamoDB/static bearer token/dead code), API_TOKEN nooit bedraad in het CDK environment block zodat de geïmplementeerde service zou authenticeren op de letterlijke "dev-token", ContainerImage.fromAsset("../") zonder Dockerfile in de repo, en een ongeauthenticeerde GET /receipts route — waarvan geen enkele in de baseline voorkomt. Installatie geverifieerd in een tijdelijke HOME (git clone + cp plaatste SKILL.md op ~/.claude/skills/document-service/SKILL.md); alle 8 gerefereerde reference/*.md bestanden retourneerden HTTP 200; geen curl|sh, base64 blobs, geheime exfiltratie of injectietekst gevonden. Niet geoefend: de draw.io delegatie naar aws-architecture-diagram (niet geïnstalleerd, Mermaid fallback gebruikt zoals gedocumenteerd), drawio PNG export (niet op PATH), de AWS MCP servers, en het .codebase-documentor-progress.md hervatbaarheidspad voor grote repo's.

Getest op: 2026-07-21 · Claude Code 2.x (agent harness)

Installatie

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.

Commando's en voorbeeldprompts

/document-serviceZet een codebase om in CODEBASE_ANALYSIS.md met file:line citaten en Mermaid diagrammen

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

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

Volledig rapport (Engels) →