Documentation people will actually use.
WHAT TO PRODUCE
A description of the task, written for whoever performs it.
WHAT IT SHOULD CONTAIN
What the task achieves When it applies What is needed before starting The steps, in order What the result should look like What can go wrong, and what to do Who to ask
WHAT MAKES IT USABLE
Short Specific Written in plain language Accessible where the work happens Illustrated, where that helps
WHY ILLUSTRATIONS
Photographs of the actual equipment and correct result remove ambiguity.
WHAT MAKES IT USELESS
Length Abstraction Stored where nobody looks Describing what should happen rather than what does
WHO SHOULD WRITE IT
The person who does the work.
WHY
They know the reality, including the parts nobody else sees.
WHAT TO DO AFTER WRITING
Have someone else follow it without help.
WHAT THAT REVEALS
Every assumption and missing step.
WHAT TO ADD
Whatever they had to ask about.
WHAT TO KEEP CURRENT
The materials, whenever the work changes.
WHY
Out-of-date instructions are worse than none.
WHAT TO ESTABLISH
Who owns each document and reviews it.
WHAT TO AVOID
Producing materials nobody uses.
HOW TO TELL
Ask whether anyone has opened them.
