読者です 読者をやめる 読者になる 読者になる

$shibayu36->blog;

株式会社はてなでエンジニアをしています。プログラミングや読書のことなどについて書いています。

いつ突然会社をやめても問題ないという基準でコードやドキュメントを書くテクニック

blog.shibayu36.org

 上の記事が思ったより読まれていたので、自分がこの基準を満たせるようにやっているテクニックも箇条書きで書いておく。

  • PullRequestを作ったら必ず自分でコードレビューをする
    • コードを書いているとき、その一部一部はこれで完璧と思ってるけど、実は全体を見直すと分かりにくかったりする
  • 1日寝てから見直す
    • 1日経つとちょっと忘れて新鮮な気持ちで見れる
  • 1週間後にもう一回見てみる
    • 1週間くらい経つともうだいぶ忘れて、穴が見えてくる
    • 穴があったら別PullRequestで直す
  • もう一度同じところを担当することがあればチャンス。自分でもこれどういうことだっけってググり始めたら基準を満たせていない
  • 自分が全く関わっていない部分のところを触りだしたらかなりチャンス。本当にまっさらな頭で基準を満たすか見れる。他人がやったことだからとか思わずにちゃんとその時に直す
  • やったことを全てブログに書いたりや発表したりして、外部にも見せてみて反応を見る
    • 一概には言えないが、反応が悪いなら基準を満たせていない可能性が高い
  • もうわかりにくいところはブラックボックス化できるようにライブラリ化する

 まあ他にもいろいろありそう。ライブラリ作るとかは少しハードルが高いものはあるけど、必ず自分でコードレビューするとか1日置いてみるとかはすぐにできることなのでやってみると良さそう。また何回も何回も見なおして直してを繰り返すと、徐々に徐々にではあるけど少しずつコードやドキュメントを書く能力が伸びてくるので、とにかく続けていくしかないと思う。