Document Service

Przekształca bazę kodu w CODEBASE_ANALYSIS.md z cytatami file:line i diagramami Mermaid

Testowano · Działa ★ 9.2/10

Co robi ten skill

Analizuje istniejącą bazę kodu i pisze pojedynczy plik CODEBASE_ANALYSIS.md obejmujący architekturę, cykl życia żądań, modele danych, wdrożenie, konfigurację, bezpieczeństwo, tryby awarii i łańcuchy timeoutów, z klikalnym cytatem file:line za każdym twierdzeniem i wbudowanymi diagramami Mermaid. Uruchamia potok sterowany zarysem (drzewo plików, wykrywanie projektu, głębokie odczyty sekcja po sekcji, przejście niezgodności) i dodaje obsługę specyficzną dla AWS dla CDK, CloudFormation i Terraform. Uruchamia się na żądania takie jak „document this service”, „analyze this codebase”, „I inherited this code” lub „this codebase has no docs”; jest wyłączone z przeglądów kodu i wyjaśnień pojedynczych funkcji.

Raport z testu

Zbudowano 7-plikową przykładową usługę AWS (FastAPI + stos CDK + 2 testy jednostkowe + README, który kłamie na temat architektury) w katalogu tymczasowym, a następnie napisałem dla niej dwa dokumenty: BASELINE.md bez treści umiejętności i CODEBASE_ANALYSIS.md ściśle według SKILL.md i references/technical-doc-template.md. Bazowy był czystym, ale płaskim opisem z zerowymi cytatami, który raportował „tests cover two cases, run with pytest”; uruchomienie umiejętności — ponieważ wymaga weryfikacji ilościowych twierdzeń przez wykonanie — zmusiło mnie do faktycznego uruchomienia score_receipt, co pokazało, że test_risky_merchant_bumps_score twierdzi >0.5, podczas gdy funkcja zwraca 0.4394, tj. zestaw testów jest czerwony. Jego obowiązkowe tabele Discrepancies i Failure Modes ujawniły również cztery fałszywe twierdzenia README (Lambda/Aurora/Cognito/nightly export vs Fargate/DynamoDB/static bearer token/dead code), API_TOKEN nigdy nie podłączony do bloku środowiska CDK, więc wdrożona usługa uwierzytelniałaby się na literalnym „dev-token”, ContainerImage.fromAsset("../") bez Dockerfile w repozytorium i nieautoryzowaną trasę GET /receipts — żadne z nich nie pojawiają się w bazowym. Instalacja zweryfikowana w tymczasowym HOME (git clone + cp umieściło SKILL.md w ~/.claude/skills/document-service/SKILL.md); wszystkie 8 odwołanych plików reference/*.md zwróciły HTTP 200; nie znaleziono curl|sh, base64 blobs, eksfiltracji tajemnic ani tekstu iniekcji. Nie ćwiczono: delegacji draw.io do aws-architecture-diagram (nie zainstalowane, użyto fallbacku Mermaid zgodnie z dokumentacją), eksportu PNG drawio (nie w PATH), serwerów AWS MCP i ścieżki wznowienia .codebase-documentor-progress.md dla dużych repozytoriów.

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

Instalacja

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.

Komendy i przykładowe prompty

/document-servicePrzekształca bazę kodu w CODEBASE_ANALYSIS.md z cytatami file:line i diagramami Mermaid

Skille uruchamiają się na zwykłe polecenia — bez komend do zapamiętania. Po instalacji aktywują go prompty takie jak te (po angielsku):

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

Pełny raport →