Document Service
Přemění kódovou základnu na CODEBASE_ANALYSIS.md s citacemi file:line a diagramy Mermaid
Otestováno · Funguje
Co umí
Analyzuje existující kódovou základnu a píše jediný CODEBASE_ANALYSIS.md pokrývající architekturu, životní cyklus požadavků, datové modely, nasazení, konfiguraci, zabezpečení, režimy selhání a řetězce časových limitů, s klikatelnou citací file:line za každým tvrzením a vloženými diagramy Mermaid. Spouští pipeline řízenou osnovou (strom souborů, detekce projektu, hluboké čtení po sekcích, průchod nesrovnalostí) a přidává AWS-specifické zpracování pro CDK, CloudFormation a Terraform. Spouští se na požadavky jako „zdokumentujte tuto službu“, „analyzujte tuto kódovou základnu“, „zdědil jsem tento kód“ nebo „tato kódová základna nemá dokumentaci“; je mimo rozsah revizí kódu a vysvětlení jednotlivých funkcí.
Testovací report
Vytvořil jsem 7souborovou vzorovou službu AWS (FastAPI + CDK stack + 2 unit testy + README, které lže o architektuře) v dočasném adresáři, poté jsem pro ni napsal dva dokumenty: BASELINE.md bez těla dovednosti a CODEBASE_ANALYSIS.md striktně podle SKILL.md a references/technical-doc-template.md. Základní test byl čistý, ale plochý popis s nulovými citacemi, který hlásil „testy pokrývají dva případy, spouštějte s pytest“; spuštění dovednosti — protože vyžaduje ověření kvantitativních tvrzení provedením — mě přimělo skutečně spustit score_receipt, což ukázalo, že test_risky_merchant_bumps_score tvrdí >0.5, zatímco funkce vrací 0.4394, tj. sada je červená. Jeho povinné tabulky Discrepancies a Failure Modes také odhalily čtyři falešná tvrzení v README (Lambda/Aurora/Cognito/noční export vs Fargate/DynamoDB/statický bearer token/mrtvý kód), API_TOKEN nikdy nezapojen do bloku prostředí CDK, takže nasazená služba by se autentizovala na literálním „dev-token“, ContainerImage.fromAsset("../") bez Dockerfile v repozitáři a neautentizovaná trasa GET /receipts — nic z toho se neobjevilo v základním testu. Instalace ověřena v dočasném HOME (git clone + cp umístil SKILL.md do ~/.claude/skills/document-service/SKILL.md); všech 8 odkazovaných souborů reference/*.md vrátilo HTTP 200; nebyly nalezeny žádné curl|sh, base64 bloby, exfiltrace tajemství ani injekční text. Nevyužito: delegování draw.io na aws-architecture-diagram (není nainstalováno, použit Mermaid fallback, jak je dokumentováno), export drawio PNG (není v PATH), AWS MCP servery a cesta .codebase-documentor-progress.md pro obnovitelnost pro velké repozitáře.
Testováno: 2026-07-21 · Claude Code 2.x (agent harness)
Instalace
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.
Příkazy a ukázkové prompty
/document-servicePřemění kódovou základnu na CODEBASE_ANALYSIS.md s citacemi file:line a diagramy Mermaid
Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):
Document this service's architecture from the codeGenerate technical docs for this inherited codebaseVisualize the CDK architecture with source citations