コードレビューだけの仕事をしたという夢を見た

おはようございます。

皆さんの組織ではレビュー文化がありますか?

レビューとはソースコードだけに対する活動ではなく、企画や仕様書、設計、実装、成果物、テスト、運用など様々な工程において役立つものです。

あまり風呂敷を広げすぎると記事が完成しなくなってしまうので、今日は例えば、特定の言語環境にそこそこの知見を持っていたとして、それを活用しているプロダクトの実装面でのコードレビューだけを仕事として請け負った夢を見たという記事を書きます。

なぜコードレビューが仕事になるのか?

少なくとも発注者は、コードレビュー活動を行い、日々リファクタリングしていく事がサービスやプロダクトの欠陥を減らし、生産性や品質を上げる事だと理解している事が伺えます。

他にも、現場で設計をしたり、コードを書いたりする実装者は新しい言語環境での開発を進める上で、アンチパターンを踏んでいないか?などの相談が気軽にできる事を求めているとも考えられます。


レビュワーの出せる価値とはなんでしょうか?

さて、レビュワーとして仕事をする場合、とある心配事が出てきます。プロダクトを実装する事は許されないのです。実装させてもらえるなら、時間の許す限り価値を出せるかもしれません。

しかし、私は既に実装されたコードを読み、自身の経験や知識を使って、こうするのがいいのではないか?と指南するしかないのです。

何故、レビュワーを外注したのか?レビュー活動において求められている価値や恩恵はなんなのか?その辺りを思考できると良さそうですね。

コードレビューの先には生産性の向上や欠陥の排除以外にも、様々な副産物や恩恵があります。

レビュー事項が組織のノウハウとして蓄積されれば、属人化のないレビュー文化の形成に繋がり、強いプロダクトの構築を継続していけるはずです。

レビューを受け、指摘されたり称賛されたりしたエンジニアは、得た経験や知識でプロダクトに貢献するでしょう。そして、今後の人生においてもその経験を活かしてさらに成長していくはずです。


レビュワーのガイドライン

ひとまず、レビュワーとして活動するために、自分向けのガイドラインを作ってみました。続きの夢が見られたら、随時アップデートしていこうと思います。


・発注者の想定しているスコープを正しく守る

実装にはビジネス背景や企画、設計があります。そこに対してあるべきを述べるのには時期焦燥かもしれません。

スコープをはみ出す事が悪いことではないです。基本はスコープにフォーカスし、範囲外であっても助言ができる事は価値に繋がるでしょう。


・コミュニケーションを意識する

お前のコードはダメだ。こうしろ。と言われて辛くならない人は多くないでしょう。その実装がされた背景には様々な理由があるはずです。

無駄のないコミュニケーションとか結論だけとか削り落とされたコミュニケーションはコスト感を下げますが、場合によっては弊害を起こします。

1. 相手のスキルレベルはどのくらいか?

2. 指摘対象の実装者=レビュイーなのか?

3. 言葉遣いは厳しい口調になっていないか?

など考慮できると良さそうです。(コミュニケーションには絵文字を使うのもいいかも)


・読みやすい文章を書こう

美しく整形された文章は読み手のハードル感を下げます。逆に不規則なインデントや装飾のないテキストは、たとえ読まれたとしても、読み手の理解度を下げたり、時間を奪ってしまうと考えます。

マークアップ言語が使えるなら、惜しみなく使い美しく整形するようにしましょう。


・解決策を添えよう

解決策が明確であればその後のアクションに繋がります。指摘に対してゼロから解決策を調べたり、考えたりするよりも、いくつかの案や方向性が示されていれば、次にやらなくてはいけない事が明確になるはずです。

解決策は明確であり、情報量をしっかり調整しましょう。図鑑のような分厚いドキュメントを渡されてもそれは解決策とは呼べません。


・時には褒めよう

レビュワーは指摘をするだけが仕事ではありません。レビュイーの学習面での進捗を意識して、良いコードには相応のコメントをしましょう。

必要に応じて、称賛された根拠など添えるとさらに良いかもしれません。


・わからない事について無理に背伸びをしない

レビュワーと言えど経験や知識に限界もあります。わからない事や浅い方面で問われた時、経験不足を明確に伝えた上で調べたり勉強したりした情報を伝えましょう。


--------------------------------------------------------------

記事は以上です。

まあ、これは夢なので実際にやってみたら考えは変わるかもね。



この記事が気に入ったら、サポートをしてみませんか?気軽にクリエイターを支援できます。

😘
7
goを書く仕事をしています お仕事のご依頼はDMにて https://labo.yukpiz.me/
コメントを投稿するには、 ログイン または 会員登録 をする必要があります。