Change Record Template (CHG)

Mon, 01 Jan 0001 00:00:00 +0000

Change Record Template (CHG) #

The shape every change record takes. Copy the skeleton below into a new file, fill it in before the change runs, and complete Outcome after it has run. CHG-0001: Flat Network → VLANs is a worked example of a multi-phase change.

Where it goes #


Number	The next unused `CHG-NNNN`, in the order records are opened. Global across years, never reused, and kept even if the change is abandoned. Check Change Records for the last one.
Single-page change	`content/docs/changes/<YYYY>/<NNNN>-<slug>.md`
Multi-phase change	A folder `content/docs/changes/<YYYY>/<NNNN>-<slug>/`. `_index.md` is the record; numbered phase pages hold the procedure; `undo.md` holds the undo; optionally `troubleshooting.md` holds issues and follow-ups. Add `bookCollapseSection: true` to `_index.md`.
Title	`CHG-NNNN: <What changed>`, from the site’s point of view, e.g. “CHG-0001: Flat Network → VLANs”
Date	The header’s Date row: the day execution starts. While the change is still Planned, use the planned date, and move it if the date moves.
Weight	`NNNN`, so records sort by number, as ADRs do
Index	Add a row to Change Records and to that year’s page

Status #

Planned → In progress → Complete, or Rolled back or Abandoned. A record is never deleted. A change that was abandoned or rolled back is exactly the one worth keeping.

Change Management on Deevnet Infrastructure Platform

Change Record Template (CHG)

Change Record Template (CHG) #

Where it goes #

Status #