Ask HN: How do you document analytic events?

Hi,

I'm a software developer and I've been in different teams where I always found the same problem: how can we document analytic events in a nice way?

Website example: 1. There is a home page with a Sign in button and a Sign up button. 2. There is an event fired when the Sign in button is clicked and it is stored in Mixpanel/Google Analytics/whatever 3. There is an event fired when the Sign up button is clicked and it is stored in Mixpanel/Google Analytics/whatever

Problem 1: Someone (non developer) wants to check how many people clicked on Sign in -> they need to know the event name to be able to check it out (imagine a more complex situation with many events and many interactions)

Solution to problem 1: We create a wiki with a list of all the events and a description on when they are fired

Follow up problem: We need to rename the event OR add/remove properties to the event OR trigger the event from a different place OR delete the event -> a developer goes and updates the code -> they forget to update the wiki -> the documentation is now outdated

General problem: it is hard to keep up to date documentation on analytic events.

I was wondering how do other people handle this? At the moment we are using Typescript if that info is any useful.

Thank you!