Technical Writing

An Introduction

By: Tamanna

What is Technical Writing?

Understanding the target audience for a document, analyzing what information they need and determining how best to deliver it.

Presenting and Communicating complex technical information in simple language.

Characteristics of Technical Writing

Effective Writing should be: Clear Concise Correct Complete Consistent

This can be achieved by: Appropriate Word Choice Clear Sentence Structure Coherent Paragraphs Logical Progression of Paragraphs

Make Sure to Use Simple words Clear sentences Coherent paragraphs

Ensure Consistency Conciseness Objectivity Accuracy

Watch out for Acronyms, abbreviations, and jargon Slangs and foreign words Biased language

Characteristics of Technical Writing

(Contd…)

Process of Technical Writing

1. Define the project

2. Retrieve, analyze & synthesize

3. Design the document

4. Write the document

5. Edit/Revise the document

6. Deliver the document

Define the Project

Who will read the document?

What’s the Style? What type of

document do you need?

What resources are available?

Organize your sources Subject Matter

Experts (SMEs) Existing

documentation Software testing Internet

research Library/Books

Retrieve, Analyze, and Synthesis

Tools The Microsoft

Style Guide RoboHELP Framemaker Captivate Visio Quark Express MS-Word

Design the Document

Write the Document

Write the document Review the document Send document to the

subject-matter expert (SME) for technical review

Incorporate the SME comments

The content is reviewed & edited for:

Accuracy Clarity Consistency Conciseness Usefulness Structure Style Format Grammar, Spelling Punctuation

Edit and Revise the Document

Deliver the document in the form of: Integrated documents Printed

Documents/Reports CDs Books

The delivered documents must be tailored to the customers needs

Deliver the Document

What do Tech Writers create?

User’s Manuals Installation Guide On-line Help API Manuals Training Manuals Quick-reference Guides Release Notes Catalogues Brochures

Summary

In a nutshell, this presentation included:

The concept of technical writing The characteristics of technical writing The process of technical writing Deliverables of technical writing

Thank You

Happy Writing!!!