Ein hochentwickeltes Dokumentationssynchronisations-Tool, das Git-Analyse und einen Multi-Agenten-Konsens nutzt, um sicherzustellen, dass Code und Dokumentation perfekt aufeinander abgestimmt bleiben.
Installieren & Herunterladen
1. ClawHub CLI
Der schnellste Weg, einen Skill direkt aus der Registry zu installieren.
npx clawhub@latest install contract-doc-sync
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, contract-doc-sync ü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 Contract Doc Sync?
Contract Doc Sync ist eine spezialisierte Fähigkeit für Entwickler, die eine hochpräzise Dokumentation ohne manuellen Aufwand pflegen müssen. Durch die direkte Integration in das Openclaw Skills-Ökosystem schließt es die Lücke zwischen dem Quellcode und den Markdown-Dateien in den docs-Ordnern. Die Fähigkeit analysiert Git-Diffs, um Drift zu erkennen – Fälle, in denen die Implementierung über ihre schriftliche Beschreibung hinausgewachsen ist – und wendet automatisierte Korrekturen an, um die Projektintegrität zu wahren.
Dieses Tool basiert auf Sicherheit und Präzision und arbeitet lokal, um den Datenschutz des Codes zu gewährleisten. Es konzentriert sich auf die Pflege von Architektur-Dokumenten, API-Referenzen und Modulkonventionen. Innerhalb von Openclaw Skills fungiert es als automatisierter technischer Autor, der die Beziehung zwischen Controllern, Entitäten und den entsprechenden Dokumentationsabschnitten versteht und sicherstellt, dass Ihre technische Wahrheit im gesamten Repository konsistent bleibt.
Contract Doc Sync Anwendungsfälle
- Automatische Aktualisierung von API-Referenz-Markdown-Dateien nach Änderungen an Controller-Signaturen oder Endpunkten.
- Synchronisierung von technischen Designdokumenten und Mermaid-Diagrammen bei der Umstrukturierung von Entitäten.
- Durchführung einer Dokumentationskonsistenzprüfung vor dem Einreichen von Pull Requests oder dem Zusammenführen von Branches.
- Erstellung eines Drift-Berichts, um zu identifizieren, welche Teile der Dokumentation im Vergleich zu den neuesten Codeänderungen veraltet sind.
- Aufrechterhaltung der Dokumentationskonsistenz zwischen Modulen in komplexen Openclaw Skills-Projekten.
So funktioniert Contract Doc Sync
- Phase 0 - Umgebungsprüfung: Die Fähigkeit erkennt die Dokumentationsarchitektur des Projekts und den Tech-Stack, um ein ProjectDocProfile zu erstellen.
- Phase 1 - Änderungsentdeckung: Führt eine Python-basierte Analyse lokaler Git-Diffs durch, um zu identifizieren, welche Codeänderungen Auswirkungen auf bestimmte Dokumentationsziele haben.
- Phase 2 - Synchronisationsreparatur: Ordnet geänderte Code-Komponenten den Dokumentationsabschnitten zu und nimmt präzise Bearbeitungen an den Markdown-Dateien mithilfe eines section parser vor.
- Phase 3 - Konsensprüfung: Setzt mehrere unabhängige Unter-Agenten ein, um die Dokumentation anhand einer 10-Dimensionen-Matrix zu verifizieren und durch wiederholte Durchläufe Genauigkeit sicherzustellen.
- Phase 4 - Globaler Scan: Für eine Synchronisation auf hoher Ebene (L3) führt es einen umfassenden Scan aller Vertragsdokumente durch, um eine Null-Drift im gesamten Projekt zu gewährleisten.
Contract Doc Sync Einrichtung
Um diese Fähigkeit in Ihrer Openclaw Skills-Umgebung bereitzustellen, stellen Sie sicher, dass Ihr lokales System die folgenden Anforderungen erfüllt:
# Überprüfen, ob die Kernabhängigkeiten installiert sind
python3 --version
git --version
bash --version
# Optional: Installieren Sie ripgrep für optimierte Leistung
rg --version
Die Fähigkeit konfiguriert sich selbst. Wenn Sie Befehle wie sync docs oder check drift auslösen, nutzt der Agent automatisch $SKILL_DIR und lokale Skripte, um den Synchronisationsprozess zu starten. Für den Standardbetrieb sind keine externen Umgebungsvariablen erforderlich.
Contract Doc Sync Datenschema & Taxonomie
Die Fähigkeit organisiert ihre Abläufe durch ein strukturiertes Metadaten- und Ablagesystem, damit Openclaw Skills jede Änderung nachverfolgen kann:
| Datenelement | Format | Beschreibung |
|---|---|---|
| ProjectDocProfile | JSON | Definiert docSystem, Nachverfolgung und Code-zu-Dokument-Zuordnungsregeln. |
| Drift Report | JSON | Erfasst geänderte Dateien, Kategorien und spezifische Dokumentationsauswirkungen. |
| Section Parser | Shell Script | Ein Spezialwerkzeug für das granulare Lesen und Schreiben von Markdown-Abschnitten. |
| Verification Matrix | Table | Verfolgt 10 Dimensionen (D1-D10), einschließlich API-Signaturen und semantischer Logik. |
| Audit Log | Markdown | Detaillierte Historie automatisierter Korrekturen, vorgeschlagener Änderungen und manueller Prüfpunkte. |
Contract Doc Sync Erweiterte Funktionen
- Mehrstufiges Synchronisationsprotokoll: Wählen Sie je nach Bedarf innerhalb von Openclaw Skills zwischen L0 (Erkennung), L1 (Schnelle Synchronisation), L2 (Konsens-Synchronisation) und L3 (Tiefe semantische Prüfung).
- Multi-Agenten-Konsens: Nutzt ein Verifizierungsprotokoll, bei dem Unter-Agenten durch aufeinanderfolgende fehlerfreie Durchläufe eine Einigung über die Dokumentationsgenauigkeit erzielen müssen.
- Semantische Konsistenz-Engine (D10): Verwendet LLM-gestützte Argumentation, um zu überprüfen, ob die natürliche Sprache in Ihren Dokumenten mit der technischen Logik in Ihrem Code übereinstimmt.
- Schreibschutz-Whitelist: Implementiert strenge Sicherheitsgrenzen, die nur Änderungen an docs/-Verzeichnissen zulassen, wodurch sichergestellt wird, dass der Quellcode unberührt bleibt.
- Projektspezifische Überschreibungen: Ermöglicht Entwicklern, benutzerdefinierte Dokumentationsregeln in AGENTS.md oder CLAUDE.md zu definieren, die die Fähigkeit gegenüber Standardeinstellungen priorisiert.
SKILL.md
Laden
Verwandte Openclaw-Skills
Text-zu-Video-Bearbeitungs-KI
Eine KI-gestützte Videobearbeitungs-Fähigkeit, die Rohmaterial mithilfe einfacher natürlicher Sprachbefehle in professionelle Clips umwandelt.
Kartenoptimierungsstrategie
Ein leistungsstarkes algorithmisches Framework zur Lösung komplexer Platzierungs- und Constraint-Optimierungsprobleme auf räumlichen Gittern.
SQLite Map Parser
Ein technisches Dienstprogramm zur Untersuchung von SQLite-Datenbankschemas und zur Transformation relationaler Daten in strukturierte JSON-Maps oder -Arrays.
AI Video Maker Free Long
Ein cloudbasiertes KI-Videoproduktionstool, das Rohbilder und Skripte in professionelle lange MP4-Videos mit Übergängen und Musik umwandelt.
Bildbasierter Untertitel-Generator
Eine KI-gestützte Videoproduktions-Skill, die statische Bilder durch Remote-GPU-Rendering in 1080p MP4-Clips mit Untertiteln umwandelt.
Image to Video No Filter
Ein leistungsstarkes KI-Skill, das Standbilder mithilfe von Remote-GPU-Rendering in ungefilterte 1080p-Videoclips umwandelt.
Hervorgehoben*
