伝わるコードレビュー―開発チームの生産性を高める「上手な伝え方」の教科書 [単行本]

伝わるコードレビュー―開発チームの生産性を高める「上手な伝え方」の教科書 の 商品概要

• 要旨（「BOOK」データベースより）

  コメントひとつで、開発はスムーズになる。“すぐに”“明確に”“ストレスなく”伝わるプルリクエスト・レビューコメントの書き方がわかる！１９の課題シーン／３３のＴＩＰＳで学ぶ。

• 目次

  【Part1　心構え編】
  ・「伝わるコードレビュー」とは
  　-この本は何のための・どのような本か
  　-コードレビューの利点と難しさ
  　-コードレビューはコミュニケーション

  ・伝わるコードレビューの5大ルール
  　-コードレビューで守るべきルール
  　-ルール（1）：決めつけない
  　-ルール（2）：客観的な根拠に基づく
  　-ルール（3）：お互いの前提知識を揃える
  　-ルール（4）：チームで仕組みを作る
  　-ルール（5）：率直さを心がける
  　-コードレビューは双方向のコミュニケーション
  

  【Part2　実践編】
  Case1：緊張感のあるレビューコメント
  Case2：説明不足のPR
  Case3：進捗が遅れているPR
  Case4：考え方・価値観の食い違い
  Case5：細かすぎるレビューコメント
  Case6：Lintツールの言いなりの修正
  Case7：「あの人が言っているから大丈夫」という思考停止
  Case8：質問コメントに答えない修正PR
  Case9：レビューポイントがわかりにくいPR
  Case10：気を遣いすぎたレビューコメント
  Case11：レビューされないPR
  Case12：前提が揃っていないPR
  Case13：コメントへの訂正情報の不足
  Case14：放置された議論
  Case15：見過ごされた質問コメント
  Case16：想像に基づく修正
  Case17：調べる前に相手に投げてしまう質問
  Case18：関係者へ確認ができていないPR
  Case19：感情的なコメント
  

  【Part3　TIPS編】
  1：クイズを出さない
  2：命令しない
  3：性善説で考える
  4：相手の意図を断定しない
  5：まずは共感を示す
  6：チームで共有するタグを作る
  7：Lintツールを入れる
  8：作業ログをつけて参照場所をリンクする
  9：相談までの時間を決める
  10：詰まっていることを伝える
  11：わからないレベルを伝える
  12：遠回しに言わない
  13：自分の考え・意見を添える
  14：根拠がないなら根拠がないことを添える
  15：詳細を明示する
  16：何をして欲しいかを伝える
  17：「念のため」の確認をする
  18：同期コミュニケーションに移行する
  19：質問先を明示する
  20：上手に催促する
  21：期限を明示する
  22：すぐに返せないことを伝える
  23：聞きたいことを絞る
  24：相手の知識に合わせる
  25：はい・いいえで答えてもらう
  26：論破ではなく納得を目指す
  27：Before／Afterの画像を載せる
  28：「やっていないこと」を書く
  29：テンプレートを用意する
  30：ラベルをつける
  31：箇条書きを使う
  32：レビュアーを指名するロジックを作る
  33：相手の理解の段階を踏む

• 出版社からのコメント

  開発現場で行われる「コードレビュー」を円滑に進めるためのプルリクエストやレビューコメントの書き方を解説。

• 内容紹介

  コードレビューを円滑に進めたいあなたへ。
  効率的なテキストコミュニケーションの技法を身につけよう。

  コードレビューは、チームで開発するプロダクトの品質を高める重要なプロセスです。しかし、オンライン上のテキストコミュニケーションが基本となるコードレビューでは、「意図が正しく伝わらない」「受け手がネガティブに受け取ってしまう」などのすれ違いが頻発し、手戻りや誤解を生んでしまうことも少なくありません。

  本書は、そんな意図や感情のすれ違いを起こさない「伝わるコードレビュー」の技法を解説した書籍です。具体的な19の事例シーンをもとに、わかりやすいプルリクエスト・レビューコメントの書き方や効果的なレビューの進め方を詳しく解説します。

  事例シーンは、
  ・緊張感のあるレビューコメントが返ってきたとき
  ・説明不足のPRが提出されたとき
  ・考え方や価値観が食い違ったとき
  など、開発現場のコードレビューでよくあるミスコミュニケーションのケースを収録。かわいいキャラクターとともに、問題の原因と対策を整理し、実践的な解決アプローチを提案します。

  「レビューのつもりが指摘合戦になってしまう」
  「何を伝えたいのかわからないコメントが飛び交ってしまう」
  そんな悩みを抱える開発チームにとって、本書はよりよいコードレビューの指針を示すガイドラインになるはずです。レビューの指摘が的確に伝わり、レビューを受ける側も納得感をもって改善できる―そんなスムーズなコードレビューの技法を、本書で身につけましょう。

  ■解説TIPS（一部）
  クイズを出さない／性善説で考える／チームで共有するタグを作る／作業ログをつけて参照場所をリンクする／相談までの時間を決める／わからないレベルを伝える／自分の考え・意見を添える／詳細を明示する／「念のため」の確認をする／上手に催促する／聞きたいことを絞る／Before／Afterの画像を載せる／テンプレートを用意する／ラベルをつける……他、多数の実践的なTIPSを収録！

  ■対象読者
  ・コードレビューのよりよいやり方を知りたい現場のエンジニア、メンター
  ・チーム全体でコードレビューの指針を整えたいリーダー・マネージャー
  ・はじめてコードレビューをする新人エンジニア

• 著者紹介（「BOOK著者紹介情報」より）（本データはこの書籍が刊行された当時に掲載されていたものです）

  鳥井 雪(トリイ ユキ)
  プログラマー、ＮＰＯ法人Ｗａｆｆｌｅカリキュラム・マネージャー、万葉フェロー。令和５年度版東京書籍の国語教科書にプログラミングに関する文章掲載。Ｒａｉｌｓ　Ｇｉｒｌｓ　ＴｏｋｙｏやＮＰＯ法人Ｗａｆｆｌｅ等において女性や初学者のための活動経験多数。２０２４年Ｆｏｒｂｅｓ　ＪＡＰＡＮ「Ｗｏｍｅｎ　Ｉｎ　Ｔｅｃｈ　３０：テクノロジー領域で未来を創造する３０人の女性」選出
  
  久保 優子(クボ ユウコ)
  ２００７年に大場寧子とともに株式会社万葉を創業し、副社長ＣＯＯとして営業を一手に担っている。元Ｒａｉｌｓエンジニア
  
  諸永 彩夏(モロナガ アヤカ)
  株式会社万葉に所属するプログラマー。万葉入社前はカスタマーサポートや経理・人事職をしていたが、プログラミングに興味を持ち学習を始めた。その後２０２０年２月万葉へ入社。入社後、研修や様々なプロジェクトでのチーム開発を通してテキストコミュニケーションを学ぶ
  
  島田 浩二(シマダ コウジ)
  １９７８年神奈川県生まれ。電気通信大学電気通信学部情報工学科卒。２００９年に株式会社えにしテックを設立。２０１１年からは一般社団法人日本Ｒｕｂｙの会の理事も務める

伝わるコードレビュー―開発チームの生産性を高める「上手な伝え方」の教科書 の商品スペック