Software Changelog
Docs + Word9 pages
Free
- Type
- Document
- Price
- Free
- Pages
- 6 · US Letter
- Style
- Minimal
- Difficulty
- Beginner
- Updated
- November 6, 2026
Every page (6)
Overview
Integrators open a changelog to answer three questions: what is new, what will break for me, and by when must I act. This template answers them in that order. It opens with the rollout dates, shows the endpoint changes on one diagram, documents the deprecated call with its parameters, and ends with a week-by-week migration plan.
The sample is release v4.12.0 of the Kettleby Digital Orders API, rolled out to 5%, 25% and then 100% of traffic by 12 March 2027. It adds two endpoints, caps order lists at 100 a page, and retires the v3 search call on 12 September 2027. Replace the version, endpoints, dates and owners with your own.
Useful for
- A platform team announcing a new API version to partners with a clear rollout and removal schedule
- A developer relations lead documenting one deprecated endpoint with its replacement call and parameters
- A support team planning migration help for integrators before a v3 endpoint is switched off
What's included
- A release timeline with rollout stages at 5%, 25% and 100%, and what happened at each stage
- An endpoint diagram showing clients, gateway, endpoints, services and data, with new and retired calls tagged
- A deprecation page with the endpoint, parameters table, request example and response label
- A migration schedule of 16 periods with owners and a callout on the safe finish date
- A roadmap from preview to removal with milestones, owners and reminder emails
- A make-it-yours guide page with five steps for replacing the sample details
How to use it
- 1
Click Make a copy in Google Docs, then confirm on the Google page. The copy is saved to your own Google Drive.
- 2
Set the version, the release date and the rollout dates on the first page, and describe each stage in one sentence.
- 3
Replace the endpoint names, tags and notes with your own, and move every breaking change to the top of its page.
- 4
Rewrite the deprecation page for your own endpoint, with its replacement, parameters and removal date six to twelve months out.
- 5
Adjust the migration schedule and owners, delete the guide page, then share or publish the changelog.
What you need
Requirements
- A Google account with access to Google Drive
Works with
- Google Docs
- Microsoft Word (download the .docx)
Questions
How far ahead should I announce a removal?
Six to twelve months is typical for an endpoint integrators rely on. The sample gives six months, adds a warning header three months out and sends reminders at 90, 30 and 7 days.
Where should breaking changes go?
Put them first, name them plainly and give a before-and-after example with the migration step. Never bury them in a long list of small fixes.
Are the company and endpoints real?
No. Kettleby Digital, its Orders API, its people and every date and figure are fictional sample data. Replace them with your own details before you publish.
- #api-changelog
- #release-notes
- #deprecation
- #migration-guide
- #developer-docs
- #google-docs
- #api-platform
Related templates
More Google Docs templatesMore developer workflows templates
Release Notes
Docs + Word7 pages
Free
Enterprise Release Notes
Docs + Word8 pages
Free
