Course Outline
Introduction to Technical Writing
- Communicate technical information effectively.
- Address common writing challenges.
The Writing Process
- Overcome barriers that hinder technical writing, such as writer’s block.
- Guide your document design using scenarios.
- Align your objectives with those of the readers.
- Identify implied knowledge.
Ensuring Clarity and Readability
- Distinguish among the three levels of information: operational, tactical, and strategic.
- Determine information needs using the Observe, Orient, Decide, Act (OODA) loop.
- Construct clear sentences and enhance clarity through sentence focus.
- Resolve common grammar issues in technical writing.
- Assess readability using the Given/New technique.
- Maintain consistency with a style guide.
The Mechanics of Writing
- Choose appropriate words to connect with your audience and convey your message.
- Edit for conciseness, accuracy, and overall quality.
Structuring Information for Better Understanding
- Organize data to support readers' scenarios.
- Determine when to use lists to highlight key points.
- Utilize tables for highly structured data.
- Create cohesive documents using the Given/New approach.
- Apply effective headings to facilitate skimming.
Designing Your Document
- Align document structure with the audience through audience-driven design.
- Develop reference manuals and write white papers.
- Distinguish between post-positive and pragmatic documents and implement the appropriate format.
- Structure introductions, conclusions, and other document sections.
Developing the Look of Your Document
- Design the page appearance, including fonts, alignment, and white space.
- Convey information through graphics, photos, and drawings.
Testimonials (3)
Meeting efficiency is something that's fairly "basic", but not thought about a lot and with really large implications on people/company time. Understanding these best practices and keeping them top-of-mind will be of immediate help.
Dan Moffatt - Chris Courtemanche
Course - Personal Efficiency and Managing Meetings
The good relationship that was established from the outset with the trainer and the group. The trainer adapted to the team's dynamics and understood our needs perfectly. It was both super helpful and fun.
Roger Negrete - Fundacion Mon Clinic Barcelona
Course - Effective English Communication: One-Day Training Program
The active sessions.