Changelog

Verification Required

Changelog And Release Notes.

Release-bound documentation needs clear changelog entries, release-note records, docs-impact summaries, claim-status changes, and reviewer decisions before publication.

Release Snapshot

Checklist areas: 4
Entry types: 5
Entry fields: 5
Story: DOCS-089

Checklist Areas

Changelog

Release owner and docs owner

What user-visible behavior, route, workflow, or claim changed in this release?

Evidence

Changelog summary, affected routes, release note, product PR, build, tag, or no-changelog rationale.

Limitations

Product SME and docs lead

Did any unsupported behavior, maturity boundary, compatibility row, or product limits page change?

Evidence

Updated limits page, compatibility row, reviewer signoff, or no-limitation-change rationale.

References

Docs QA and product SME

Do API, CLI, configuration, SDK, error, or limit references still match the released behavior?

Evidence

Source-backed reference diff, generated output, command evidence, or no-reference-change rationale.

Migration Notes

Product SME, support, and operations reviewers

Does an existing user need to change configuration, commands, data shape, support handoff, or operating practice?

Evidence

Migration note, compatibility note, rollback note, support path, or no-migration-impact rationale.

Release-note Entry Types

Changelog and release-note entry types
Type	Use When	Required Record
Public beta milestone	Product availability, launch date, route readiness, or preview promotion changes.	Product scope, public date, affected routes, product owner, and evidence source.
Docs impact	A release changes a workflow, command, example, reference, support path, or operating practice.	Reader action, changed surface, route list, release owner, and no-action rationale when applicable.
Compatibility or limits change	A supported, partial, unsupported, preview, future, or verification-required row changes.	Compatibility row, known-limit link, evidence, and product SME acceptance.
Maturity or claim-status change	A page, claim, route, feature, evidence row, or reviewer disposition moves to a new label.	Previous label, new label, claim wording, reviewer signoff, and what the evidence excludes.
Correction or clarification	Published docs need a factual correction, safer wording, broken-link fix, or missing-limit note.	Original issue, corrected route, evidence or reviewer rationale, and reader impact.

Release-note Entry Contract

Required fields for release-note entries
Field	Why It Is Required	Reviewer
Docs Impact	Names what readers need to do, understand, retest, or ignore because of the change.	Release owner and docs owner
Claim-status Changes	Records added, removed, narrowed, promoted, or deferred claims and maturity-label moves.	Product SME plus sensitive reviewer when needed
Affected Routes	Keeps the changelog tied to public pages instead of private source paths.	Docs QA reviewer
Evidence	Links the entry to source, generated reference, fixture, test, release artifact, or owner signoff.	Product SME or docs QA reviewer
Publication Decision	Records whether the entry is approved, deferred with owner, published, or blocked.	Docs lead and release owner

Release-note Lifecycle

Draft

Release owner

Release owner or docs owner identifies entry type, affected routes, and product scope.

Reviewer Ready

Docs owner

Docs impact, claim-status changes, evidence, and affected routes are complete.

Approved For Publication

Docs lead

Required product, docs, QA, support, operations, security, privacy, or legal reviewers accept the entry.

Published

Docs owner

The entry is visible on the changelog route, product release notes, or approved release communication.

Deferred With Owner

Release owner

The release can proceed, but the missing entry or follow-up has an owner, target date, and accepted risk.

Release Decision

Release documentation decision states
State	Meaning	Required Record
Publish With Release	Required release docs coverage is complete for the release scope.	Checklist owner, reviewers, validation evidence, and affected routes.
Defer With Owner	Missing docs are not release-blocking and have an accountable follow-up.	Owner, target date, reason, and follow-up work item.
Blocker	The release should wait for missing changelog, limitations, references, migration notes, evidence, or review signoff.	Blocking area, required reviewer, current risk, and next action.

Product Routing

Product release docs routing
Product	Owner	References	Limits
ObjectDB	`objectdb-product-sme`	/products/objectdb/reference/	/products/objectdb/limits/
Message Broker	`message-broker-product-sme`	/products/message-broker/reference/	/products/message-broker/limits/
Concordia	`concordia-product-sme`	/products/concordia/reference/	/products/concordia/limits/
LogDB	`logdb-product-sme`	/products/logdb/reference/	/products/logdb/limits/

Validation Command

Shell

Release docs validation command

Run from the Gatsby app directory to validate the release docs checklist and release-note framework artifacts.

cd docs.stornamics.com
npm run validate:release-docs

Text

Expected Output

Expected summary when the checklist, release notes framework, templates, PR template, and route remain aligned.

Release docs validation passed for checklist, release notes framework, templates, PR template, and changelog page.

Review Artifacts

Standard
Release docs standards
Define release decision states, checklist areas, release-note entry types, docs-impact fields, and claim-status changes.
Template
Release review record
Copyable release review record for product release owners and docs owners.
Template
Release-note entry
Copyable release-note entry record for public summaries, affected routes, docs impact, claim-status changes, and evidence.
PR Template
Documentation change review
Optional Azure PR template for release-bound documentation changes.