エンジニア立ち居振舞い: 明日いなくなってもいいように仕事をする
このエントリは Classi Advent Calendar 2016 11日目の記事です。
先月話題になっていた 「エンジニア立ち居振舞い」について、自分が普段心がけていることを書こうと思います。
それは「 自分が明日いなくなってもいいように仕事をする 」ということです。
明日突然、病気で倒れてしまうかもしれない。
明日突然、事故に巻き込まれてしまうかもしれない。
人生何が起こるか分かりません。
でももちろん、自分がいなくなった後もサービス(会社)は続きます。
そうなった時に「自分しか知らない情報」や「自分しか理解できないコード」があると、誰も引き継げなくなってしまいます。
こんな悲しい自体を防ぐために「 自分が明日いなくなってもいいように 」というのを常に意識しながら仕事をしています。
- 明日いなくなってもいいように、テストを書く
テストを書くのはもちろんですが、書いた後に「 あとから他の人が見た時に分かりやすいか 」を意識しながら見直すようにしています。
必要に応じてコメントを残したり、テストの書き方をWikiに残したり。 「他の人」には未来の自分も含まれるので、未来の自分を救うためにもテストを書いておくと安心です。
- 明日いなくなってもいいように、ドキュメントを残す
「プロジェクトが落ち着いたらドキュメントを書こう」だと抜け漏れがあったり、その頃には忘れてしまっていたりするので、何か決まったらすぐドキュメントに残すようにしています。
また、API仕様書に関しては定期的に変更されることもあり人間が手動で追従するのは難しいため、テストを書くとAPI仕様書を自動生成するようにしています。(autodocに感謝です)
- 明日いなくなってもいいように、積極的にコミュニケーションを取る
「他の人でも分かりやすいか」というのは自分だけで考えていても限界があるので、「ここ分かりづらいかな?」と感じる部分があればチームメンバーに都度確認して議論するようにしています。
良い議論をするためにも チームでコードレビューを習慣化 しておくのが大事ですね。
また、エンジニア同士のコミュニケーションだけでなく企画の人たちとのコミュニケーションも積極的に取るようにしています。
「こういう仕様にしたい」というのを相談された時に「なぜそれが必要なのか?」というのを議論していくと、よりシンプルな方法で課題を解決できることもあります。
こんな感じで、「 自分が明日いなくなってもいいように 」というのを常に意識しながら仕事をしています。
書き出してみると当たり前のことしか書いてないのですが、実践し続けるのはなかなか大変で、日々「もっと良くできそう」というのを悩みながらコツコツやっています。
これはとにかく実践していくしかないので、チームを巻き込みながらこれからも地道にがんばっていきます。
以上、私の「エンジニア立ち居振舞い」でした。
Classiでは引き続き日本の教育を変えていくエンジニアを募集中ですので、興味を持たれた方はぜひ話を聞きにきてください!