← All resources
The toolkit · Resource guide

Keep a Changelog

Structure human-readable release notes for a maintained project.

Visit website (opens in a new tab)
Understand the tool

Overview

Structure human-readable release notes for a maintained project.

Keep this reference available while working, and test the guidance against the actual requirements of your project.

Best for

  • Working with change categories.
  • Exploring release organization.
  • Comparing version links with your project requirements.

Key features

  • Change categories
  • Release organization
  • Version links
A practical walkthrough

Getting started

  1. Find the relevant topic. Use the official reference to locate the concept you are working on.

  2. Read the context. Review definitions, examples and any version or compatibility notes.

  3. Apply and verify. Adapt the guidance to your project and test the result.

Things to know

  • Reference material can describe behavior your target environment does not yet support.
  • Examples need project-specific adaptation.
  • Check the publication context when comparing older tutorials.

Useful alongside this

Accessibility

Text

Visual

Orientation

Accessibility settings