Document Service

Gjør en kodebase om til CODEBASE_ANALYSIS.md med fil:linje-siteringer og Mermaid-diagrammer

Bestått ★ 9.2/10

Hva den gjør

Analyserer en eksisterende kodebase og skriver en enkelt CODEBASE_ANALYSIS.md som dekker arkitektur, forespørselslivssyklus, datamodeller, distribusjon, konfigurasjon, sikkerhet, feilmoduser og tidsavbruddskjeder, med en klikkbar fil:linje-sitering bak hvert utsagn og innebygde Mermaid-diagrammer. Den kjører en omriss-drevet pipeline (filtre, prosjektdeteksjon, dype lesninger per seksjon, avviksgjennomgang) og legger til AWS-spesifikk håndtering for CDK, CloudFormation og Terraform. Utløses ved forespørsler som "document this service", "analyze this codebase", "I inherited this code", eller "this codebase has no docs"; den er utenfor omfanget av kodegjennomganger og enkeltfunksjonsforklaringer.

Testrapport

Bygde en 7-fils eksempel AWS-tjeneste (FastAPI + CDK stack + 2 enhetstester + en README som lyver om arkitekturen) i en scratch-katalog, deretter skrev to dokumenter for den: BASELINE.md uten ferdighetskroppen og CODEBASE_ANALYSIS.md etter SKILL.md og references/technical-doc-template.md strengt. Baseline var en ren, men flat beskrivelse med null siteringer som rapporterte "tests cover two cases, run with pytest"; ferdighetskjøringen — fordi den krever verifisering av kvantitative påstander ved utførelse — fikk meg til å faktisk kjøre score_receipt, som viste at test_risky_merchant_bumps_score hevder >0.5 mens funksjonen returnerer 0.4394, dvs. suiten er rød. Dens obligatoriske Discrepancies and Failure Modes-tabeller avdekket også fire falske README-påstander (Lambda/Aurora/Cognito/nightly export vs Fargate/DynamoDB/static bearer token/dead code), API_TOKEN aldri koblet til CDK-miljøblokken slik at den distribuerte tjenesten ville autentisere på den bokstavelige "dev-token", ContainerImage.fromAsset("../") uten Dockerfile i repoet, og en uautentisert GET /receipts-rute — ingen av disse vises i baseline. Installasjon verifisert i en midlertidig HOME (git clone + cp plasserte SKILL.md på ~/.claude/skills/document-service/SKILL.md); alle 8 refererte reference/*.md-filer returnerte HTTP 200; ingen curl|sh, base64-blobs, hemmelig eksfiltrering eller injeksjonstekst funnet. Ikke utført: draw.io-delegeringen til aws-architecture-diagram (ikke installert, Mermaid fallback brukt som dokumentert), drawio PNG-eksport (ikke på PATH), AWS MCP-serverne, og .codebase-documentor-progress.md gjenopprettingssti for store repoer.

Testet på: 2026-07-21 · Claude Code 2.x (agent harness)

Installer

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.

Kommandoer og eksempelprompter

/document-serviceGjør en kodebase om til CODEBASE_ANALYSIS.md med fil:linje-siteringer og Mermaid-diagrammer

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

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

Full rapport →