Search results

Podcast: Using file diffs for better release notes in reference docs

by Tom Johnson on Jul 28, 2024
categories: ai • podcasts

You can use AI prompts when creating release notes for APIs by leveraging file diffs from regenerated reference documentation. The file diffs from version control tools provide a reliable, precise information source about what's changed in the release.

Listen here:

For a written version of this video tutorial, see Using file diffs for better release notes in reference docs.

To watch more of the Keren Brown Zoomin podcast, see Uncovering and communicating the value of your tech comm teams’ work.

Sponsored

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.

© 2026 Tom Johnson