/ Verzeichnis / Playground / Codebase to Course
← Alle Server ↗ GitHub
● Community zarazhangrui ⚡ Sofort

Codebase to Course

von zarazhangrui · zarazhangrui/codebase-to-course

Auf ein Repository zeigen und eine einzelne HTML-Kurs-Datei erhalten, die es wie ein Tutorial erklärt — annotierter Code, Diagramme, Narrative — für Nicht-Ingenieure und neue Mitarbeiter im Onboarding.

codebase-to-course ist ein Claude-Code-Skill, der ein ganzes Repository durchläuft und eine einzeldatei-HTML-Kurs erstellt, der erklärt, wie der Code tatsächlich funktioniert. Strukturiert wie ein Tutorial: Hochrangige Architektur, dann modulbezogene Vertiefungen, dann Walkthroughs, die eine Anfrage durch das System verfolgen — mit eingebetteten, annotierten Code-Snippets. Ausgabe ist eine HTML-Datei, kein Build-Schritt.

▶ Demo ansehen 📦 Installieren 💡 Anwendungsfälle

Warum nutzen

Hauptfunktionen

Live-Demo

In der Praxis

bereit

Installation

Repository des Autors · Offizielle Dokumentation zu Claude Skills

Anwendungsfälle

Praxisnahe Nutzung: Codebase to Course

Einen selbstgesteuerten Onboarding-Kurs für einen neuen Mitarbeiter generieren

👤 Engineering-Manager / Tech Leads ⏱ ~45 min beginner

Wann einsetzen: Freitag nach Angebotsannahme: ein echtes Onboarding-Artefakt statt "Lies den Code" erstellen.

Ablauf
  1. Repository scannen
    codebase-to-course: ./our-app scannen. Erst die vorgeschlagene Kursstruktur ausgeben — Abschnittsliste — bevor geschrieben wird.✓ Kopiert
    → Konkretes Inhaltsverzeichnis: Architektur, Module, Request-Flows
  2. Kurs generieren
    Passt. Das vollständige HTML nach /onboarding/course.html generieren. Zielgruppe: neuer Full-Stack-Entwickler, der React + Node kennt, aber unsere Domain nicht.✓ Kopiert
    → HTML-Datei generiert; öffnet sich im Browser
  3. Genauigkeit prüfen
    Stichprobe: Stimmt der "Auth-Flow"-Walkthrough mit dem überein, was tatsächlich in src/auth/ steht? Echten Code zitieren.✓ Kopiert
    → Walkthrough zitiert echte Dateipfade und aktuellen Code

Ergebnis: Ein echtes Onboarding-Artefakt, das dem Team 2 Wochen Erklärungen erspart.

Fallstricke
  • Kurs ist zu lang, um ihn tatsächlich zu lesen — Maximale Abschnitte angeben; Qualität über Vollständigkeit
  • Code-Ausschnitte veralten — Nach größeren Refactorings neu generieren; der Skill ist schnell
Kombinieren mit: filesystem · git-mcp-idosal

Ein komplexes Feature einem nicht-technischen PM erklären

👤 Tech Leads ⏱ ~20 min beginner

Wann einsetzen: Die PM fragt immer wieder: Warum dauert das 3 Sprints? Ein konkretes Artefakt soll erstellt werden.

Ablauf
  1. Auf Feature begrenzen
    codebase-to-course: auf src/payments/ begrenzen. Zielgruppe: PM ohne Ingenieurshintergrund. Diagramme und Analogien bevorzugen, wenig Code.✓ Kopiert
    → Kurs ist hochrangig; Code-Blöcke minimal

Ergebnis: PM geht mit einem mentalen Modell davon.

Fallstricke
  • Analogien vereinfachen zu stark — Stichprobe; der Skill bevorzugt Genauigkeit, wenn gefordert

Eine "Wie es funktioniert"-Seite für ein Open-Source-Projekt generieren

👤 OSS-Maintainer ⏱ ~30 min intermediate

Wann einsetzen: Das README hat Features, aber keine Architekturerklärung.

Ablauf
  1. Als Dokumentationsseite generieren
    codebase-to-course: Main-Branch scannen. ARCHITECTURE.html für die Docs-Site ausgeben. Zielgruppe: erfahrene Entwickler, die das Projekt evaluieren.✓ Kopiert
    → Ausgabe liest sich wie ein durchdachter Contributor-Guide

Ergebnis: Bessere Developer-Experience für Evaluatoren und Beitragende.

Fallstricke
  • Kurs wirkt generisch (ohne Marke) — Projektname + Stil-Hinweise im Prompt übergeben

Kombinationen

Mit anderen MCPs für 10-fache Wirkung

codebase-to-course-skill + filesystem

Lokales Repository lesen und Kurs schreiben

codebase-to-course: ./our-app scannen, /onboarding/course.html schreiben.✓ Kopiert
codebase-to-course-skill + git-mcp-idosal

Ein externes Repository bearbeiten ohne es zu klonen

GitMCP für owner/repo verwenden. Dann codebase-to-course darauf.✓ Kopiert

Werkzeuge

Was dieses MCP bereitstellt

WerkzeugEingabenWann aufrufenKosten
scan_repo path Immer zuerst 0
propose_toc scan_result, audience Nach dem Scan, vor der Generierung 0
generate_course scan_result, toc, target_html_path Letzter Schritt 0
scope_to_subdir subdir_path Großes Monorepo oder Feature-Fokus 0

Kosten & Limits

Was der Betrieb kostet

API-Kontingent
N/A
Tokens pro Aufruf
Erheblich — der Skill liest das gesamte Repository (typischerweise 10k–50k Token)
Kosten in €
Kostenlos; eigene Modell-Tokens gelten
Tipp
Für Monorepos scope_to_subdir verwenden; nicht alles auf einmal bearbeiten

Sicherheit

Rechte, Secrets, Reichweite

Minimale Scopes: filesystem-read filesystem-write
Credential-Speicherung: Keine
Datenabfluss: Keine — nur lokales Lesen/Schreiben

Fehlerbehebung

Häufige Fehler und Lösungen

Kurs ist zu generisch / referenziert keinen echten Code

Prompt spezifischer machen; file:line-Zitate anfordern

Repository zu groß; Kontext läuft über

scope_to_subdir verwenden; Pro-Modul-Kurse erstellen und verknüpfen

HTML-Formatierung kaputt

Den Skill die Ausgabe validieren lassen; bei Bedarf neu generieren

Alternativen

Codebase to Course vs. andere

AlternativeWann stattdessenKompromiss
Repomix + manueller PromptVolle Kontrolle über die Übermittlung des Codebases an Claude gewünschtMehr Setup; kein meinungsstarkes Ausgabeformat
DocsGPT / MintlifyGehostete Docs gewünschtVöllig anderes Produkt; keine Einzeldatei-HTML
absolutely-skilled / autodocAutomatisch generierte API-Docs gewünschtAPI-Referenz ≠ Tutorial

Mehr

Ressourcen

📖 Offizielle README auf GitHub lesen

🐙 Offene Issues ansehen

🔍 Alle 400+ MCP-Server und Skills durchsuchen