Document Service

Transforme une base de code en CODEBASE_ANALYSIS.md avec citations fichier:ligne et diagrammes Mermaid.

par awslabs · awslabs/agent-plugins

Testé · Fonctionne ★ 9.2/10

Document Service — Transforme une base de code en CODEBASE_ANALYSIS.md avec citations fichier:ligne et diagrammes Mermaid.

Ce que fait

Analyse une base de code existante et rédige un unique CODEBASE_ANALYSIS.md couvrant l'architecture, le cycle de vie des requêtes, les modèles de données, le déploiement, la configuration, la sécurité, les modes de défaillance et les chaînes de timeout, avec une citation fichier:ligne cliquable derrière chaque affirmation et des diagrammes Mermaid intégrés. Il exécute un pipeline basé sur un plan (arborescence de fichiers, détection de projet, lectures approfondies par section, passe de divergence) et ajoute une gestion spécifique à AWS pour CDK, CloudFormation et Terraform. Se déclenche sur des requêtes comme "document this service", "analyze this codebase", "I inherited this code", ou "this codebase has no docs" ; il est exclu des revues de code et des explications de fonction unique.

Rapport de test

Construit un exemple de service AWS de 7 fichiers (FastAPI + stack CDK + 2 tests unitaires + un README qui ment sur l'architecture) dans un répertoire temporaire, puis écrit deux docs pour cela : BASELINE.md sans le corps de la compétence et CODEBASE_ANALYSIS.md suivant strictement SKILL.md et references/technical-doc-template.md. La référence était une description propre mais plate avec zéro citations qui rapportait "tests cover two cases, run with pytest" ; l'exécution de la compétence — parce qu'elle exige de vérifier les affirmations quantitatives par l'exécution — m'a fait réellement exécuter score_receipt, ce qui a montré que test_risky_merchant_bumps_score affirme >0.5 alors que la fonction retourne 0.4394, c'est-à-dire que la suite est rouge. Ses tables obligatoires Discrepancies et Failure Modes ont également mis en évidence quatre fausses affirmations du README (Lambda/Aurora/Cognito/export nocturne vs Fargate/DynamoDB/jeton bearer statique/code mort), API_TOKEN jamais câblé dans le bloc d'environnement CDK de sorte que le service déployé s'authentifierait sur le littéral "dev-token", ContainerImage.fromAsset("../") sans Dockerfile dans le dépôt, et une route GET /receipts non authentifiée — dont aucune n'apparaît dans la référence. Installation vérifiée dans un HOME temporaire (git clone + cp a placé SKILL.md dans ~/.claude/skills/document-service/SKILL.md) ; les 8 fichiers reference/*.md référencés ont retourné HTTP 200 ; aucun blob curl|sh, base64, exfiltration de secrets ou texte d'injection trouvé. Non exercé : la délégation draw.io à aws-architecture-diagram (non installé, fallback Mermaid utilisé comme documenté), l'export PNG drawio (pas sur PATH), les serveurs AWS MCP, et le chemin de résumabilité .codebase-documentor-progress.md pour les grands dépôts.

Testé le: 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.

Commandes et exemples de prompts

  • /document-serviceTransforme une base de code en CODEBASE_ANALYSIS.md avec citations fichier:ligne et diagrammes Mermaid.

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

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