1. Course Content – Technical Writing
© 2017 Wholistic Health Foundation

2. Course Content – Technical Writing
Module 1
- Introduction to Technical Writing
Various names of Technical Writing
Various names of Technical Writers and why (somewhat true)
Various industries that employ technical writers or outsource Technical Writing
Different domains where Technical Writing is done (Why domain knowledge is important)
How to present information in technical documents; the 80:20 rule
Technical Writing – Cost Center or for profit (Difference between product and services company)
Why technical writers are paid more that normal content writers
Technical Writing Career Path
An enriching career – get yourself ready

3. Course Content – Technical Writing
Module 2
Document Development Life Cycle (DDLC- Documentation Process)
Importance of Documentation Process
How DDLC fits in SDLC
Agile Documentation
What is SCRUM?

4. Course Content – Technical Writing
Module 3
Language and grammar
How to improve written English
Why correct usage is important - Examples
Style Guides and why?
Some popular Style Guides
Importance of consistency
Why simpler is better

5. Course Content – Technical Writing
Module 4
Types of documents (Some examples and samples)
User Guide (Task based)
Admin Guide (Task based)
Installation Guide
Installation Test Guide
Release Notes
Quick Reference Guide
Troubleshooting Guide
API Reference Guide
Some esoteric names

6. Course Content – Technical Writing
Module 5
Ways of presenting information
Types of writing
Info Mapping (Types of maps, Principles of labeling and chunking)
DITA (Types of maps)
Topic Based Writing
Minimalistic Writing
What is Structured Writing?
Why Structured Writing is called so?

7. Course Content – Technical Writing
Module 6
Tools used commonly in Tech Writing
Framemaker
Epic Editor
RoboHelp (Fast-Help)
Qarbon – A quick review; Alternative – Captivate
SnagIt
Adobe Acrobat (Reader included)
MS Office (Why?)
Some online tools and their importance

8. Course Content – Technical Writing
Module 7: Project Work (3 days)
Create a User Guide for MS Paint
You can use MS Word
Define the styles in MS Word
Convert the MS Word file to PDF
Hints:
This is going to be a task based document
You can choose the info presentation method
You can use the 80:20 rule to minimize documentation
You can use SnagIt or any other freeware for screenshots
For conversion to PDF use an online tool
You can refer to any other help you can get
DO NOT COPY AND PASTE

9. Course Content – Technical Writing
Module 8
Resume update and resume writing
Mock interview sessions
Applying to jobs though Naukri and Monster
Attending interviews from other sources

10. Course Content – Technical Writing
Module 9 (Optional – On request)
Soft Skills for Freshers
Managing your work and personal life

11. Course Content – Technical Writing
Module 10
Feedback about the course
How we can improve
What was your experience like?
TESTIMONIALS 