Openclaw向けContract Doc Sync

git分析とマルチエージェント合意メカニズムを使用して、コードとドキュメントが完全に一致していることを保証する洗練された同期ツールです。

leonardo-lb
v1.0.1
Apr 15, 2026
0
799
0

インストール&ダウンロード

1. ClawHub CLI

レジストリから直接スキルをインストールする最速の方法です。

npx clawhub@latest install contract-doc-sync

2. 手動インストール

スキルフォルダを以下のいずれかの場所にコピーしてください

グローバル
~/.openclaw/skills/
ワークスペース
<project>/skills/

優先順位:ワークスペース > ローカル > バンドル

3. プロンプトのインストール

このプロンプトをOpenClawにコピーするだけで、自動的にインストールされます。

Clawhubを使って contract-doc-sync をインストールして。Clawhubがインストールされていない場合は、先にインストールしてください(npm i -g clawhub)。

ダウンロードをご希望ですか?

ZIPアーカイブで生のスキルファイルを取得します。

Contract Doc Sync とは?

Contract Doc Syncは、手動作業なしで高精度なドキュメントを維持する必要がある開発者向けに設計された専門スキルです。Openclaw Skillsエコシステムに直接統合され、ソースコードとdocsフォルダ内のMarkdownファイルとの間のギャップを埋めます。このスキルはgit diffを分析してドリフト(実装が記述から乖離している状態)を検出し、自動修正を適用してプロジェクトの整合性を維持します。

このツールは安全性と正確性を基盤として構築されており、コードのプライバシーを保護するためにローカルで動作します。アーキテクチャドキュメント、APIリファレンス、およびモジュール規約の維持に重点を置いています。Openclaw Skills内で、コントローラー、エンティティ、および対応するドキュメントセクション間の関係を理解する自動テクニカルライターとして機能し、リポジトリ全体で技術的な正確性が一貫して保たれるようにします。

Contract Doc Sync のユースケース

  • コントローラーのシグネチャやエンドポイントの変更後に、APIリファレンスのMarkdownファイルを自動更新する。
  • エンティティ構造のリファクタリング時に、技術設計ドキュメントとMermaid図を同期する。
  • プルリクエストの提出やブランチのマージ前に、ドキュメントの一貫性監査を実行する。
  • 最新のコード変更と比較して、どのドキュメントが古くなっているかを特定するドリフトレポートを生成する。
  • 複雑なOpenclaw Skillsプロジェクトにおいて、モジュール間のドキュメント整合性を維持する。

Contract Doc Sync の仕組み

  1. フェーズ0 - 環境プロービング:プロジェクトのドキュメントアーキテクチャと技術スタックを検出し、ProjectDocProfileを構築します。
  2. フェーズ1 - 変更発見:ローカルのgit diffに対するPythonベースの分析を実行し、どのコード変更が特定のドキュメントターゲットに影響を与えるかを特定します。
  3. フェーズ2 - 同期修復:変更されたコードコンポーネントをドキュメントセクションにマッピングし、section parserを使用してMarkdownファイルに精密な編集を適用します。
  4. フェーズ3 - 合意検証:複数の独立したサブエージェントを配置し、10次元行列に基づいてドキュメントを検証し、反復チェックを通じて正確性を保証します。
  5. フェーズ4 - グローバルスキャン:高レベルの同期(L3)のために、すべての契約ドキュメントを包括的にスキャンし、プロジェクト全体でドリフトゼロを保証します。

Contract Doc Sync のセットアップ

Openclaw Skills環境にこのスキルをデプロイするには、ローカルシステムが以下の要件を満たしていることを確認してください:

# コア依存関係がインストールされているか確認
python3 --version
git --version
bash --version

# オプション:パフォーマンス最適化のためにripgrepをインストール
rg --version

このスキルは自己構成されます。sync docsやcheck driftのようなコマンドをトリガーすると、エージェントは自動的に$SKILL_DIRとローカルスクリプトを利用して同期プロセスを開始します。標準運用において外部環境変数は不要です。

Contract Doc Sync のデータスキーマとタクソノミー

このスキルは、Openclaw Skillsがあらゆる変更を追跡できるように、構造化されたメタデータとファイリングシステムを通じて操作を整理します:

データ要素 形式 説明
ProjectDocProfile JSON docSystem、追跡、およびコードとドキュメントのマッピングルールを定義。
Drift Report JSON 変更されたファイル、カテゴリ、および特定のドキュメントへの影響をキャプチャ。
Section Parser Shell Script Markdownセクションを詳細に読み書きするための専用ツール。
Verification Matrix Table APIシグネチャやセマンティックロジックを含む10次元(D1-D10)を追跡。
Audit Log Markdown 自動修正、提案された変更、および手動レビュー項目の詳細な履歴。

Contract Doc Sync の高度な機能

  • 多段階同期プロトコル:Openclaw Skills内でのニーズに応じて、L0(検出)、L1(高速同期)、L2(合意同期)、L3(深層セマンティック監査)から選択可能。
  • マルチエージェント合意:サブエージェントが連続したエラーのない通過を通じてドキュメントの正確性について合意に達する必要がある検証プロトコルを採用。
  • セマンティック一貫性エンジン(D10):LLMを活用した推論を使用して、ドキュメント内の自然言語がコード内の技術的ロジックと一致しているかを確認。
  • 書き込み保護ホワイトリスト:docs/ディレクトリへの変更のみを許可する厳格な安全境界を実装し、ソースコードが変更されないことを保証。
  • プロジェクト固有のオーバーライド:開発者がAGENTS.mdまたはCLAUDE.mdにカスタムドキュメントルールを定義でき、このスキルはデフォルト設定よりも優先する。

SKILL.md


ローディング

関連するOpenclawのスキル

特徴*