読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第3節 レビューの観点

3.2 意見の書き方

レビューの意見は、読んだ人が次に何をすればよいかが分かるように書きます。

よくない例何が困るかよい例
「ここはおかしい」何がどうおかしいか分からない「予約済みでない予約もキャンセルできてしまいます。markCancelled の引数の型を、予約済みの型に限りませんか」
「なんでこうしたの?」責めているように読める「ここを Client Components にした理由を教えてください。データを読むだけなら、Server Components のままにできそうです」
好みの話を、直す必要があることと同じ書き方で書くどれを直すべきか分からない「(好み)この名前は cancelReason のほうが分かりやすいと思います。直さなくてもかまいません」

意見には、重さの印を付けると、読んだ人が優先を決めやすくなります。

印意味
「必須」直してから合わせる(守りのもれ、決まりのまちがい)
「提案」直したほうがよいが、相談してよい
「好み」直さなくてもよい
解答の例

「必須:ログインと権限を確かめていないため、誰でも価格を変えられます。最初に await requireStaff(); を足してください」「必須:価格がマイナスや小数でも通ります。スキーマで 0 以上の整数か確かめてください」「提案:変更のあとに updateTag("products") を呼ぶと、商品のページにすぐに反映されます」のように書きます。

12 / 17