Introduction to Technical Writing

Request more details:

Description:
Great technical writing will help any reader understand quickly and clearly: poor technical writing delays, confuses and often irritates. This course aims to ensure that participants can make their technical documentation accurate, brief, clear, complete and, above all, useful.
Prerequisites:
Participants should be committed to delivering reports, manuals and routine communications that address the needs of their target audience effectively and efficiently.
Training style:
The workshop will be highly participative and constantly seek to anchor the skills and knowledge in the participants work situation.
People learn by best by “doing” and the content will combine generic learning inputs with “smart practice” using predefined exercises and referencing documents and situations specific to the client company where possible.
Getting the Reader into focus:
Understanding all the forces at play in the communications arena
The first principle of effective communicating
Profiling the reader
Persuading the reader
Structure and process:
Identifying the right structure
Preparing your document – A Five Step Process
Drafting and polishing
Editing and checking
Effective writing skills:
The TAB3C channel to effective writing
Timing is important!
How to ensure that your reports are accurate and complete
Common enemies of brevity and how to beat them
The four steps to writing concisely
How to structure sentences
How to avoid ambiguity and vagueness
The danger of double negatives
Common enemies of clarity and how to beat them
Using correct punctuation
The wisdom of courtesy
How and when to use jargon, abbreviations and shortenings
When to use the active or passive voice in writing
Specific Technical Reports:
Knowing your end user
Interviewing Subject Matter Experts
Explaining jargon
Style and consistency
Does it work? - Smart testing
Deviation and Incident Reports
SOPs and User guides
Data Visualisation & Presentations:
How to interest and persuade your audience with:
- Clear simple charts
- Well-designed tables
- Simple Dashboards
- User Interactivity
- Effective delivery
The Writers’ Miscellany:
Incident/Deviation Reports, SOPs and User Guides
Lists – vertical and in-sentence
Numbers
Values and dates
Fonts
Graphs, tables and screen captures
Tenses
Abbreviations
When to use capital letters
Capitalisations
Future developments
Writing emails