Recording how things work.
WHAT TO DOCUMENT
What systems exist and what each does How they connect Where things are hosted How to deploy How to restore Who to contact for what Every credential's location, not its value
WHY
Because in an incident, nobody remembers, and the person who knows may be unavailable.
WHAT FORMAT
Short, and where people will find it.
WHAT TO KEEP WITH THE CODE
Anything specific to that project.
WHAT TO KEEP SEPARATELY
Anything needed when systems are unavailable.
Printed, and stored independently.
WHAT TO INCLUDE IN A PROJECT README
What it is How to set it up from nothing How to run it How to deploy it How to run the tests
WHAT TO TEST
Whether someone else can follow it.
HOW
Have them try, while you stay quiet.
WHAT THAT REVEALS
Every step you did not write down.
WHAT TO UPDATE
Documentation, with every change that affects it.
