How I structure changelogs

Do not index

I’ve recently added public changelogs to my add-ons, and they’ve become a key tool for tracking progress and keeping users informed. Changelogs make it easy to show what’s shipped, address user requests, and ensure no update is missed during release cycles.

Structuring a Changelog

Here’s how I structure them:

Be concise: Keep updates brief and easy to skim. I use phrases like “Added breakout rooms” or “Fixed chat history issue” so users can quickly see what's changed without reading lengthy descriptions.

Organize by version: Each release is in its own section, ordered by date. This makes it easy for users to track changes over time and see the product’s progression.

Add links for more details: For updates that need more explanation, I add links to guides or docs. This keeps the changelog clean while offering more context when needed. For example, “Learn how to enable breakout rooms [here].”

Close the loop: I also reference the changelog update in places like Canny or in forum responses, keeping users who asked for the update in the loop.

Changelogs keep me organized and help users stay informed. If you have your own approach, or want to share ideas, send me a note.

How I structure changelogs

Structuring a Changelog

We build third-party apps and integrations

Let's keep in touch