常に作業ログを取る

セットアップ作業、コーディング中、バグ修正時。どんな時も、作業ログを取っておく。

ログを取るべき理由

• 何か問題があってやり直ししたい時に、正確に元に戻せるようにするため
  • ログを取っておかないと、正確に戻せていないポイントが出てきて、その差分に気付かず原因調査に手間取る
• 試行錯誤した過程、思考過程を記録しておくことで、自分なりの問題解決のアプローチが見付けられる
  • 「自分で問題を突き止めようとして時間を食ったが、エラーメッセージでググれば一瞬で解決した」→「まずはメッセージでググろう」といった、自分の作業における課題と対策が分かるようになる
• 作業ログが他人に同様の作業を依頼する時の簡易マニュアルになり、コミュニケーションコスト、育成コスト削減に繋がる
  • 他人が読んでも分かるように書いてあることが前提。かつ、相手に鵜呑みにしないでもらう注意も必要 (とはいえ結局鵜呑みにされるので、その点については別途説明する…)
  • たいそうなマニュアルでなくても、参考程度に情報共有できるようになる
  • 再現性の高い情報が有益な情報となる。「誰かがこの作業ログを見て同じように作業できるだろうか」という目線で書く
• 上司や周りの人が「コイツ何やってるの」を把握しやすい。レビューしやすい
  • 自分の作業報告をまともにできない人は案外多く、管理職からすると扱いづらい
  • 例えば、何らかのデータを整形する作業であれば、その整形過程をシート別に残しておいたりすることで、上長がレビュー時に検算しやすくなる。コレも再現性の一つ

ログの残し方

• 当日日付のテキストファイルを1つ作成し、全てそこに記録する
  • 参考 : 一元化する二重管理を避ける
• 参考にした文献の情報を正確に書く
  • 書籍名、ページ、該当部分の引用
  • 記事タイトル、URL、該当部分の引用
• 引用に対し、自分なりの理解と要約を書いておく
  • 文献は合っているけど自分の解釈が誤っていた、といったことが後で探しやすい
• 操作したファイルのフルパス、変更前後のテキストなどを書いておく
• インストーラファイルなど、ダウンロードして利用したモノは、後にそのファイルがダウンロードできなくなる場合があるので、作業ログと合わせて保存しておく
  • 自分は YYYYMMDD.md という作業ログファイルと同じ階層に _YYYYMMDD/ というディレクトリを作り、この配下にファイルを置くようにしている
• 使用しているツールのバージョンや、動作環境などは正確に残す
  • OS のバージョン、ツールはマイナーバージョンなども意識して残す
  • バージョン違いで使えない情報や、再現しない問題などもある
• エラーメッセージ、表示結果、実行コマンドなどをコピペして残しておく
• 後で間違いや不要だと分かった情報も、消さずに残しておく
  • 間違っていた作業も、作業記録
  • 不要だった旨、間違いと正しい情報は「追記」する