Vera Logo

Writing changelogs

Overview

When we ship a feature, we share it with customers through our weekly changelog. This helps users discover new functionality and shows that Vera is constantly improving.

Where we publish:

  • Email (via Hubspot)
  • Website (via Payload CMS)
  • In-app (coming soon)
  • LinkedIn/Socials (future)

Creating our weekly changelog

  1. Write a list of bullet points of the things you want to say.
  2. Set up your platform to show the demo. Use the guide here: Creating video content (if possible — best done than perfect).
  3. Record the video. Don't aim for one single non-edited clip. Stop and resume when needed, and edit later on Loom.
  4. Go to Hubspot and duplicate this changelog template. Give it a name: Changelog - 25 WEEKNUMBER
  5. Edit the content to make sure it reflects your update.
  6. Consider updating the Pricing page on our website to include the new feature or any pricing changes.
  7. Set the subject as the title of the video.
  8. Send from team@getvera.ai
  9. Send to the Weekly Changelog list, excluding those that have hard-bounced.
Note:

See this Loom walkthrough for a full demo of the process.

Email structure

Follow this structure for consistency:

  1. Headline — Feature name as a benefit (e.g., "Custom AI Agents: Tailor Vera to Every Use Case")
  2. Opening paragraph — What the feature does and why it matters
  3. Image/GIF — Show the feature in action
  4. Key capabilities — Bullet points of what users can do
  5. Expert tip — A practical suggestion for getting the most out of it
  6. Link to docs — Point to the relevant help article
  7. Where to use it — Explain where the feature appears in Vera
  8. Closing CTA — Invite users to try it and link to the app

Example

See Example Changelog (PDF) for a sample.

Writing guidelines

Be customer-focused. Write about benefits, not implementation details. Avoid technical jargon.

Good example

"You can now export your compliance reports as PDFs, making it easier to share with auditors and stakeholders."

Bad example

"Added PDF export functionality using the jsPDF library with custom styling support."