shortcut-audit について
コード内のショートカット定義とドキュメントを照合する監査スキルです。記載漏れや古い項目、OS レベルの競合を報告し、WYSIWYG と Source モードの割り当てを個別に確認します。
主な機能
- 01ショートカット文書の確認
- 02コード内の定義箇所の特定
- 03割り当てと文書の照合
- 04記載漏れと削除済み項目の報告
- 05OS 競合とモード別割り当ての確認
活用シーン
- 01文書にないショートカットの特定
- 02削除済み割り当ての文書記載を発見
- 03OS のショートカットとの競合確認
- 04WYSIWYG と Source モードの割り当て確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ xiaolai/ vmark --skill shortcut-auditインストール後、Claude Code で/shortcut-auditを入力して読み込まれたか確認します。
同梱ファイルreferences/paths.md
詳細
ショートカット監査
概要
コード内のショートカット定義とドキュメントを比較し、抜けや競合を報告します。
ワークフロー
- ドキュメントを読みます:
website/guide/shortcuts.md(リポジトリ内の主要ドキュメント)dev-docs/shortcuts.md(存在する場合。常に作成されるわけではありません)
- ショートカットの定義元をコードから検索します(
references/paths.mdを参照)。 - コード内の現在のショートカットを抽出し、ドキュメントの項目に対応付けます。
- 以下を報告します:
- ドキュメントに記載されていない項目
- 削除済みのショートカットを参照しているドキュメント
- OS レベルの競合や重複
- 変更が依頼された場合は、更新案と必要なテストを提案します。
注意事項
- WYSIWYG モードとソースモードのキー割り当てを個別に確認してください。
- 再設計の指示がない限り、VMark の既存の規約を優先してください。
コメント
Markdown 対応