Chapter 16 — Technical documentation and safety
Lesson map
Lesson 16 published. Map, example, EX061.
flowchart TD
N0["Learning outcomes"]
N1["16.1 Why documentation matters"]
N2["16.2 Structure of a control document"]
N3["16.3 Safety and rollback"]
N4["16.4 Keeping it current"]
N0 --> N1 --> N2 --> N3 --> N4
N4 --> EX["Worked example"]
EX --> Q["Exercise EX061"]
Logical drawing
flowchart LR
N0["Learning outcomes"]
N1["16.1 Why documentation matters"]
N2["16.2 Structure of a control document"]
N3["16.3 Safety and rollback"]
N4["16.4 Keeping it current"]
N0 --> N1 --> N2 --> N3 --> N4 --> Q["EX061"]
[Learning outcomes]
|
v
[16.1 Why documentation matters]
|
v
[16.2 Structure of a control document]
|
v
[16.3 Safety and rollback]
|
v
[16.4 Keeping it current]
|
v
[Worked example] --> [Exercise EX061]
Learning outcomes
You will (1) write clear technical documentation for privacy controls; (2) include safety and rollback; (3) keep documentation current.
16.1 Why documentation matters
Marlow's IT contractor changes staff every few years, and practice managers change clinics. Leila finds that several privacy settings, such as the network zones and the reminder deletion job, are understood by only one person. If that person leaves, nobody knows why a setting exists or how to check it. Article 5(2) requires Marlow to demonstrate compliance, which is impossible if nobody can explain the controls. Documentation turns personal knowledge into organisational knowledge that survives staff changes and supports audits. One contractor holds most knowledge today.
16.2 Structure of a control document
Leila writes one short document per control with a fixed structure: purpose, the risk it addresses, where it is configured, how to check it works, what normal results look like, what to do when results are abnormal, who owns it and when it was last reviewed. The deletion job document, for example, shows where the job runs, the expected daily message and the quarterly check. She keeps documents under two pages and uses screenshots from the test environment, never from live patient screens.
16.3 Safety and rollback
Every change procedure includes safety steps. Before changing network rules, the contractor records the current configuration so it can be restored. Before enabling deletion, the job runs in report-only mode. Before changing roles, a test account confirms that daily tasks still work. Each procedure states how to roll back and when rollback is not possible, such as after data have been deleted. Leila explains that irreversible steps deserve extra checks, because a mistake cannot be undone once patient data are gone. Rollback steps are tested too.
16.4 Keeping it current
Documents drift from reality as systems change. Leila adds a review date to each document and links document reviews to change tickets: any ticket that touches a documented control must update the document before closing. Every six months, the data protection officer receives a list of documents past their review date. Mr. Okafor reviews her documents and asks her to remove two paragraphs of background theory, because operational staff need instructions and reasons, not lectures, when something goes wrong at a busy clinic.
Worked example
Leila writes two-page control documents with purpose, risk, location, checks, normal results, abnormal actions, owner and review date, adds rollback steps and links updates to change tickets.
Synthetic case. Documents are synthetic; GDPR Article 5(2) is real.
Errors and limits
Documents written once and never reviewed become misleading.
Exercises
- EX061 — Single knowledge. Why was single-person knowledge a risk? Rubric: 3 = nobody could explain controls if that person left;; 2 = mentions leaving;; 1 = vague;; 0 = none.
- EX062 — Document fields. Name four parts of a control document. Rubric: 3 = purpose, risk, location, checks, results, actions, owner, review date;; 2 = four;; 1 = two;; 0 = none.
- EX063 — Irreversible steps. Why do irreversible steps need extra checks? Rubric: 3 = mistakes cannot be undone after deletion;; 2 = mentions deletion;; 1 = vague;; 0 = none.
- EX064 — Staying current. How are documents kept current? Rubric: 3 = review dates and change tickets must update them;; 2 = mentions tickets;; 1 = vague;; 0 = none.
Continue studying — lesson 16 (chapter 16 of 18)
← Chapter 15 · Course chapter index · Chapter 17 →
Continue to the next authored lesson.