アルパカログ

カスタマーサポート (CS) とエンジニアリングを掛け算したい CRE (Customer Reliability Engineer) が気になる技術や思ったことなど。

技術研修で新卒に伝えた3つのこと

それは、

  • 普段から綺麗なコードを書こう
  • メソッドやクラス、カラムは適切に命名しよう
  • ログを残そう

です。どれもエンジニアとしては当たり前に大事なことです。特に上2つはリーダブルコードに書いてあります。

しかし今回は研修なので、どうすれば実感として伝わるかというところが大事でした。

どんな研修だったかはインタビュー記事を見て欲しいのですが、上記を伝えるためにコードを読ませることにしました。

mixil.mixi.co.jp

普段から綺麗なコードを書こう

コードは1度書かれてから何度も読まれます。読まれる回数の方が圧倒的に多いです。

テストはもちろん、普段から綺麗なコードを心がけることで読み手の負荷が断然変わってきます。

メソッドやクラス、カラムは適切に命名しよう

それぞれの責任範囲や内容を適切に表すように命名はよく考えること。

Bool を返すメソッドで英語の意味が逆…なんてことがあると読む人がつらい思いをします。

ログを残そう

DB に Update と Delete を発行するときはログを残しましょう。

元の状態が変わってしまうので、不具合が起きたときログから調査できるようにするためです。

研修裏話

研修の準備がめちゃくちゃ大変でした。コードを読みやすく改変する、ログを用意する、ユーザーデータを用意する、模擬問い合わせを用意する…などなど。

チーム総動員で作ったので、チームメンバーには感謝しかありません。

その甲斐あって「楽しかった」「もっとやりたかった」という声がもらえたので、浮かれてまた来年も研修するかもしれません。