Automatisierte Doku-Updates
Erfahren Sie, wie der Claude-Code-Skill /update-jamdesk Änderungen an Ihrem Code in passende Updates für Ihre Jamdesk-Dokumentation umwandelt.
Der Skill /update-jamdesk für Claude Code überwacht Ihre Code-Änderungen und erzeugt passende Dokumentationsupdates. Führen Sie ihn aus, nachdem Sie ein nutzerseitiges Feature ausgeliefert haben. Er ermittelt, welche Dokumentationsseiten erstellt oder bearbeitet werden müssen.
Suchen Sie allgemeine Tipps zum Schreiben mit KI? Die Einrichtung des Tools finden Sie unter Claude Code. Allgemeinere Hinweise zum Verfassen von Dokumentation mit KI-Tools finden Sie unter Schreiben mit KI.
Wann Sie den Skill verwenden sollten
Verwenden, wenn: Sie nutzerseitige Änderungen an APIs, CLI-Befehlen, der Benutzeroberfläche, Konfigurationsoptionen oder dem Verhalten von Komponenten vorgenommen haben.
Überspringen, wenn: interne Refactorings, reine Teständerungen, Build- oder CI-Konfiguration oder Performance-Arbeiten ohne Verhaltensänderung vorliegen.
Voraussetzungen
- Claude Code ist installiert und konfiguriert
- Ein Jamdesk-Dokumentationsprojekt mit
docs.json - Optional: Jamdesk CLI zur Verifikation (
npm install -g jamdesk)
Schnellstart
Erstellen Sie in Ihrem Code-Repository eine Datei .jamdesk-docs-path, die auf Ihre Dokumentation verweist:
docs_path: ../my-docsDer Pfad kann relativ (ausgehend von der Konfigurationsdatei) oder absolut sein.
Führen Sie dies aus, nachdem Sie ein Feature implementiert haben:
/update-jamdeskClaude analysiert Ihre Änderungen und stellt Rückfragen, bevor die Dokumentation geschrieben wird.
Prüfen Sie die erzeugte Dokumentation. Claude verifiziert sie mit jamdesk validate und jamdesk broken-links, bevor committet wird.
Format der Konfigurationsdatei
Die Datei .jamdesk-docs-path teilt Claude mit, wo Ihre Dokumentation liegt.
Einfaches Format nur mit dem Pfad:
../my-docsVollständiges Format mit Optionen:
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainDer Skill sucht die Konfigurationsdatei, indem er vom aktuellen Verzeichnis bis zur Git-Wurzel nach oben geht. Legen Sie sie im Wurzelverzeichnis Ihres Repositorys ab.
Funktionsweise
Claude führt für /update-jamdesk diese Schritte aus:
- Dokumentation finden: sucht die Konfigurationsdatei
.jamdesk-docs-path - Rückfragen stellen: klärt Branch-Strategie, Umfang und Inhalt
- Bestehende Dokumentation analysieren: sucht nach verwandten Inhalten, die aktualisiert oder erweitert werden können
- Dokumentation schreiben: erstellt oder aktualisiert Seiten gemäß den Jamdesk-Standards, zuerst mit einfachen Beispielen
- Tonalität prüfen: Prüfen Sie die Ausgabe auf KI-Füllfloskeln. Claude schreibt besser mit einer CLAUDE.md, die den Stil vorgibt (siehe Claude Code)
- Verifizieren: führt
jamdesk validateundjamdesk broken-linksaus - Committen: stellt Änderungen bereit und bietet Commit, Push bzw. PR an
Führen Sie vor dem Committen git checkout . aus, um alle Änderungen zurückzusetzen.
| Szenario | Aktion |
|---|---|
| Neues Feature | Neue Seite erstellen |
| Verhaltensänderung | Bestehende Seite aktualisieren |
| Kleine Ergänzung | Abschnitt zu bestehender Seite hinzufügen |
| Große Funktion | Neue eigenständige Seite |
| Veraltung/Entfernung | Bestehende Seite aktualisieren + Migrationshinweise ergänzen |
Beispielsitzung
User: I just added a webhook feature. Can you document it?
Claude: I'm using the update-jamdesk skill to update your documentation.
Found .jamdesk-docs-path: ../customer-docs
How should I handle changes to the docs repository?
1. Create a new feature branch (recommended)
2. Update directly on main
3. Use current branch
User: 1
Claude: Based on the webhook implementation, I plan to:
- Create: webhooks/overview.mdx
- Update: getting-started.mdx (add link)
Any changes to this plan?
User: Looks good
Claude: [Creates documentation...]
✓ jamdesk validate passed
✓ jamdesk broken-links passed
Commit these changes?Vorschaumodus
Führen Sie den Befehl mit --preview aus, um zu sehen, was sich ändern würde, ohne Bearbeitungen vorzunehmen:
/update-jamdesk --previewDer Vorschaumodus ermöglicht Ihnen:
- zu prüfen, welche Dokumentation aktualisiert werden muss
- vorgeschlagene Änderungen vor dem Commit zu prüfen
- die Analyse des Skills ohne Nebenwirkungen zu sehen
Proaktive Vorschläge
Claude kann dies vorschlagen, nachdem Sie nutzerseitige Code-Änderungen committet haben:
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.Dies erscheint, wenn:
- eine Konfigurationsdatei
.jamdesk-docs-pathvorhanden ist UND - Ihr Commit Dateien enthält, die nutzerseitigen Mustern entsprechen (API, CLI, Komponenten)
Skill installieren
Installieren Sie den Skill /update-jamdesk mit der skills-CLI:
npx skills add jamdesk/skills --skill update-jamdeskDadurch wird der Skill nach .claude/skills/update-jamdesk/ in Ihrem Projekt installiert.
Installiert in Ihr aktuelles Projektverzeichnis:
npx skills add jamdesk/skills --skill update-jamdeskDer Skill ist verfügbar, wenn Sie in diesem Projekt arbeiten.
Verfügbare Skills auflisten
Alle Jamdesk-Skills anzeigen:
npx skills add jamdesk/skills --listAktualisieren
Führen Sie den Installationsbefehl erneut aus, um die neueste Version zu erhalten:
npx skills add jamdesk/skills --skill update-jamdeskStarten Sie Claude Code neu oder beginnen Sie eine neue Sitzung nach der Installation oder Aktualisierung.
Fehlerbehebung
Prüfen Sie, ob die Skill-Datei unter .claude/skills/update-jamdesk/SKILL.md liegt. Starten Sie danach Ihre Claude-Code-Sitzung neu.
Erstellen Sie .jamdesk-docs-path im Wurzelverzeichnis Ihres Repositorys mit dem Pfad zu Ihrem Dokumentationsverzeichnis. Der Skill sucht vom aktuellen Verzeichnis bis zur Git-Wurzel.
Installieren Sie sie mit npm install -g jamdesk. Der Skill funktioniert auch ohne sie, überspringt aber die automatisierte Validierung.