documenter-webapp

documenter-webapp

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

En une phrase

GénèreSkill oumaison metqui àscanne jourle lacode source d'une webapp, génère une documentation complète (mode d'uneemploi webapputilisateur en+ scannantdoc sontechnique), codeet source, puisla pousse le résultatautomatiquement sur l'instance BookStack auto-hébergée (bookstack.thymon.fr)de via son API.Thymon.

Quand l'utiliser

• DéclenchePour aussidocumenter quandune 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'utilisateurinvoquer

dit

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", 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-dessousdocumentaire" Auto-invocation : ✅ Oui — dès qu'on parle de documenter une webapp ou de pousser de la doc sur demande expliciteBookStack

Description complètedétaillée

GénèreC'est outon metpropre àoutil jourde documentation, et il est déjà testé sur tes projets. Il applique systématiquement la documentationmême complètestructure d'une webapp en scannant son code source, puis pousse le résultat sur l'instancedans BookStack auto-hébergée: (bookstack.thymon.fr)une viaÉtagère sonau API.nom Créedu systématiquementprojet, DEUXqui Bookscontient pardeux webappLivres — un "Mode d'emploi" pour les utilisateurs finaux (collègues, communauté JeVeux, clients d'Il Pinocchio) 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ètetoi et structuréeles pourfuturs unedevs/ops. webapp,Cette puisséparation tuexiste laparce 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 :que BookStack gère les permissions au niveau Livre,Livre pas: autu niveaupeux Chapitre.ouvrir Séparer "Mode d'emploi" et "Documentation technique" en deux Livres permet de donner un jour accès aule mode d'emploi à des non-techs (collègues, communauté JeVeux, clients du restaurant Il Pinocchio) sans exposer la doc technique.

Cette

Le possibilitéworkflow seraitest perduerigoureux. siPhase onscoping fusionnait: lesil deuxte 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 Livredossier unique.

temporaire

Conventionsqui dereflète nommagela stricteshiérarchie :

BookStack

cible, Étagèrechaque :page exactementdatée leet nomécrite dupour projet,son tel qu'il apparaît dans le package.json ou le READMEpublic (exjargon-free :pour BoardGamel'utilisateur, 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 completexécutable pour la suite)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