Document Service

Omdanner en kodebase til CODEBASE_ANALYSIS.md med file:line-citater og Mermaid-diagrammer

Testet · Virker ★ 9.2/10

Hvad det gør

Analyserer en eksisterende kodebase og skriver en enkelt CODEBASE_ANALYSIS.md, der dækker arkitektur, request lifecycle, datamodeller, deployment, konfiguration, sikkerhed, fejltilstande og timeout-kæder, med en klikbar file:line-citation bag hver påstand og inline Mermaid-diagrammer. Den kører en outline-drevet pipeline (file tree, project detection, per-sektion dybe læsninger, discrepancy pass) og tilføjer AWS-specifik håndtering for CDK, CloudFormation og Terraform. Udløses ved anmodninger som "document this service", "analyze this codebase", "I inherited this code" eller "this codebase has no docs"; den er udelukket fra kodegennemgange og enkeltfunktionsforklaringer.

Testrapport

Byggede en 7-fils sample AWS-service (FastAPI + CDK stack + 2 enhedstests + en README, der lyver om arkitekturen) i en scratch-mappe, derefter skrev jeg to docs til den: BASELINE.md uden skill-body og CODEBASE_ANALYSIS.md efter SKILL.md og references/technical-doc-template.md strengt. Baselinjen var en ren, men flad beskrivelse med nul citater, der rapporterede "tests cover two cases, run with pytest"; skill-kørslen — fordi den kræver verificering af kvantitative påstande ved udførelse — fik mig faktisk til at køre score_receipt, hvilket viste, at test_risky_merchant_bumps_score påstår >0.5, mens funktionen returnerer 0.4394, dvs. suiten er rød. Dens obligatoriske Discrepancies- og Failure Modes-tabeller afslørede også fire falske README-påstande (Lambda/Aurora/Cognito/nightly export vs Fargate/DynamoDB/static bearer token/dead code), API_TOKEN aldrig forbundet til CDK-miljøblokken, så den deployerede service ville autentificere på den bogstavelige "dev-token", ContainerImage.fromAsset("../") uden Dockerfile i repoet, og en uautentificeret GET /receipts-rute — ingen af disse optræder i baselinjen. Installation verificeret i en throwaway HOME (git clone + cp placerede SKILL.md på ~/.claude/skills/document-service/SKILL.md); alle 8 refererede reference/*.md-filer returnerede HTTP 200; ingen curl|sh, base64-blobs, hemmelig eksfiltrering eller injektionstekst fundet. Ikke udført: draw.io-delegeringen til aws-architecture-diagram (ikke installeret, Mermaid fallback brugt som dokumenteret), drawio PNG-eksport (ikke på PATH), AWS MCP-serverne og .codebase-documentor-progress.md resumability-stien for store repos.

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

Installation

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-serviceOmdanner en kodebase til CODEBASE_ANALYSIS.md med file:line-citater og Mermaid-diagrammer

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen 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

Læs hele rapporten →