# documenter-webapp

# documenter-webapp

> _Catalogue généré le 2026-05-11_

## En une phrase

Skill maison qui scanne le code source d'une webapp, génère une documentation complète (mode d'emploi utilisateur + doc technique), et la pousse automatiquement sur l'instance BookStack auto-hébergée de Thymon.

## Quand l'utiliser

- Pour documenter une webapp entière depuis zéro (boardgame-referee, basketball-overlay, juanmaycompania, wishlist manager)
- Pour mettre à jour la doc d'un projet existant après une grosse évolution
- Quand un collègue ou un client doit accéder à un mode d'emploi sans voir la doc technique
- Pour produire un audit documentaire (qu'est-ce qui manque, qu'est-ce qui est obsolète)
- Quand tu veux centraliser la doc de tous tes projets au même endroit (bookstack.thymon.fr)

## Comment l'invoquer

- **Slash command** : `/documenter-webapp`
- **Phrases déclencheurs (texte)** : "documente ce projet", "fais la doc", "mets à jour la doc de X", "génère le mode d'emploi", "audit documentaire"
- **Auto-invocation** : ✅ Oui — dès qu'on parle de documenter une webapp ou de pousser de la doc sur BookStack

## Description détaillée

C'est ton propre outil de documentation, et il est déjà testé sur tes projets. Il applique systématiquement la même structure dans BookStack : une **Étagère** au nom du projet, qui contient **deux Livres** — un "Mode d'emploi" pour les utilisateurs finaux (collègues, communauté JeVeux, clients d'Il Pinocchio) et une "Documentation technique" pour toi et les futurs devs/ops. Cette séparation existe parce que BookStack gère les permissions au niveau Livre : tu peux ouvrir le mode d'emploi à des non-techs sans exposer la doc technique.

Le workflow est rigoureux. Phase scoping : il te pose 4 questions (quel projet, quel périmètre, quel public du mode d'emploi, captures dispos ?). Phase scan : il lit `README`, `package.json`, `Dockerfile`, structure de dossiers, point d'entrée backend, schéma BDD, routeur frontend, `.env.example`, middlewares d'auth — dans cet ordre précis. Phase génération : il écrit le contenu en Markdown CommonMark dans un dossier temporaire qui reflète la hiérarchie BookStack cible, chaque page datée et écrite pour son public (jargon-free pour l'utilisateur, exécutable pour la technique). Phase preview : il te montre l'arborescence cible et te demande validation **avant** de pousser. Phase push : via `bookstack_client.py`, opérations idempotentes basées sur titre+parent — relancer ne duplique rien.

Il a des garde-fous : jamais de suppression sans confirmation nominative, jamais d'invention de contenu (préférer une section "À compléter" honnête), jamais de secrets copiés. Pour Thymon : c'est l'outil qui garde toute ta connaissance projet centralisée et à jour, sans que tu aies à réinventer la roue à chaque webapp.

## Source

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