documenter-webapp

Catalogue généré le 2026-05-11

En une phrase

Génère ou met à jour la documentation complète d'une webapp en scannant son code source, puis pousse le résultat sur l'instance BookStack auto-hébergée (bookstack.thymon.fr) via son API.

Quand l'utiliser

Déclenche aussi quand l'utilisateur dit "documente ce projet", "fais la doc", "mets à jour la doc de X", "génère le mode d'emploi", ou demande un audit documentaire.

Comment l'invoquer

Slash command : /documenter-webapp (si exposé dans ton CLI)
Phrases déclencheurs : voir la description complète ci-dessous
Auto-invocation : sur demande explicite

Description complète

Génère ou met à jour la documentation complète d'une webapp en scannant son code source, puis pousse le résultat sur l'instance BookStack auto-hébergée (bookstack.thymon.fr) via son API. Crée systématiquement DEUX Books par webapp — un "Mode d'emploi" pour les utilisateurs finaux et une "Documentation technique" pour les devs/ops — regroupés sous une Shelf au nom du projet. Utilise ce skill dès que l'utilisateur demande de documenter un projet, de générer/mettre à jour la doc d'une de ses webapps (boardgame-referee, basketball-overlay, juanmaycompania, wishlist manager, etc.), de pousser quelque chose sur BookStack, ou plus généralement de produire la doc utilisateur ou technique d'une application — même sans mentionner explicitement "BookStack", car c'est la destination canonique de la documentation chez Thymon. Déclenche aussi quand l'utilisateur dit "documente ce projet", "fais la doc", "mets à jour la doc de X", "génère le mode d'emploi", ou demande un audit documentaire.

Pour aller plus loin

documenter-webapp

Tu génères de la documentation complète et structurée pour une webapp, puis tu la pousses sur BookStack via son API REST.

Mapping BookStack (règle structurelle)

La hiérarchie BookStack est : Étagère (Shelf) → Livre (Book) → Chapitre (Chapter) → Page.

Ce skill applique toujours ce mapping, sans variation, pour chaque webapp documentée :

Pourquoi cette structure : BookStack gère les permissions au niveau Livre, pas au niveau Chapitre. Séparer "Mode d'emploi" et "Documentation technique" en deux Livres permet de donner un jour accès au mode d'emploi à des non-techs (collègues, communauté JeVeux, clients du restaurant Il Pinocchio) sans exposer la doc technique. Cette possibilité serait perdue si on fusionnait les deux dans un Livre unique.

Conventions de nommage strictes :

Étagère : exactement le nom du projet, tel qu'il apparaît dans le package.json ou le README (ex : BoardGame Referee, Basketball Overlay, Wishlist Manager). Si le projet n'a pas de "joli" nom, demander à Thymon plutôt qu'inventer.

(extrait — voir le SKILL.md complet pour la suite)

Source

Plugin : perso (standalone)
Nom interne : documenter-webapp
Fichier : /home/thymon/.claude/skills/documenter-webapp/SKILL.md