Technical Writing

What is technical writing?

Taking complicated subject matter and transforming it into easy to understand information for the reader

What Do Technical Writers Create?

Users manuals

System manuals

Step-by-step procedures

How-to video scripts

On-line help

Training manuals

Quick reference guides

The Process . . . .

1. Define the project

2. Estimate project hours

3. Retrieve, analyze & synthesize

7. Deliver

4. Design the project

5. Write

6. Edit/Revise

Define the project

Who will read the document?• Executives

• System Analysts

• Clients

• Operators

Define the project

• Persuasive

• Motivational

• Instructional

• Procedural

What’s the style?

• Historical

Define the project

• Printed reports

• Books

• Fact Sheets

• Videos

What type of document do you need?

• CD’s

• On-Line

• Combination of print & electronic

Define the project

• Time

• People

• Equipment

What resources are available?

Estimate Project Hours

• Research

• Interviews

• Information Entry

• Document Design

Estimated time includes

• Revisions

Retrieve, analyze & synthesize

• Subject Matter Experts (SME)

• Existing documentation

• Software testing

• Internet research

Organize your sources

• In-house resources

• Library

Design Project

• Manual of style

• Visio

• MS Word

• Internet research

Tools

• Framemaker

Write

• They sit with information & tools

• . . . and they write

Writers write

Edit & Revise the Document

• Accuracy

• Clarity

• Consistency

The content is reviewed & edited for:

• Conciseness

• Usefulness

• Organization

Deliver The Project

• It’s well thought-out & edited

• Tailored to the customers needs

• A reflection of comprehensive methodology