Changelog
A single page with recent changes all included, or a high-level changelog table that links out to all the release sections.
Required
Naming conventions
This section is sometimes called Release notes, but in the API context, Changelog (one word) is the most common title.
If you want to use the Release notes title, you need to check with the customer if the API development is release-based.
Two approaches are possible:
- A long page with the list of changes in plain text
- A table with the list of changes
In both cases, you need to provide the following information:
- Identifier for the change (date or version number)
- Headline summary of the changes
- Description of the new features
Optionally, you can also list the benefits from the new features.
Tip
If you need to add links to more specific change descriptions, a table layout is recommended.
If you need to add links to more specific change descriptions, a table layout is recommended.
Examples
- stripe.com/docs/changelog
All changes on one page. - developers.facebook.com/docs/graph-api/changelog
A table that links to the released versions.
Screenshots
Stripe
Yggdrasil
Source / input
- The API development team and their internal documentation
Older changes
OptionalYou can divide the changelog, and create, for example, a page for each year. Include this section if the one-page changelog section becomes hard to navigate or slow to load.