Documentation : ADR, RTFM, génération docs, framework docs avec skills spécialisés

GitHub stars
9

Install

/plugin install doc@atournayre-claude-plugin-marketplace

Run it inside Claude Code after adding the marketplace with /plugin marketplace add atournayre/claude-marketplace.

Contents

Discovered from source

Skills 4

Configuration de sortie

IMPORTANT : Cette skill génère de la documentation structurée et nécessite un format de sortie spécifique.

Lis le frontmatter de cette skill. Si un champ output-style est présent, exécute immédiatement :

/output-style <valeur-du-champ>

Note : Une fois que le champ output-style sera supporté nativement par Claude Code, cette instruction pourra être supprimée.

Output-style requis : markdown-focused

Génération d'ADR

Instructions à Exécuter

IMPORTANT : Exécute ce workflow étape par étape :

Purpose

Génère un Architecture Decision Record (ADR) complet et structuré pour documenter les décisions architecturales importantes du projet.

Variables

  • DECISION_TITLE: Le titre de la décision architecturale
  • DECISION_NUMBER: Le numéro séquentiel de l'ADR (auto-généré si non fourni)

Instructions

  • Si TITRE n'est pas fourni, ARRETER immediatement et demander à l'utilisateur de le fournir.
  • Crée un ADR suivant le format standard RFC
  • Utilise la numérotation séquentielle automatique
  • Intègre le contexte du projet actuel
  • Respecte les conventions de documentation du projet

Relevant Files

  • docs/adr/ - Dossier contenant les ADR existants
  • docs/adr/README.md - Liste des ADR existants
  • docs/README.md - Contexte général du projet
  • CLAUDE.md - Conventions et préférences

Codebase Structure

docs/
  adr/
    0001-use-php-for-backend.md
    0002-implement-elegant-objects.md
    README.md

Workflow

  • Analyse les ADR existants pour déterminer le prochain numéro
  • Examine le projet pour comprendre le contexte architectural
  • Crée un nouveau fichier ADR avec la numérotation appropriée
  • Utilise le template standardisé avec les sections requises
  • Valide la cohérence avec les décisions précédentes

Expertise

  • Architecture logicielle et patterns de conception
  • Documentation technique et ADR standards
  • Conventions de nommage et organisation des documents
  • Principles DDD et Elegant Objects (selon le contexte du projet)

Template

# ADR-XXXX: [Titre de la décision]

## Statut
- **Statut**: [Proposé | Accepté | Rejeté | Déprécié | Remplacé par ADR-YYYY]
- **Date**: YYYY-MM-DD
- **Auteurs**: [Noms]
- **Reviewers**: [Noms]

## Contexte
[Description du problème ou de la situation qui nécessite une décision]

## Décision
[La décision prise et sa justification]

## Conséquences
### Positives
- [Bénéfices attendus]

### Négatives
- [Coûts et risques identifiés]

### Neutres
- [Autres implications]

## Alternatives considérées
### Option 1: [Nom]
- **Avantages**: [Liste]
- **Inconvénients**: [Liste]
- **Raison du rejet**: [Explication]

### Option 2: [Nom]
- **Avantages**: [Liste]
- **Inconvénients**: [Liste]
- **Raison du rejet**: [Explication]

## Références
- [Liens vers documentation, discussions, tickets]

