Courses + Certifications
Professional Development | | Desktop Applications | | Technical | |
|
Home > Professional Development > Business Communication > Writing Technical Documentation
Writing Technical Documentation
| Print Preview | Send to a friend |
| Learning Method: |
Instructor Led |
Overview: |
| This two-day workshop introduces you to write good quality technical documents. Technical documents include procedures, instructions, manuals, and user guides. You learn to clearly define outcomes of what your writing must deliver, who your readers are, and how to present the information in the most useable way. This course will give you the tips and techniques so that all your documents are clear, concise and consistent. You systematically work through the planning, structuring, writing, checking and presentation stages of a project so that you finish with a high quality piece of writing that reaches its audience and achieves its purpose.
|
Target Audience: |
| If you are responsible for writing or editing technical material such as user manuals, staff instructions, procedures manuals, reference materials or training manuals this workshop is ideal for you. It is especially designed for: |
- Technical writers
- Training specialists
- Business and systems analysts
- Information technology managers
- Security and safety professionals
- Publications managers
- Researchers
- Quality managers
- Project managers
|
At Course Completion: |
- Plan a technical document
- Write appropriately for the audience
- Understand basic grammar
- Write clearly
- Test a technical document
- Edit a technical document
|
| Lesson 1: Getting Started |
- What technical writing is
- Why we need technical writing
- How you can use Plain English in technical writing
- How you can use the 5 step technical writing process
|
| Lesson 2: Planning your Document |
- Establishing a document aim
- Creating into a workable outline
- Keeping track of your writing style
|
| Lesson 3: Useful Grammar |
- Basic grammar terminology
- Writing sentences with impact
- Using paragraphs as an organisational tool
- Differentiating between active and passive voice and recognise prepositions
- Creating lists
- Using punctuation, capitals and tense consistently
|
| Lesson 4: Writing for Clarity and Impact |
- Choosing concise and explicit words
- Dealing with jargon, technical words, acronyms and abbreviations
- Writing positively and differentiate between Australian, US, and UK English
- Using inclusive language and analogies
|
| Lesson 5: Word Alternatives |
- Creating effective charts
- Creating effective screen shots
- Creating effective diagrams
- Creating effective tables
- Outlining procedures with flow charts
- Representing hierarchies with organisational charts
|
| Lesson 6: Testing Technical Documents |
- Checking the document technically
- Checking the document for readability
|
| Lesson 7: Editing Technical Documents |
- Checking the document yourself
- Using your editor
- How to test the draft for readability
- Finding out whether it works for your audience
- Self checking and editing the document
- Checking for accuracy and flow
|
|
 |
|
|
