Potential Learning task
Define new or unfamiliar terms
Use same term name consistently
Use acronyms properly
Recognize ambiguous pronouns
Active voice vs passive voice
Choose strong verbs for clear writing
Focus each sentence on a single idea
Reduce subordinate clauses (optional)
<aside>
💡 same rules apply to technical writing:
- Shorter documentation reads faster than longer documentation.
- Shorter documentation is typically easier to maintain than longer documentation.
- Extra lines of documentation introduce additional points of failure.
</aside>
Paragraphs
AudienceÂ
<aside>
💡 Define your audience's needs
Answering the following questions helps you determine what your document should contain:
- Who is your target audience?
- What is your target audience's goal? Why are they reading this document?
- What do your readers already know before they read your document?
- What should your readers know or be able to do after they read your document?
</aside>
DocumentsÂ