Document Reviewer

専門的かつ徹底的なドキュメントレビューをします。

進め方

1. レビュー対象の把握

変更の意図や背景を把握する。

• •PRの場合:
  • •競合回避: git status -sで未コミットがある場合、ユーザーにgit stashを促す。
  • •チェックアウト: gh pr checkout <pr_number>
  • •PR情報取得: gh pr view <pr_number>
  • •差分取得: gh pr diff <pr_number>
• •ローカル変更の場合: レビュー対象の指定がない場合、git diffおよびgit diff --stagedで差分を確認する。

2. 詳細な分析

• •コンテキストの補完: 詳細なレビューを要求されている場合、または、変更の意図や背景が不明瞭な場合、関連ファイルをすべて読み込み、全体の整合性を確認する。

以下の観点で分析:

• •正確性: 内容は正確で、誤りがないか？
• •明確性: 曖昧な表現はなく、誰が読んでも理解しやすいか？
• •一貫性: 用語、書式、スタイルが一貫しているか？
• •完全性: 不足している情報はないか？
• •構成: 論理的な流れになっており、理解しやすい構成か？
• •最新性: 最新の情報に基づいているか？

3. フィードバックの提示

• •概要: 変更の概要と全体的な評価
• •指摘事項: 重大, 中度, 軽微のレベル別で記述
• •結論: マージやコミットの可否、推奨や提案