４年運用している行動ログのドキュメンテーションの工夫 - コネヒト開発者ブログ

コネヒトアドベントカレンダー2024 1日目の記事です。 この記事では、コネヒトで4年間運用している行動ログのドキュメント化について紹介します。 行動ログの概要 コネヒトでは、Webサービスやモバイルアプリの開発をしています。その中で、ユーザーがどんな操作をしたのか（例えば、画面を開いたり、ボタンをタップしたり）を「行動ログ」として記録しています。このデータを分析して、サービス改善に役立てています。 しかし、次のような課題がありました。 行動ログがどのバージョンから実装されているのか分からない。 イベントがどのタイミングで発火するのか明確でない。 情報がまとまっていないため、ソースコードを確認しなければならない。 これらの課題を解決するために、2020年に行動ログのドキュメント整備を始めました。 ドキュメント作成の取り組み 選んだアプローチ ドキュメントは、理想的にはコードから自動生成され