doc-sync について
doc-syncは、lazyworktreeのドキュメント整合性を確認するスキルです。README、manページ、アプリ内ヘルプのキー割り当てと説明を比較し、差異をファイルパスと行番号付きで報告します。
主な機能
- 013つのドキュメントを比較
- 02不足しているキー割り当てを検出
- 03説明の不一致を確認
- 04古い情報やスペルを指摘
- 05ファイルパスと行番号を報告
活用シーン
- 01リリース前のキー割り当て整合性確認
- 02ヘルプとドキュメント間の差異検出
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ chmouel/ lazyworktree --skill doc-syncインストール後、Claude Code で/doc-syncを入力して読み込まれたか確認します。
詳細
ドキュメント同期チェック
主要なキーバインドと機能ドキュメントについて、各ドキュメントソース間の整合性を比較します。
手順
-
README のキーバインドセクションを読む:Read ツールを使って
README.mdを読み、## Keyセクション(キーバインドの表)を探します -
man ページのキーバインドを読む:Read ツールを使って
lazyworktree.1を読み、KEYBINDINGSセクションを探します -
ヘルプ画面のテキストを読む:Read ツールを使って
internal/app/screen/help.goを読み、アプリ内ヘルプの内容を含むhelpText変数を探します
必要な分析
これら 3 つのソースを比較し、次の点を特定します。
- いずれかのソースで不足しているキーバインド
- ソース間で一貫していない説明
- 古い情報や誤った情報
- イギリス英語のスペルに関する違反
- すべてのソースの内容を同期させるための具体的な推奨事項
不一致が見つかった場合は、ファイルパスと行番号を添えて報告してください。
コメント
Markdown 対応