Understanding a Platform
Which services belong together, who is responsible and where are important dependencies? A system overview provides a start.
Learn moreFocus of this page: Knowledge that helps you move forward.
Discover
From the overview to the concrete process.
Good documentation answers a specific question. These three formats help with orientation, execution and later comprehensibility.
Executing a process safely
A runbook describes prerequisites, inspection steps and how to deal with deviations. Get to know a compact structure for recurring tasks.
Learn more
Understand decisions
Record context, alternatives, and consequences. A short decision record will explain why a particular solution was chosen.
Learn moreContext
Documentation needs an occasion and an owner.
Long texts alone do not secure knowledge. A clear target group, a named responsible person and a date for the next review are helpful. Link information to the processes in which it is needed.
Name a question
Record who needs the information and what task it is intended to solve.
Structuring knowledge
Separate prerequisites, steps, results and further references from each other.
Check usage
Have another person apply the text and improve unclear passages together.
Put ideas into practice
A runbook that others can use
Document more than commands. A useful procedure explains when it may be used and how to recognise a successful outcome.
How do we assess an instruction's quality?
Ask a qualified colleague to work through the documentation. This reveals unclear prerequisites and missing checks. Record the owner and review date, and update the procedure after relevant changes.
Three points to prepare
- Prerequisites: State the access role, service and approvals required.
- Execution: Describe checks and expected results in order.
- Deviation: Record stop conditions, rollback and a contact.