DocCoverageは、コードベースをスキャンして、複数のプログラミング言語におけるドキュメントの欠落、不完全なdocstrings、品質のギャップを特定する自動化された分析ツールです。
インストール＆ダウンロード
1. ClawHub CLI
レジストリから直接スキルをインストールする最速の方法です。
npx clawhub@latest install doccoverage
2. 手動インストール
スキルフォルダを以下のいずれかの場所にコピーしてください
~/.openclaw/skills/ <project>/skills/ 優先順位：ワークスペース > ローカル > バンドル
3. プロンプトのインストール
このプロンプトをOpenClawにコピーするだけで、自動的にインストールされます。
Clawhubを使って doccoverage をインストールして。Clawhubがインストールされていない場合は、先にインストールしてください（npm i -g clawhub）。
ダウンロードをご希望ですか？
ZIPアーカイブで生のスキルファイルを取得します。
DocCoverage とは？
DocCoverageは、高品質なコードベースを維持するために設計された包括的なドキュメント監査ツールです。最も実用的な Openclaw Skills の1つとして、ソースコード内の不足している JSDoc、docstrings、READMEセクションを評価します。JavaScript、TypeScript、Python、Go、Java、Rubyなどの主要な言語をサポートしており、パブリック関数やエクスポートされた型が適切に説明されていることを確認します。
85以上のドキュメント標準に対するregexベースのパターンマッチングを活用することで、開発者がコードとドキュメントの間のギャップを埋めることを支援します。個人プロジェクトであれ大規模なエンタープライズリポジトリであれ、DocCoverageは実用的なスコアと修正手順を提供し、プロジェクトドキュメント全体の健全性を向上させます。
DocCoverage のユースケース
- 大規模リポジトリ内の未定義のパブリック関数やエクスポートされたクラスを特定。
- READMEやCHANGELOGファイル内の欠落セクションや一貫性のないバージョン管理を監査。
- pre-commit hooksを使用して、コードをバージョン管理にコミットする前にドキュメント標準を強制。
- チームの基準監査用の詳細なドキュメントカバレッジレポートを生成。
- 重複するコメント、チケット参照のないTODO、またはコメントアウトされたコードブロックを検出。
DocCoverage の仕組み
- このスキルはターゲットのファイルやディレクトリを特定し、ファイル拡張子に基づいてプログラミング言語を自動検出します。
- 85以上のドキュメント品質パターンを実行し、不足しているdocstrings、不足しているパラメータ、不完全な戻り値の説明をスキャンします。
- 識別された問題の重大度に基づいて減点され、0から100までのドキュメントカバレッジスコアが計算されます。
- 行番号、チェックID、重大度、具体的な改善案など、詳細な調査結果がユーザーに報告されます。
- 上位ティアでは、結果をgit hooksに統合したり、SARIFファイルとしてエクスポートしてCI/CDパイプラインにシームレスに統合できます。
DocCoverage のセットアップ
Openclaw Skillsに追加されたこの機能の使用を開始するには、以下のインストール手順に従ってください:
# 必要なgit hooksマネージャーをインストール (無料ティアでは任意)
brew install lefthook
# ローカル設定ファイルにライセンスキーを設定
# パス: ~\/.openclaw\/openclaw.json
# 現在のディレクトリで手動スキャンを実行
bash "<SKILL_DIR>\/scripts\/doccoverage.sh" scan .
DocCoverage のデータスキーマとタクソノミー
DocCoverageは、構造化されたスコアリングシステムとメタデータ分類に基づいて調査結果を整理します:
| カテゴリ | 詳細 |
|---|---|
| スコアリングシステム | 0-100スケール; 減点: 致命的(25), 高(15), 中(8), 低(3)。 |
| ファイルサポート | .js, .ts, .py, .go, .java, .rb および Markdownファイルを分析。 |
| 出力形式 | コンソール出力、Markdownレポート、および SARIF 2.1.0 JSON。 |
| メタデータ | チェックID、ファイルパス、行番号、改善アドバイスを含む。 |
DocCoverage の高度な機能
- Lefthook経由のGit pre-commit hook統合により、ドキュメント化されていないコードのコミットをブロック。
- 組織固有のドキュメント標準に対するカスタムポリシーの適用。
- gitタグと照合した自動CHANGELOG検証により、バージョン履歴の一貫性を確保。
- オフラインでのライセンス検証により、ソースコードが外部サーバーに送信されないことを保証。
- マルチ言語スキャン機能により、polyglotリポジトリを一度に処理可能。
SKILL.md
ローディング
関連するOpenclawのスキル
FuelWatch SA トラッカー
供給不足期間中の南アフリカ全域の価格と可用性を監視するために設計された、モバイルファーストのクラウドソーシング燃料追跡プラットフォームです。
メール承認ワークフロー
AIエージェントが外部向けの専門的な通信を作成、レビュー、送信するための堅牢なHuman-in-the-Loopプロトコル。
モデルレート制限リカバリ
エージェントの稼働時間を維持するために、モデルプロバイダーのレート制限および429エラーを診断し、そこから回復するための技術的フレームワーク。
Affiliate Marketing Optimizer
データ駆動型の製品選定、リンク最適化、コンプライアンス監査を通じてアフィリエイト収益を最大化するように設計された自動化ツール。
Gmail + Gog 設定
Gog CLI を使用して AI Agent を Gmail に接続し、自動メール読み取りとメールボックス認証を有効にします。
メールウェブインターフェース
Gmail および Gog CLI 統合を通じて AI agent のメールアカウントを管理するための効率的なウェブダッシュボード。
特徴*
