木曜日, 5月 1, 2025
ホームプログラミング【書評】もっといいコメントの書き方がわかる!『伝わるコードレビュー 開発チームの生産性を高める「上手な伝え方」の教科書』 - give IT a try

【書評】もっといいコメントの書き方がわかる!『伝わるコードレビュー 開発チームの生産性を高める「上手な伝え方」の教科書』 – give IT a try


はじめに

翔泳社さんより、『伝わるコードレビュー 開発チームの生産性を高める「上手な伝え方」の教科書』をご恵贈いただきました。

実はこの本は発売前から気になっていて、Amazonですでに予約購入していました。
ところが今回、翔泳社さんから本書を贈ってもらえることができたので、僕としては願ったり叶ったりでした😄
翔泳社さん、どうもありがとうございます!

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

どんな本なのか?

ひとことで言うと、プルリク上でITエンジニア同士が交わすテキストコミュニケーションに関する本です。

「こういうコメントはGOOD」「こういうコメントはBAD(なのでこう改善しましょう)」といったコードレビュー上のポイントが、豊富な具体例とともに説明されています。

どんな人におすすめか?

これはズバリ、実務に入ったばかりの新人エンジニアさんですね!
コードレビューをする側(レビュアー)よりも、される側(レビュイー)に回ることが多いITエンジニアのみなさんにおすすめです。

「コードレビューって何?」「レビューコメントが付いたけど、どう対処すればいいの??」と右往左往している新人エンジニアさんは、本書を読むことでコードレビューに対する向き合い方や心の準備ができるようになると思います。

一方、本書はレビュイーだけでなく、レビュアーにもお勧めです。
なぜなら「こういうコメントは書いちゃダメ」という、レビュアー向けのNG例とその改善策もたくさん載っているからです。

最近レビューする側にも回るようになった人は、本書を読むことで「そういえばあのコメントはわかりにくかったかも」とか「ああいう書き方をすると、相手を萎縮させちゃったかもしれないなあ」といった反省点が見つかったりするんじゃないかなーと思います。

僕の感想:あるあるパターンの連続!開発チーム全員で読んでおくと良さそう

僕が本書に別名を付けるなら「コードレビューあるある大全」と名付けたいです。

というのも、本書を読む進めていくと、「あるある!」「あー、これもよくある!」と、次から次に過去に自分も遭遇したことのあるコードレビューコメントの例が登場したからです。
「よくこんなにあるある事例を集めてきたな〜」と感心するほどです。

こういったNGパターンは、おそらくどの現場でもよく見かける光景なんでしょうね。
ですので、きっとこのブログを読んでいるあなたの現場でも絶対に役立つ情報が載っているはずです。

コードレビューを必須にしている現場で働いているみなさんは、開発メンバー全員で本書を読むといいと思います。
とくに、輪読会形式で読んでいくと「これはうちでもよくあるよね」とか「今度からみんなでこの点に気を付けよう!」といった具合に、参加者同士で話が盛り上がりそうな予感がします 😄

その他、思ったことなど

かわいいイラストが多くて読みやすい

「本を読むのが苦手」「文字ばっかり読むのはしんどい」、と考えている人も大丈夫!
かわいいイラストがたくさん載っていて、普段本をあまり読まない人もすっと理解できるような構成になっています。

コード例はRubyが多め(でも誰でも読める)

執筆者がRuby界隈の方たちなので、コード例はRubyやRailsを想定したものが多かったです。
とはいえ、コードが主役の本ではないので、Rubyプログラマ以外の人が読んでもまったく問題ありません。

テクニカルな話は少なめ

本書を読む前は「コードレビュー全般に関する本」だと思っていましたが、実際に読んでみると「コードレビューにおけるテキストコミュニケーションに特化した本」だとわかりました。
なので「コードレビューするときは、こういう観点でコードをチェックしよう」というようなテクニカルな話は本書には出てきません。
個人的にはそういう話も読みたかった、というか、僕が書きたいな!!

一方、ソニックガーデンのコードレビューでは……

ちなみに弊社ソニックガーデンではこんなに丁寧ではなく、もっと殺伐としたやりとりが交わされています(苦笑)。

というと、「めっちゃ怖い」と思われるかもしれませんが、これはレビュアーもレビュイーもどちらも優れたプログラマで、なおかつお互いを技術者としてリスペクトしあえているからです。
加えて、普段からよくZoom等で話していて、お互いの人となりがよくわかっているから、という側面もあります。

つまり、互いに気を遣わなくてもよい関係性を構築できているので、コードレビューのコメント自体はシンプルで素っ気ないものになることが多いです。

たとえば、こんな感じですね。

素っ気ないコメントでもお互いに気分を害さないのであれば、コードレビューにかける時間も短くて済むので効率的です。

まとめ

というわけで、今回は『伝わるコードレビュー 開発チームの生産性を高める「上手な伝え方」の教科書』の感想を書いてみました。

コードレビューコメントに特化した本というのは、おそらく今までなかったと思います。
今までなかったけど、コードレビューの文化は日本のIT業界にかなり浸透してきているはずです。
ですので、「コードレビューやってます」という現場で働いているITエンジニアは全員必読の一冊、と言っても過言ではないかもしれません。

若手ITエンジニアのみなさんはもちろん、ベテランエンジニアのみなさんもプルリク上のテキストコミュニケーションを見直すために、本書を一度手に取ってみることをお勧めします!

伝わるコードレビュー 開発チームの生産性を高める「上手な伝え方」の教科書
あわせて読みたい

これに関連して、良いコミットや良いプルリクエストに関する議論を僕も以前、レバテックラボさんのサイトに寄稿しました。
「伝わるコードレビュー」とあわせて、こちらもぜひチェックしてみてください。

levtech.jp

levtech.jp

なお、個人的なコードレビューの極意は「自分のことを棚に上げる」ですw

qiita.com



フラッグシティパートナーズ海外不動産投資セミナー 【DMM FX】入金

Source link

Views: 0

RELATED ARTICLES

返事を書く

あなたのコメントを入力してください。
ここにあなたの名前を入力してください

- Advertisment -

Most Popular

Recent Comments