quality-review-checklist について
ドキュメントチームやコントリビューター向けの品質レビュー用スキルです。正確性、スタイル、アクセシビリティ、ローカライズ、コンプライアンス、リリース管理を再利用可能なテンプレートで整理します。
主な機能
- 01正確性と網羅性の確認
- 02スタイルと用語のレビュー
- 03アクセシビリティの確認
- 04ローカライズとコンプライアンスの確認
- 05バージョンとリリースの管理
- 06QA と承認用テンプレート
活用シーン
- 01公開前のドキュメント確認
- 02移行時の既存コンテンツ監査
- 03レビュー手順のコントリビューター研修
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ gtmagents/ gtm-agents --skill quality-review-checklistインストール後、Claude Code で/quality-review-checklistを入力して読み込まれたか確認します。
詳細
品質レビューのチェックリストスキル
使用する場面
- ドキュメント、チュートリアル、リリースノートの公開前の品質保証。
- 移行時に引き継いだコンテンツを監査する場合。
- 新しいコントリビューターに必須のレビュー手順を教える場合。
フレームワーク
- 正確性と網羅性 – 機能、パラメーター、スクリーンショット、例が最新のビルドと一致していることを確認します。
- スタイルと語調 – 対象読者に合わせて、スタイルガイド、用語、書式、語調を統一します。
- アクセシビリティ – 見出しの階層、代替テキスト、キャプション、コントラスト、キーボード操作、スクリーンリーダー向けの手がかりを確認します。
- ローカライズとコンプライアンス – 翻訳の範囲、法的免責事項、輸出管理、プライバシーに関する記述を確認します。
- バージョン管理 – バージョンタグ、変更履歴への記載、ロールバック計画、担当者の割り当てを確認します。
テンプレート
- 合格/不合格欄とメモ欄を備えたQAチェックリストのスプレッドシート。
- タイムスタンプとコメントを記入できるレビュアー承認シート。
- 重要度別に分類した、修正フォローアップ用の課題ログ。
ヒント
- レビュー担当者をペア(技術担当+編集担当)にすると、対応を迅速化できます。
- リンク、Markdown、アクセシビリティを確認するリンティングスクリプトを自動実行し、結果をチェックリストに添付します。
- 最終承認には
publish-release-documentationと併用します。
コメント
Markdown 対応