Ein intelligenter Workflow-Agent, der Projektdokumentation mit Codeänderungen durch vollständige Audits oder inkrementelle git diffs synchronisiert.
Installieren & Herunterladen
1. ClawHub CLI
Der schnellste Weg, einen Skill direkt aus der Registry zu installieren.
npx clawhub@latest install update-project-docs
2. Manuelle Installation
Kopiere den Skill-Ordner an einen dieser Orte
~/.openclaw/skills/ <project>/skills/ Priorität: Workspace > Lokal > Integriert (Bundled)
3. Prompt-Installation
Kopiere diesen Prompt in OpenClaw, um ihn automatisch zu installieren.
Hilf mir, update-project-docs über Clawhub zu installieren. Falls Clawhub nicht installiert ist, installiere es bitte zuerst (npm i -g clawhub).
Lieber herunterladen?
Hole dir die rohen Skill-Dateien in einem ZIP-Archiv.
Was ist Documentation Updater?
Documentation Updater ist ein hochentwickeltes AI-Agent-Skill, das entwickelt wurde, um die Lücke zwischen sich schnell entwickelndem Quellcode und statischer Dokumentation zu schließen. Durch die Nutzung von Openclaw Skills automatisiert dieses Tool den mühsamen Prozess der Identifizierung fehlender, veralteter oder obsoleten Teile Ihrer Dokumentation basierend auf Ihren letzten git commits.
Egal, ob Sie ein riesiges Monorepo oder ein kleines Utility verwalten, dieses Skill passt sich Ihrem bestehenden Dokumentations-Framework an – von Docusaurus und MkDocs bis hin zu Zero-Build-Systemen wie Docsify. Es stellt sicher, dass Ihre technische Schuld gering bleibt, indem es einen strengen Synchronisationspunkt erzwingt, was präzise inkrementelle Updates bei jeder Änderung Ihrer Codebasis ermöglicht.
Documentation Updater Anwendungsfälle
- Automatische Aktualisierung von API-Referenzen, wenn sich Funktionssignaturen im Quellcode ändern.
- Durchführung eines vollständigen Projektaudits, um Dokumentationslücken in alten Repositories zu identifizieren.
- Aufbau einer komplett neuen Dokumentationsinfrastruktur für Projekte, denen eine formale Dokumentationsseite fehlt.
- Bereinigung veralteter Dokumentationen und Zusammenführung redundanter Anleitungen zur Verbesserung der Wartbarkeit.
- Sicherstellung, dass die Seitenleisten-Navigation und die Dateisystemstrukturen nach Funktions-Refactorings perfekt ausgerichtet bleiben.
So funktioniert Documentation Updater
- Pre-flight-Check: Das Skill überprüft einen sauberen Arbeitsbaum und lokalisiert den zuletzt aufgezeichneten Synchronisationspunkt mithilfe einer .docs-sync-Datei oder Metadaten-Tags.
- Auswahl des Ausführungsmodus: Es bestimmt, ob ein vollständiges Projektaudit erforderlich ist (erstmalige Ausführung) oder ob eine inkrementelle Überprüfung basierend auf einem git diff seit dem letzten Synchronisations-Hash durchgeführt werden kann.
- Strukturerkennung: Es analysiert das Repository, um Dokumentationswurzeln, Konfigurationsdateien (wie mkdocs.yml) und Navigationshierarchien zu finden.
- Lückenanalyse: Durch den Vergleich von Codesymbolen mit Dokumentationsinhalten wird abgebildet, was erstellt, aktualisiert oder gelöscht werden muss.
- Ausführung: Das Skill erstellt fehlende Dateien, aktualisiert bestehende und strukturiert Verzeichnisse um, um den Anforderungen der Seitenleiste des Projekts zu entsprechen.
- Validierung & Synchronisierung: Es führt projektspezifische Linting-Tools aus und zeichnet einen neuen commit-Hash auf, um die Dokumentation als mit dem aktuellen Code-Status synchronisiert zu markieren.
Documentation Updater Einrichtung
Um dies innerhalb der Openclaw Skills-Umgebung zu verwenden, stellen Sie sicher, dass Ihr Repository ein git-verwaltetes Projekt ist. Es ist keine spezielle globale Installation erforderlich, außer dem Zugriff auf Ihre Codebasis.
# Prüfen Sie, ob Ihr Projekt für einen Synchronisationsdatensatz bereit ist
ls -a | grep .docs-sync
# Wenn Sie neu anfangen, führt Sie das Skill durch die Erstellung des ersten Datensatzes:
echo "<current-git-hash>" > .docs-sync
Documentation Updater Datenschema & Taxonomie
Das Skill verwaltet seinen Status und versteht die Projekttopologie durch das folgende Schema:
| Datei/Komponente | Beschreibung |
|---|---|
| .docs-sync | Eine Tracking-Datei, die den zuletzt synchronisierten commit-Hash und einen ISO-8601-Zeitstempel enthält. |
| Sidebar Config | Quellen der Wahrheit wie _sidebar.md oder sidebars.js, die zur Definition der Dokumentationshierarchie verwendet werden. |
| Navigation Map | Eine logische Zuordnung zwischen Quellcode-Verzeichnissen (z. B. /src) und Dokumentationsverzeichnissen (z. B. /docs/api). |
| Metadata | Frontmatter in Markdown-Dateien (YAML/TOML), das zur Nachverfolgung von Versionierung und dokumentspezifischen Synchronisationsstatus verwendet wird. |
Documentation Updater Erweiterte Funktionen
- Vollständiges Projektaudit: Ein Deep-Scan-Modus, der die gesamte Codebasis liest, um eine Baseline für zukünftige Updates zu etablieren.
- Erzwingung absoluter Pfade: Konvertiert automatisch relative Seitenleisten-Links in absolute Pfade, um 404-Fehler in verschachtelten Doc-Seiten zu verhindern.
- Docsify-Scaffolding: Generiert automatisch eine vollständige, Zero-Build-Dokumentationsseite, wenn keine Infrastruktur erkannt wird.
- Inkrementelle Diff-Filterung: Überspringt intelligent interne Refactorings, während öffentlich sichtbare API-Änderungen priorisiert werden.
- Unterstützung für mehrere Systeme: Native Erkennung von MkDocs, Docusaurus, Sphinx, mdBook, VitePress und mehr.
SKILL.md
Laden
Verwandte Openclaw-Skills
Agency Agents
Eine umfassende Bibliothek von 193 Plug-and-Play-KI-Experten-Agenten, die für die Bewältigung professioneller Aufgaben in den Bereichen Technik, Design, Marketing und Wirtschaft entwickelt wurden.
Hermes Agent Integration
Verbinden Sie OpenClaw mit dem NousResearch Hermes Agent, um autonome Lernzyklen und Multi-Plattform-Agenten-Orchestrierung zu nutzen.
obclip
Ein spezialisiertes CLI-Dienstprogramm, das entwickelt wurde, um Live-Webseiten in saubere, strukturierte Markdown-Dateien oder integrierte Obsidian-Notizen umzuwandeln.
Massen-E-Mail-Versand
Ein spezialisiertes Tool zum Versenden großer Mengen personalisierter E-Mails durch Zusammenführung von Tabellendaten mit benutzerdefinierten Vorlagen.
Anforderungsspezifikation
Ein professionelles Framework zur Erstellung vollständiger, messbarer und umsetzbarer Produktanforderungsdokumente unter Verwendung eines strukturierten 8-Dimensionen-Ansatzes.
LLM Key Pool
Ein ausgeklügeltes API Key Verwaltungssystem mit mehrstufiger Rotation und intelligentem Failover, um ununterbrochenen LLM-Zugriff zu gewährleisten.
Hervorgehoben*
