GitHubのDiscussion機能を障害調査メモにしている

2023-11-22  /  GitHub障害対応

最近 GitHub の Discussion 機能を知ってから、チーム内のメモ書きに良さそうで少しずつ使っています。実際に使ってみたところ、障害調査のメモに良いのではと思いました。

コメントをまとめることができるのが良い

障害調査してると色んな対応が必要になるので、その対応ごとに最初のコメントを書いて、作業の経過をそのコメントへの返信の形でぶら下げていきます。

例えば、アプリのログ調査が必要なら、ログ調査についてどんな観点でどこを調べるかとかの対応方針を一つコメントします。ログ見る時は色々見る箇所があって、その結果をそれぞれコメントへの返信としてぶら下げていきます。そうするとログ調査については一つのコメント(スレッド?)としてまとまっていく感じになります。

並行作業はやや追いにくい

ログみる →DB 見る → ログ見るみたいに行ったり来たりすることもあるので、その時は別のコメントを設けます。複数のコメントがあると、時系列的に作業を並べて見るのはちょっと難しくなることもあります。コメントやリプライへのリンクもあるので、その辺で一応行き来はできますが、たどりにくいとは思います。

同時更新のコンフリクトを気にしなくて良い

障害対応時に情報収集の必要があり、報告をしやすくするのも大事だと思います。1 つのドキュメントを更新していくスタイルでは、同時に更新できるか書く時に気をつけなければならないこともあります。Discussion だと、進展があれば報告がてらさっとコメントしてそこから離れることがてきるのも良いと思いました。