STAGE 1: Understand the reader
Concept: Documentation should match the reader’s task and prior knowledge.
Task: Define one primary reader, their goal and the prerequisites they actually need.
Acceptance: Do not assume developer knowledge for an end-user guide.

My assumptions:

My work / file link:

My checks and results:

What I changed:


STAGE 2: Write a runnable procedure
Concept: A procedure needs ordered actions and observable results.
Task: Draft a quickstart with sample input, commands or UI actions and expected output.
Acceptance: Each step has one clear action and avoids unexplained jargon.

My assumptions:

My work / file link:

My checks and results:

What I changed:


STAGE 3: Improve failure recovery
Concept: An error message should explain what happened and what to do next.
Task: Rewrite three vague errors and add a troubleshooting table.
Acceptance: Do not expose secrets or internal stack traces as user guidance.

My assumptions:

My work / file link:

My checks and results:

What I changed:


STAGE 4: Test the document
Concept: Documentation testing checks whether a reader can act on the text.
Task: Run a cold-read walkthrough yourself or with a consenting reviewer and record actual observations.
Acceptance: Do not invent user-test quotes or claim an unperformed test.

My assumptions:

My work / file link:

My checks and results:

What I changed:
