Summary of Technical Writing One
Technical Writing One covered the following basic lessons of technical writing:
- Use terms consistently.
- Avoid ambiguous pronouns.
- Prefer active voice to passive voice.
- Pick specific verbs over vague ones.
- Focus each sentence on a single idea.
- Convert some long sentences to lists.
- Eliminate unneeded words.
- Use a numbered list when ordering is important and a bulleted list when
ordering is irrelevant.
- Keep list items parallel.
- Start numbered list items with imperative words.
- Introduce lists and tables appropriately.
- Create great opening sentences that establish a paragraph's central point.
- Focus each paragraph on a single topic.
- Determine what your audience needs to learn.
- Fit documentation to your audience.
- Establish your document's key points at the start of the document.
Congratulations! You've completed the pre-class portion of
Technical Writing One.
The in-class component of Technical Writing One helps you practice technical
writing principles:
- If your organization offers the in-class portion of Technical Writing
One, you are now ready for that class.
- If your organization doesn't offer the in-class portion of Technical
Writing One, consider joining one of the free public courses listed on
the Announcements page.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[null,null,["Last updated 2024-08-06 UTC."],[[["Technical Writing One emphasizes clear and concise writing by focusing on consistent terminology, active voice, specific verbs, and single ideas per sentence."],["This course teaches effective communication through proper list usage, introductory elements, impactful opening sentences, and targeted paragraph structure."],["Understanding audience needs and tailoring documentation accordingly are crucial aspects of technical writing discussed in the course."],["Technical Writing One is divided into pre-class and in-class components, with options for public courses if in-class sessions are unavailable within your organization."]]],["Technical writing involves consistent terminology and avoiding ambiguous pronouns. Use active voice, specific verbs, and single-idea sentences. Convert long sentences to lists and eliminate unnecessary words. Employ numbered lists for ordered items and bulleted lists for unordered ones, ensuring parallel list items. Start numbered lists with imperative words and introduce lists and tables properly. Focus paragraphs on a single topic, and tailor the document to audience needs. Highlight the key points at the beginning.\n"]]