Release Notes Overview¶

Public release notes describe customer-visible change, operational impact, and compatibility considerations. Internal work logs, benchmark runs, and temporary investigation notes are not release-note content.

Public Release Note Principles¶

describe customer-visible change only
include operationally relevant behavior change
include upgrade or compatibility implications when needed
link to supporting public documentation when applicable

Structure¶

Each release note should typically include:

version
release date
key changes
operational notes
compatibility notes

Source Boundary¶

Module release history and internal work records can inform public release notes, but public release notes should publish only validated customer-facing information.