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 into a new file, fill it in before the change runs, and complete Outcome after.

It follows Deevnet IoTaaS’s template, trimmed to what an application needs: no site or maintenance window, because eds-inventory changes one tenant.

Where it goes


Number	The next unused `CHG-NNNN`, in the order records are opened. Runs across years, never reused, and kept even if the change is abandoned.
File	`docs/content/docs/changes/<YYYY>/<NNNN>-<slug>.md`
Title	`CHG-NNNN: <What changed>`, from the point of view of what is running
Date	The day execution starts. While it is still planned, the planned date; with none yet, Unscheduled
Weight	`NNNN`, so records sort by number
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.

Incident Record Template (INC)

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

Incident Record Template (INC)

The shape every incident record takes. Copy the skeleton into docs/content/docs/incidents/<YYYY>/<NNNN>-<slug>.md, numbered with the next unused INC-NNNN, and add a row to the index.

Start the record while the incident is fresh, even with most sections empty. The timeline and the wrong turns are the parts memory loses first.

Status

An incident carries a status and a substatus. The status says whether anything is left to do; the substatus says how far along it is, and only moves forward.

Keeping Records on eds-inventory

Change Record Template (CHG)

Change Record Template (CHG)

Where it goes

Status

Incident Record Template (INC)

Incident Record Template (INC)

Status