- »
- Tutorials »
- Technical writing »
- 1 technical writing one »
- Objectives
-
Objectives
- Use terminology—including abbreviations and acronyms—consistently.
- Recognize and disambiguate pesky pronouns.
Active and Passive
- Distinguish active voice from passive voice.
- Convert passive voice sentences to active voice.
- Identify three ways in which active voice is superior to passive voice.
Clarity in sentences
- Develop at least three strategies to make sentences clearer and more engaging.
- Develop at least four strategies to shorten sentences.
Lists
- Understand the difference between bulleted lists and numbered lists.
- Create helpful lists.
Paragraphs
- Create effective lead sentences for paragraphs.
- Focus each paragraph on a single topic.
- State key points at the start of each document.
Audience
- Identify your target audience.
- Determine what your target audience already knows and what your target audience needs to learn.
- Understand the curse of knowledge.
- Identify and revise idioms.
- State your document's scope (goals) and audience.
Breaking into sections
- Break long topics into appropriate sections.
- Use commas, parentheses, colons, em-dashes, and semicolons properly.
Markdown
- Develop beginner competency in Markdown.