● Communauté
zarazhangrui
⚡ Instantané
Codebase to Course
par zarazhangrui · zarazhangrui/codebase-to-course
Pointez vers un dépôt, obtenez un « cours » HTML expliquant comme un tutoriel — code annoté, diagrammes, narration — pour les non-ingénieurs et les nouvelles recrues.
codebase-to-course est un skill Claude Code qui parcourt un dépôt entier et produit un cours HTML fichier unique expliquant comment la base de code fonctionne réellement. Il est structuré comme un tutoriel : vue d'ensemble de l'architecture, puis approfondissements par module, puis des walkthroughs « suivez cette requête à travers le système » — avec des extraits de code annotés intégrés. La sortie est un seul fichier HTML, sans étape de build.
Pourquoi l'utiliser
Fonctionnalités clés
- Sortie HTML fichier unique — pas de pipeline de build
- Vue d'ensemble d'architecture générée depuis le code réel (pas le README)
- Sections « pourquoi ça existe + comment ça fonctionne » par module
- Walkthroughs de flux de requêtes suivant de vrais points d'entrée
- Blocs de code annotés avec explications ligne par ligne
- Conçu pour les non-ingénieurs (PMs, designers, nouvelles recrues)
Démo en direct
Aperçu en pratique
prêt
Cas d'usage
Usages concrets : Codebase to Course
Quand l'utiliser : Vendredi après acceptation de l'offre : vous voulez un vrai artefact d'onboarding au lieu de « va lire le code ».
Déroulement
-
Scanner le dépôt
codebase-to-course : scanne ./our-app. Propose d'abord la structure du cours — liste des sections — avant d'écrire.✓ Copié
→ Table des matières concrète : architecture, modules, flux de requêtes
-
Générer le cours
C'est bon. Génère le HTML complet vers /onboarding/course.html. Public cible : nouveau développeur full-stack qui connaît React + Node mais pas notre domaine.✓ Copié
→ Fichier HTML généré ; s'ouvre dans le navigateur
-
Vérifier la précision
Vérification ponctuelle : est-ce que le walkthrough 'flux d'auth' correspond à ce qui est réellement dans src/auth/ ? Cite le code réel.✓ Copié
→ Le walkthrough cite des chemins de fichiers réels et du code actuel
Résultat : Un vrai artefact d'onboarding qui économise 2 semaines d'explications à l'équipe.
Pièges
- Le cours est trop long à vraiment lire — Spécifiez le nombre maximum de sections ; la qualité prime sur l'exhaustivité
- Les extraits de code deviennent obsolètes — Régénérez après les grands refactorings ; le skill est rapide
Quand l'utiliser : Le PM demande sans cesse « pourquoi ça prend 3 sprints » — vous voulez un artefact concret.
Déroulement
-
Cibler la fonctionnalité
codebase-to-course : cible src/payments/. Public : PM sans background ingénierie. Penchant pour les diagrammes + analogies, léger en code.✓ Copié
→ Le cours est de haut niveau ; blocs de code minimaux
Résultat : Le PM repart avec un modèle mental.
Pièges
- Les analogies surimposent — Vérification ponctuelle ; le skill préfère la précision si on le pousse
Quand l'utiliser : Votre README liste les fonctionnalités mais n'a pas d'explication architecturale.
Déroulement
-
Générer comme page de docs
codebase-to-course : scanne la branche main. Génère ARCHITECTURE.html pour le site de docs. Cible : développeurs expérimentés évaluant le projet.✓ Copié
→ Le résultat se lit comme un guide contributeur réfléchi
Résultat : Meilleure expérience développeur pour les évaluateurs et contributeurs.
Pièges
- Le cours semble générique (paraît générique) — Passez le nom du projet + des indicateurs de style dans le prompt
Combinaisons
Associez-le à d'autres MCPs pour un effet X10
Lire le dépôt local et écrire le cours
codebase-to-course : scanne ./our-app, écris /onboarding/course.html.✓ Copié
Créer un cours pour un dépôt externe sans le cloner
Utilise GitMCP pour owner/repo. Puis codebase-to-course par-dessus.✓ Copié
Coût et limites
Coût d'exécution
- Quota d'API
- N/A
- Tokens par appel
- Significatif — le skill lit le dépôt entier (typiquement 10k–50k tokens)
- Monétaire
- Gratuit ; vos tokens de modèle s'appliquent
- Astuce
- Pour les monorepos, utilisez scope_to_subdir ; ne créez pas de cours pour tout à la fois
Sécurité
Permissions, secrets, portée
Portées minimales : filesystem-read filesystem-write
Stockage des identifiants : Aucun
Sortie de données : Aucun — lecture/écriture purement locale
- Le cours généré peut inclure des extraits de code ; revoyez avant de partager en externe si le dépôt contient des secrets
Dépannage
Erreurs courantes et correctifs
Le cours est trop générique / ne référence pas le code réel
Rendez le prompt plus spécifique ; demandez des citations fichier:ligne
Dépôt trop grand ; manque de contexte
Utilisez scope_to_subdir ; faites des cours par module et liez-les
Formatage HTML cassé
Demandez au skill de valider la sortie ; régénérez si nécessaire
Alternatives
Codebase to Course vs autres
| Alternative | Quand l'utiliser | Compromis |
|---|
| Repomix + prompt manuel | Vous voulez un contrôle total sur la façon dont la base de code est fournie à Claude | Plus de configuration ; pas de format de sortie opinioné |
| DocsGPT / Mintlify | Vous voulez des docs hébergées | Produit différent entièrement ; pas HTML fichier unique |
| absolutely-skilled / autodoc | Vous voulez des docs API auto-générées | Référence API ≠ tutoriel |