doc-code-sync
Installation
SKILL.md
doc-code-sync: ドキュメント・コード整合性チェックスキル
プロジェクトのドキュメントとコードの不整合を6カテゴリで検出し、レポートを生成する。
検出カテゴリ
| カテゴリ | 説明 | 重要度デフォルト |
|---|---|---|
BROKEN_REF |
ドキュメントが参照するコード(ファイルパス、関数名等)が存在しない | CRITICAL |
UNDOCUMENTED |
公開コード(export された関数/クラス/型)にドキュメントがない | WARNING |
STALE_EXAMPLE |
ドキュメント内のコード例のシグネチャが実際のコードと不一致 | CRITICAL |
CONFIG_DRIFT |
設定値・環境変数のドキュメント記載と実際の不一致 | WARNING |
API_DRIFT |
API エンドポイントのドキュメント記載と実際の不一致 | CRITICAL |
VERSION_DRIFT |
バージョン番号・依存関係のドキュメント記載と実際の不一致 | INFO |