Course Duration

24 hours, 3-day training workshop

Delivery

Face to face training or online training

Course Inclusive

Training materials & certificate of completion

Description

Today, access to clear, relevant, and useful information increases any organization’s competitive advantage. At the heart of information management is the technical writer who is tasked to communicate technical information in a manner that can be understood by and useful to the intended readers. Such information has become vital in the organization’s decision-making cycle. Developing the craft of technical writing is easier said than done. At times, the writer ends up confusing instead of enlightening the reader. Worse, the writer may also cause the reader to be indifferent rather than enthused about the subject matter. The Craft of Technical Writing promotes a keen understanding and a strong adherence to the key principles of technical writing.

Course Content

1. Differences between writing and speaking
2. Myths about writing
3. Differences between and technical writing
4. The importance of technical writing
5. The cost of poor writing
6. What is technical writing
7. Examples of technical writing
8. Technical writing and the subject matter expert (SME)
9. Key principles of technical writing
   1. know your audience
   2. write for a purpose
   3. organize
   4. write the draft
   5. review and revise the draft
10. Editing and revising
11. Common technical documents
    1. Emails
    2. Proposals
    3. Status reports
    4. Minutes of meetings
    5. Incident reports
    6. User manuals
    7. Others
12. Other topics
    1. Focus on grammar - common mistakes, exercises
    2. Convincing your reader
13. Course Recap