Technical Writing
On completion of the training the participants will have the skills and techniques to:
• Write clear, concise, and audience-centric content
• Understand the writing process
• Plan and structure documents from scratch
• Understand the value of using a style guide
• Take part in a peer editing process and give constructive and relevant feedback.
Day 1
5 Hours
Module Title Description
1 Introduction
This module introduces the field of technical writing and outlines the learning outcomes for the course.
2 The Importance of Good Documentation & the Writing Process
In this module, participants learn why good documentation is important, and they are introduced to the concept of the Writing Process.
3 Know your Audience
Participants learn how to gather and manage information, and how to develop audience-centric content.
4 Characteristics of Good Writing
This module focuses on key elements of good writing, such as using the active voice, clarity of structure and language, conciseness, and completeness and accuracy of content. It also introduces the important concept of storytelling.
Day 2
5 hours
Module Title Description
6 Elements of Structure
In this module, participants learn techniques to help structure content in a way that makes it as easy as possible for audiences to locate the information they need.
7 Style Guides and Templates
Participants learn how a style guide supports the creation of a unified voice and message. This module also discusses the benefit of templates in the writing process.
8 Mechanics of Writing
This module focuses on grammar and punctuation, using practical examples to highlight common grammatical errors.
9 Editing
This module teaches participants best practice techniques for self-editing and providing constructive feedback to colleagues in review cycles.