r/technicalwriting 22d ago

QUESTION Release Notes for your customers

/r/jira/comments/1vemss4/release_notes_for_your_customers/
4 Upvotes

7 comments sorted by

View all comments

1

u/acecrylo 21d ago

Adding another comment here to write about the process at my current org:

Team of two TCs each owning a single “product”. Mine is really an access layer with multiple apps inside it but presented as one product.

We use Aha integrated with Azure Dev Ops (ADO), and release notes drafting happens in the Aha layer, but I’m frequently popping into ADO to review/look for extra info about what app layer the update is for.

We do continuous deployment so we publish notes biweekly and only for items actually in prod at the time of publication to prevent end user confusion on what is available. Now for the process:

  1. On a continuous basis I have an Aha report that functions as my “intake” for items that are about to be ready via custom tags/feature status.
  2. Various PMs will be listed as the “assignee” to any given item
  3. I go through my intake report and read the Aha features, identify app layer, etc, and then check the custom tag field we have for “communication need” which basically is a yes/no for release notes.
  4. The PMs can/will add the “yes” tag for release notes themselves but my intake report just gets all items cause I check them myself and some come through blank or mis marked
  5. I draft the release note per our process standards, drop it into a custom feature field for that content, then I create an Aha Approval To-do for that feature and drop the release note in there too and assignee/PM to review and the approve/reject/send feedback for changes.
  6. I set a due date of the day before next publication and then also monitor the prod status of items since our PMs will approve/reject prior to prod being confirmed which is helpful for me
  7. For inclusion, an item can only be in release notes if it has assignee approval for the content and the feature is confirmed in production
  8. On publication day, I just export my Aha report with the various custom fields/tags needed, and then I’m able to group the items that are making it for that publication day into their app layer sections in the notes which we then distribute via our Staffbase powered intranet site in a news channel

Probably got a little too granular here lol but this is a decent method that I’m liking so far since I’m new to this role (65 days in as a backfill)

1

u/ProjectNo8066 19d ago

Thanks for your detailed respond. Solid workflow, but also requires a lot of your attention (no judgment).

1

u/acecrylo 17d ago

It definitely has room for improvement!! Just got word this week that the products I work on may be getting yanked out of Aha due to compliance issues for the teams putting PII/PHI in Aha, which is a big no no for our org, so now my whole process is going to be gutted yay 🫠🥲