Good documentation begins with a reader and a task—not a feature list.
Name the audience
Choose one primary audience before you outline. Record what those readers are trying to accomplish, what they already know, the setting in which they will read, and any constraints that affect their choices. Plain-language guidance treats audience definition as a foundation for content people can understand and use.
Turn that audience description into writing decisions. A newcomer may need terms defined and assumptions made visible, while an experienced operator may need concise reference details. If a detail does not change the language, depth, sequence, or format of the document, it probably does not belong in the reader profile.
Design for the moment
Readers approach documentation in different situations. Someone responding to an outage needs the safest next action immediately; someone learning a concept needs orientation, examples, and time to build a mental model. Identify the reader's moment so the document answers the right question at the right level of urgency.
Organize the page around that immediate need rather than the product's internal structure. Put the action, answer, or decision first, then add supporting detail in the order the reader will need it. This makes the document easier to scan and reduces the effort required to turn information into action.
Practice prompt
Put it into practice
Write a four-line reader profile for a document you use at work. Remove anything that does not change a writing decision.
Before you move on
- One primary reader is named
- Their task is observable
- Required knowledge is explicit