Internal knowledge base
Why writing for the person who will do this next means writing for someone who knows less than you, why the reason matters more than the steps, and why this decays when a person leaves rather than when a fact changes.
The operational shape
- Trigger
- A process that currently exists only in one person's head
- Reads
- How things actually work. Voice, minimally.
- Cadence
- Per process, reviewed when the process or its owner changes
- Gate
- Notify after, accuracy-checked
An internal document is written for the person who will do this next, and that person knows less than you do. Most internal documentation is written for peers — it assumes the context the writer has, which is exactly the context the next person is missing, and that gap is usually the part that mattered.
The second failure is steps without reasons. A procedure that says what to do but not why cannot be adapted when the situation differs slightly, and it always differs slightly.
The operational shape
Trigger. A process that currently exists only in one person's head. The trigger is usually somebody asking how to do something for the second time.
Reads. How things actually work. Voice, minimally.
Cadence. Per process, reviewed when the process changes or when its owner does.
Gate. Notify after, accuracy-checked.
What good looks like
The reason comes before the steps. What this is for and when it applies. Someone who understands the reason can handle the case the document did not anticipate, and someone following steps blindly cannot.
It names an owner. A document without one is a document nobody is wrong for letting rot, and ownership is the only mechanism that reliably keeps internal material current.
It says what to do when it goes wrong. The failure modes and who to ask. Internal documentation that only covers the happy path sends people to Slack at exactly the moment they are already stuck.
It records what was tried and rejected. The most valuable and least written part. A decision with its alternatives is a decision the next person can revisit rather than relitigate from scratch.
It is findable. Internal knowledge bases fail on retrieval more often than on content. A document nobody can find is a document that gets rewritten by someone who assumed it did not exist.
When it goes stale
The distinctive mechanism: it decays when a person leaves, not when a fact changes.
Tacit knowledge fills the gaps in every internal document, and it lives in whoever wrote it. While that person is available the gaps are invisible, because anyone stuck just asks them. When they leave, every unstated assumption becomes a blocker at once, and nobody discovers the document was incomplete until someone tries to follow it.
Three other triggers. The process changed and the document did not. The tools changed, so the steps reference something that no longer exists. And the owner moved on without the ownership transferring, which is the same failure wearing a different hat.
The structural fix is that the review trigger is a person changing role, not a calendar date.
What it feeds
- Onboarding a new person — the real test, and where every gap surfaces at once
- The public knowledge base — some internal documents are external documents with the sensitive parts removed
- Process improvement — a document that is hard to write usually describes a process that is too complicated
Frequently asked
- Who is an internal document written for?
- The person who will do this next, who knows less than the writer does. Documents written for peers assume context the next person will not have, and that context is usually the part that mattered.
- Should you document the reason or just the steps?
- Both, and the reason first. Steps without a reason cannot be adapted when the situation differs slightly, which it always does.
- How do you keep it current?
- Name an owner on every document. An unowned document is a document nobody is wrong for letting rot.