INTRODUCTION TO
TECHNICAL WRITING
Abrar
AGENDA
What is technical writing?
Deliverables
Types of technical writing
Considerations and resources
Next steps
What is Technical
Writing?
Deliverables
Types of Technical Writing
Considerations and Resources
What is Technical
Writing?
Bridging the gap
between people who
know technology and
the ones that use it.
Technical Writing is writing that helps users solve
problems with technologies and technical subject matter
Jeff Grabill, Georgia State University
What is Technical Writing?
Types of Technical Writing
Considerations and Resources
Deliverables
AGENDA
TYPES OF
TECHNICAL
WRITING
Software Documentation
Medical Writing
Aerospace Documentation
Scientific Writing
Grant Writing
CORRELATIO
N
Technical
Writer
Instructio
nal
Designer
Other
Business
Analyst
User
Stories
Use Cases
BRD, FRD
CORRELATIO
N
Technical
Writer
Instructio
nal
Designer
Other
Business
Analyst
CORRELATIO
N
Technical
Writer
Instructio
nal
Designer
Other
Business
Analyst
Solution
design
Sales
brochure
Newsletter
What is Technical Writing?
Deliverables
Types of Technical Writing
Considerations
Examples and Resources
Deliverable
s
Training Material Software Documentation Multimedia
Manuals
(EPUB and PDF)
Release Notes SDLC Documents Videos
Demonstrations
Online Help API Documentation Troubleshooting
Guides
Software Simulations
Quick Reference
Guides
Test Strategies, Test
Plans
Installation Guides E-learning content
CONSIDERATIONS AND RESOURCES
What is Technical Writing?
Types of Technical Writing
Considerations and Resources
Deliverables
Language
LANGUAGE
Active voice
Parallelism
Anthropomorphism
Bias Free
Clicking Start, you point to
Settings, and then click Printers.
Click Start, point to Settings, and
then click Printers.
If you receive a confirmation
message, the engine behaves as
you requested.
If you receive a confirmation
message, the engine stores your
data in the specified format.
GEOGRAPHY
English UK
English USA
English
International
STYLE GUIDE
Technical Documentation
IBM
MSTP
CMS
ACCESSIBILI
TY
Users with
special needs
Plain Language
Format
TOOLS AND
TECHNOLOG
Y
Authoring
•MS Word
•Adobe Framemaker
•Oxygen XML
•Author Café
•MediaWiki
•Adobe RoboHelp
VideoMaking
•Adobe Captivate
•TechSmith Camtasia
•Video Scribe
•Active Presenter
•Windows Movie Maker
MISC
•MS Visio
•TechSmith SnagIt
•Green shot
•Mockflow
•Canva
•Adobe Photoshop
•MS PowerPoint
DOCUMENT
DEVELOPME
NT
LIFECYCLE
(DDLC)
Requirement
Analysis
Design
Development
Edit/Proofread
Publish and
Maintenance
NEXT STEPS
Join a technical communication
organisation
Join online communities
Find and read job descriptions
THANK YOU
abrar.techwriter@gmail.com

Introduction to technical writing