作業ログを残す意味

ウォンテッドリーには作業ログ(操作した Web ページのスクショ、実行したコマンド、コマンドの実行ログ、etc)を Issue や Pull Request のコメント、Slack のチャンネルに残すという習慣があります。

作業ログを残すメリット

  • 作業内容(操作、コマンド)を記録しておくことで、あとから他の人が手順を真似できる

    • ドキュメンテーションとはまた違ったところで知識の継承を行える

    • ドキュメンテーションのきっかけとかにもなるかもしれない

  • 特定の操作をしたという証跡が残る

    • 何かしら作業ミスをしたとき原因調査がしやすくなる

      • 人の記憶は信用できない

      • 記録された事実をベースに調査を行うことでより迅速に調査を進められる

  • 人の解釈を挟まない事実を記録しておくことで多人数での視点(解釈)が得られてあわよくば効率的に問題を解決できる

    • 1つの事実から生まれる解釈は人それぞれ

    • 何かしらのトラブルシューティングに悩んでも作業ログを他の人に見てもらったら一瞬で解決したみたいな経験は誰しもあるはず

話を聞きに行きたい

最終更新