Documentation for different readers
On This Lesson 4 topics
This lesson is planned. The outline below lists the topics it will cover. The full lesson has not been published yet.
In this lesson
write for a named reader and purpose.
Planned topics
- Engineers need structure and decisions; operators need procedures and signals; leadership needs risks, costs, and outcomes.
- One document for every audience serves none.
- State the audience and the question the document answers at the top.
- Link between documents instead of copying.
Draft outline details
Demonstration
a matrix of audience, question, document type, and length for the order subsystem.
Check your understanding
Why avoid one document for every audience?
Show answer
Each reader needs different content and detail.
Practice
Apply this lesson with the module's lab, exercises and quiz.
Marking a lesson complete is optional and you can undo it any time. Your progress stays in this browser.