作業ログ

作業ログを書くために大切な、たった一つのこと -- [結] 2006年5月 - 結城浩の日記

via. *Backtrace*(2006-05-31)

作業ログを書くための最重要ポイント:自分の頭の中に情報を残さない

なるほど.目から鱗というか,ずれてたものがはまった感じ.そう,確かにコレです.
この3ヶ月ほど.某構築案件に携わっていていろいろサーバ組んだり,ネットワーク設定をいじったりしていて良くわかったことは確かにこのこと.つまり記憶に頼るなということ.さすがにこまでシステマティックにするところまではできていませんが,いつ,どこで(何に対して),何のために,どういう手順で,どういうことをしたか,という記録を,可能な限り詳しく残しておくこと.って結局 5W1H なんだな.あ,あと何につまづいてどう対処したかもいるか.

  • ある人は,サーバに加えた設定(入力したコマンドなども)時系列に順に記録ていた.次回同じ作業をやるときにはこの順にやるだけでよいということになるし,途中でも次にどこから何をやるかを書いておくだけでよい.
  • 別のある人は勘と記憶に頼ってアドホックに設定を作っていた.初期状態からどう変えたのか,何のために変えたのか誰もわからず,どんどんブラックボックス化していく.ブラックボックス化していくとその作業の正当性をレビューできない.作業の受け渡し・引継ぎがまともに進まない上,作業の再現性を保障できない.

作業の再現性.再現性のない作業って結局その場しのぎで自己満足するだけなんだよな.自分は良いかもしれないが,その先に発展しない.作業の再現性もしくは再利用性という意味では,可能な限り作業を自動化させることも重要.シェルスクリプトなんかその最たるものだと思う.……なんか特定分野の作業に偏った話になってしまったか.

ということで専ら私は howm: Hitori Otegaru Wiki Modoki を使って記録を書いています.場合によっては(howmを使えない環境では)テキストでメモを取っておいて、あとで howm に移す.日付管理と検索性をテキストに加えるだけで記録としての利用価値はかなり高くなるし,とりあえずテキストで書いてあるだけでよい(導入障壁の低さ)というのも魅力かな.