doc-sync
IdeaVimドキュメントとコード変更の整合性を確認
ドキュメントはコード更新後にしばしば乖離し、ユーザーに壊れた例を示してしまうことがあります。このスキルは、ドキュメントと実際のコードを比較し、不一致を特定するための構造化されたワークフローを提供します。
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「doc-sync」を使用しています。 Check README.md for outdated mappings examples
期待される結果:
- Found two examples with removed parameters in the mappings section
- README.md should reference the new MappingScope name instead of old name
- No other issues detected in the README file
「doc-sync」を使用しています。 Verify doc/ideavim-api.md after the 2.0 release
期待される結果:
- Identified 5 API signatures that changed in release 2.0
- 3 parameter names in examples need updating to match new signatures
- 1 code block uses a deprecated method that was removed
「doc-sync」を使用しています。 Check if CONTRIBUTING.md matches current git workflow
期待される結果:
- All git commands in CONTRIBUTING.md match current branch workflow
- No discrepancies found between documented steps and actual git behavior
セキュリティ監査
安全All 35 static findings are FALSE POSITIVES. The static analyzer misidentified markdown documentation text as security threats. SKILL.md is pure documentation containing workflow instructions and example bash commands shown as documentation - no executable code exists. The skill-report.json already correctly assessed this as safe with no risk factors.
リスク要因
🌐 ネットワークアクセス (1)
📁 ファイルシステムへのアクセス (1)
品質スコア
作れるもの
リリース後の監査
リリースサイクル完了後、ドキュメントが最近のAPI変更を反映していることを確認する。
PR前のドキュメントレビュー
ドキュメント更新の変更を提出する前に、例とパラメータ名を検証する。
回帰トリアージ
報告されたドキュメントの問題が実際のコード内のAPI変更に対応しているかどうかを確認する。
これらのプロンプトを試す
Check doc/ideavim-mappings.md against current code and list any mismatches found.
I changed MappingScope.kt. Identify affected documentation and propose specific updates.
Audit all files in doc/ for outdated examples and summarize findings in a report.
Validate all examples using map(), nmap(), and vmap() against current API signatures in code.
ベストプラクティス
- 比較前に実際の実装からグラウンドトルースを確立して開始する
- ドキュメントのドリフトを確認するとき、削除または名前変更されたAPI要素を優先する
- 更新は最小限に抑え、既存のドキュメントのスタイルと用語に合わせる
回避
- 根本の動作が正確でありながら表現を更新する
- コード例内の名前付きパラメータの検証をスキップする
- 実際の実装を確認せずにドキュメントが正しいと想定する