今回のテーマはログである。ログと言ってもサーバやアプリケーションのログのことではない。今回取り上げるのは作業ログである。作業ログと言えば,
作業ログを取る目的はさまざまだ。ライフログ,
難しいタスク
仕事で,
状況の難しさをまとめてみよう。
- 大量のドキュメント
- 動くコードがないので試行錯誤が必要
- 作業が数日以上にまたがりそう
- 質問や相談できる人があまりいない
このようなタスクには作業ログがぴったりでお勧めである。以下,
大量のドキュメントとログ
よくあるドキュメントのパターンは,
筆者の失敗パターンは,
大量のドキュメントの問題点は,
[a] 読み逃しへの不安[b] あとで必要なものを見つけられない不安
の2つである。
こういう状況では,
リスト1 ドキュメントの作業ログ
- __done__ [API document](...)を読んで1行にまとめる
- __done__ [BについてのDesign document](...) 再読必要なし
- __important__ [configの方法](...) あとでここのセキュリティ項目を見る
- [deploy document](...)
- __here__ [OAuthについて](...)
- [DIについて](...)
なお,
ログは公開すべきか
機密情報が含まれないのであれば,