Documentation review について
Toolhiveの実際の動作に照らしてドキュメントを確認するレビュー用スキルです。主張、例、リンク、書式、誤字を検証し、文中の修正案は示さず、指摘事項をToDoリストにまとめます。
主な機能
- 01Toolhiveに関する記述の事実確認
- 02例と書式の確認
- 03リンクとリンク先の検証
- 04指摘事項をToDoリストに整理
活用シーン
- 01Toolhiveドキュメントの正確性確認
- 02ドキュメントの例とリンクの検査
- 03手動レビュー用チェックリストの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/documentation-reviewを入力して読み込まれたか確認します。
同梱ファイルCHECKING.mdEXAMPLES.md
詳細
コミットメッセージの生成
手順
- レビューするよう指示されたドキュメントを読みます
- toolhive の動作に関するすべての記述が正確であることを確認します
- すべての例が toolhive の実際の動作に基づいていることを確認し、書式、誤字、全体的な正確さをチェックします
- すべてのリンクが既存のファイルを指しており、リンク先の内容が適切であることを確認します
ドキュメント内の記述のファクトチェック
ドキュメント内の記述を確認する方法については、CHECKING.md を参照してください。
ファクトチェックの例については、EXAMPLES.md を参照してください。
レポート
- インラインでの変更は提案しないでください
- 見つかった問題を報告し、それぞれを ToDo リストにまとめてください。その後、ユーザーが手動で確認します
コメント
Markdown 対応