Document Service

Förvandlar en kodbas till CODEBASE_ANALYSIS.md med fil:rad-citat och Mermaid-diagram

Testad · Fungerar ★ 9.2/10

Vad den gör

Analyserar en befintlig kodbas och skriver en enda CODEBASE_ANALYSIS.md som täcker arkitektur, request lifecycle, datamodeller, deployment, konfiguration, säkerhet, failure modes och timeout chains, med en klickbar fil:rad-citat bakom varje påstående och inbyggda Mermaid-diagram. Den kör en konturdriven pipeline (filträd, projektdetektering, djupavläsningar per sektion, avvikelsekontroll) och lägger till AWS-specifik hantering för CDK, CloudFormation och Terraform. Utlöses vid förfrågningar som "dokumentera denna tjänst", "analysera denna kodbas", "jag ärvde denna kod", eller "denna kodbas har ingen dokumentation"; den är exkluderad från kodgranskningar och enskilda funktionsförklaringar.

Testrapport

Byggde en 7-fils exempel AWS-tjänst (FastAPI + CDK stack + 2 enhetstester + en README som ljuger om arkitekturen) i en scratch-katalog, skrev sedan två dokument för den: BASELINE.md utan färdighetens kropp och CODEBASE_ANALYSIS.md strikt enligt SKILL.md och references/technical-doc-template.md. Baslinjen var en ren men platt beskrivning utan citat som rapporterade "tester täcker två fall, kör med pytest"; färdighetskörningen — eftersom den kräver verifiering av kvantitativa påståenden genom exekvering — fick mig att faktiskt köra score_receipt, vilket visade att test_risky_merchant_bumps_score hävdar >0.5 medan funktionen returnerar 0.4394, dvs. sviten är röd. Dess obligatoriska Discrepancies- och Failure Modes-tabeller avslöjade också fyra falska README-påståenden (Lambda/Aurora/Cognito/nightly export vs Fargate/DynamoDB/static bearer token/dead code), API_TOKEN aldrig kopplad till CDK-miljöblocket så den distribuerade tjänsten skulle autentisera på den bokstavliga "dev-token", ContainerImage.fromAsset("../") utan Dockerfile i repot, och en oautentiserad GET /receipts-rutt — inget av detta förekommer i baslinjen. Installation verifierades i en temporär HOME (git clone + cp placerade SKILL.md på ~/.claude/skills/document-service/SKILL.md); alla 8 refererade reference/*.md-filer returnerade HTTP 200; inga curl|sh, base64-blobbar, hemlig exfiltrering eller injektionstext hittades. Ej utövat: draw.io-delegeringen till aws-architecture-diagram (ej installerad, Mermaid-fallback användes som dokumenterat), drawio PNG-export (ej på PATH), AWS MCP-servrarna, och .codebase-documentor-progress.md-återupptagbarhetssökvägen för stora repos.

Testad: 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.

Kommandon och exempelprompter

/document-serviceFörvandlar en kodbas till CODEBASE_ANALYSIS.md med fil:rad-citat och Mermaid-diagram

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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

Läs hela rapporten →