## Notes d'implémentation
[Détails techniques spécifiques pour l'implémentation]

Examples

# Génération d'un ADR pour l'adoption d'un nouveau framework

## Instructions à Exécuter

**IMPORTANT : Exécute ce workflow étape par étape :**
/adr "Adoption du framework Symfony pour l'API"

# Génération d'un ADR pour une décision de base de données

## Instructions à Exécuter

**IMPORTANT : Exécute ce workflow étape par étape :**
/adr "Migration vers PostgreSQL pour les performances"

Report

  • Affiche le numéro ADR généré
  • Confirme la création du fichier dans docs/adr/
  • Liste les fichiers ADR existants pour référence
  • Rappelle les prochaines étapes (review, validation)

Documentation Loader Skill

Instructions à Exécuter

IMPORTANT : Exécute ce workflow étape par étape :

Usage

/doc:framework-load <framework> [version]

Frameworks supportés

FrameworkAgentPath
symfonysymfony-docs-scraperdocs/symfony/[version]/
api-platformapi-platform-docs-scraperdocs/api-platform/[version]/
meilisearchmeilisearch-docs-scraperdocs/meilisearch/[version]/
atournayre-frameworkatournayre-framework-docs-scraperdocs/atournayre-framework/[version]/
claudeclaude-docs-scraperdocs/claude/

Workflow

  1. Parser arguments (framework, version)
  2. Vérifier README contenant les URLs
  3. Gérer cache (24h par défaut)
  4. Déléguer à agent scraper spécialisé
  5. Générer statistiques finales

Cache

  • Fichiers < 24h : ignorés
  • Fichiers > 24h : supprimés et rechargés
  • Délai 2s entre requêtes (anti rate-limit)

Error Handling

  • Framework non supporté → ARRÊT
  • README introuvable → ARRÊT
  • Échec scraping URL → WARNING (continue)

References

Notes

  • Fichiers markdown nommés depuis URL
  • Support multi-version

Configuration de sortie

Instructions à Exécuter

IMPORTANT : Exécute ce workflow étape par étape :

IMPORTANT : Cette skill génère une synthèse de documentation structurée et nécessite un format de sortie spécifique.

Lis le frontmatter de cette skill. Si un champ output-style est présent, exécute immédiatement :

/output-style <valeur-du-champ>

Note : Une fois que le champ output-style sera supporté nativement par Claude Code, cette instruction pourra être supprimée.

Output-style requis : markdown-focused

Documentation Reader - RTFM

Purpose

Force Claude à lire et comprendre la documentation technique fournie, que ce soit via une URL directe ou en recherchant une documentation par nom.

Variables

DOC_SOURCE: L'URL ou le nom de la documentation à lire

Instructions

  • Si une URL est fournie directement, utilise WebFetch pour la lire
  • Si un nom de documentation est fourni, utilise WebSearch pour la trouver puis WebFetch pour la lire
  • Force Claude à lire complètement la documentation avant de répondre
  • Fournis un résumé structuré des points clés

Relevant Files

  • Documentation externe via WebFetch/WebSearch

Codebase Structure

Cette commande ne modifie pas le codebase, elle lit uniquement la documentation externe.

Workflow

  • Si DOC_SOURCE commence par http/https, utilise directement WebFetch
  • Sinon, recherche la documentation avec WebSearch puis lis le résultat avec WebFetch
  • Parse et structure l'information de la documentation
  • Fournis un résumé concis et actionnable

Expertise

  • Lecture et analyse de documentation technique
  • Extraction d'informations clés
  • Synthèse et structuration de contenu

Template

# Documentation: [NOM]

## Résumé
[Résumé concis en 2-3 phrases]

## Points clés
- Point important 1
- Point important 2
- Point important 3

## Exemples pratiques
[Exemples d'usage si disponibles]

## Liens utiles
[Références additionnelles si pertinentes]

Examples

  • /rtfm https://docs.anthropic.com/claude/reference - Lit directement la documentation Claude
  • /rtfm symfony doctrine - Recherche et lit la documentation Symfony Doctrine
  • /rtfm php 8.3 new features - Recherche les nouvelles fonctionnalités PHP 8.3

Report

Résumé structuré de la documentation lue avec points clés et exemples pratiques.

Documentation de fonctionnalité

Instructions à Exécuter

IMPORTANT : Exécute ce workflow étape par étape :

Génère ou met à jour la documentation pour la fonctionnalité en cours de développement, en s'assurant que tous les documents sont liés et que le README principal est à jour.

Purpose

Maintenir une documentation cohérente, à jour et bien interconnectée pour le projet.

Variables

  • CURRENT_BRANCH: Branche Git en cours
  • DOC_DIR: Répertoire de documentation du projet (détection automatique)
  • README_PATH: Chemin vers le README principal du projet
  • FEATURE_NAME: Nom de la fonctionnalité extraite de la branche et des modifications

Relevant Files

  • README.md - Documentation principale du projet
  • docs/ - Répertoire de documentation standard
  • Fichiers source de la fonctionnalité
  • Fichiers de tests associés

Workflow

1. Analyse du contexte

  • Identifie la branche Git en cours (git branch --show-current)
  • Analyse les modifications de la branche :
    • Fichiers modifiés (git status)
    • Diff par rapport à main/master (git diff)
    • Commits de la branche (git log)
  • Extrait le nom de la fonctionnalité depuis :
    • Le nom de la branche (ex: feature/user-auth → User Authentication)
    • Les commits de la branche
    • Les prompts récents de la session
  • Détermine le répertoire de documentation :
    • Cherche docs/, documentation/, ou équivalent
    • Crée le répertoire si nécessaire
  • Identifie les informations clés :
    • Fichiers principaux modifiés
    • Tests associés
    • Dépendances ajoutées/modifiées

2. Génération de la documentation

  • Crée ou met à jour le fichier de documentation :
    • Titre et description claire
    • Utilisation et exemples
    • Architecture et composants
    • Configuration nécessaire
    • Tests et validation
    • Limitations et notes
  • Format Markdown structuré avec :
    • Table des matières si nécessaire
    • Blocs de code avec syntaxe
    • Liens vers fichiers sources
    • Exemples d'utilisation concrets

3. Mise à jour du README principal

  • Vérifie si la fonctionnalité doit être mentionnée dans le README
  • Ajoute ou met à jour la section appropriée :
    • Fonctionnalités principales
    • Structure du projet
    • Documentation disponible
  • Maintient la cohérence du format existant
  • Préserve l'ordre et la hiérarchie

4. Liaison des documents

  • Identifie les documents connexes :
    • Documentation de fonctionnalités liées
    • Guides d'architecture
    • Tutoriels
    • ADRs (Architecture Decision Records)
  • Ajoute des liens bidirectionnels :
    • Depuis le nouveau document vers les connexes
    • Depuis les connexes vers le nouveau document
  • Vérifie l'absence de liens cassés
  • Crée un index si nécessaire pour les projets volumineux

5. Validation et rapport

  • Vérifie la qualité de la documentation :
    • Tous les exemples sont fonctionnels
    • Les liens sont valides
    • Le formatage Markdown est correct
    • Pas de typos évidentes
  • Génère un rapport de ce qui a été créé/modifié

Report

Affiche un résumé structuré :

Documentation générée :
- Fonctionnalité : [NOM]
- Fichier créé/modifié : [CHEMIN]
- Taille : [LIGNES] lignes

Modifications README :
- Section modifiée : [SECTION]
- Ajouts : [DESCRIPTION]

Liens créés :
- [DOC1] ↔ [DOC2]
- [DOC3] ↔ [DOC4]

Documents liés :
- [LISTE DES DOCS CONNEXES]

Best Practices

  • Documentation focalisée sur l'utilisation, pas l'implémentation
  • Exemples concrets et testés
  • Langage clair et concis (style bullet points)
  • Liens relatifs pour la portabilité
  • Pas de duplication entre README et docs détaillées
  • README = vue d'ensemble, docs/ = détails
  • Maintenir la cohérence du ton et du format

Sponsors

Details

Marketplace
atournayre/claude-marketplace
Source
doc
Category
Community

More from atournayre/claude-marketplace

All 18