はてなでコードを書くときに気をつけていること

しばゆう先生からバトンが回ってきたので書かせて戴きます。

これまでのあらすじ

整理しておきました。

Hatena-Advent-Calendar
|--...
|--...
|--...
|--id:marqs    (12/16)
|--id:motemen  (12/17)
`--id:nanto_vi (12/18)
    |   |
    |   Hatena-Advent-Calendar
    |   |--id:nanto_vi (12/18)
    |   |--id:cauchym  (12/19)
    |   |--...
    |   |--...
    |   `--...
    |
    `--はてなでコードを書くときに気をつけていること
        |--id:nanto_vi
        |--id:hitode909  (事故)
        |--id:shiba_yu36 (巻込)
        `--id:r7kamura   (玉突) <= New!!

日報を書くこと

本題です。1ヶ月ほど前からはてなブログのチームに加わって開発しています。大学に通いながらアルバイトをしているという具合なので、週に3日程度しか来ることができません。そのため、自分のやり残した半端な仕事を社員の方に引き継いでもらうということもしばしばあります。そういうときのためにも、これまでの仕事の系譜を残すという意味で日報を書いています。2011年3月2日にアルバイトとして入ってから出社日は毎日書いています。明日爆発しても安心ですね。

日報ははてなグループに書いています。はてなグループは非常にシンプルな仕組みで使いやすくて、友達と2人くらいで小規模な開発を行うときにも利用しています。巷ではRedmineとかPivotal Trackerとかで管理するのが流行ってるようですが、2人で適当に作り始めるとかだと下手に色々統合するよりシンプルに管理する方が楽です。

日報を書いておくと、引き継ぐ人や評価する人の負担軽減にも少しは貢献できるような気がしてますが、本当のところは自分のために書いています。週に3日程度しかこれないということは、月火と作業したあと金曜まで作業を中断するなどということにもなるので、何をやっていたか完全に忘れてしまいますよね。そう言うときに前回や前々回の日報を見ると大体思い出せます。便利ですね。

日報って何を書けばいいのか大体指定されないので、何書いてもいいと思うんですが、最近は大体次のようなことを書いています。このへんは見てもらう人にフィードバックもらってないので良いのか悪いのかはまだ分かりませんが、自分が思い出すのには十分な感じです。仕様とサマリーを書くのは大事そうな気がしてます。比較的エンジニアの割合が多いのでこんな感じにしてますが、そうでない場合はこの限りではないでしょう。

  • サマリー
  • やったこと1
    • 仕様
    • 作業場所(gitのブランチ)
    • 差分(git diff --statとか書いてる)
    • TODO
  • やったこと2
  • やったこと3
  • 雑感
  • 来週の出社予定日(週最後の出社日のとき)

更に1日の業務の中でも、お昼ごはんを食べた後に社員とのマリカーに全神経を集中させると、何をやっていたか完全に忘れてしまいますよね。そう言うときにも、リアルタイムで日報を更新していると大体思い出せます。便利ですね。これなら短期記憶がこわれてても仕事できます。あと仕様を先に書くことにしとくと有用です。簡単そうな場合はここでテスト書き始めると美談になりますね。但し、奇抜な新機能とかUIを考えるときは先に仕様やテストを文書化すると良くないと思ってます、気を付けましょう。

以上、はてなでコードを書くときに気を付けていることでした。
皆さんも日報を書いて快適な業務ライフを過ごしましょう。

次は id:yuku_t さんです。ご期待ください。