English 4Technical Writing

What do YOU write?

At

home? At school?

What is Technical Writing?

Technical Writing AKA

Business

Writing Workplace Writing Professional Writing Informational Writing

What is Technical Writing?

It is the type of everyday writing that surrounds us from the time we wake until we climb in bed at night.
Directions on the toothpaste tube Nutrition benefits on the cereal box Business letters and catalogs that come in the mail Written instructions for assembling a new product Tax receipts and notices Product safety information

How is Technical Writing Different?

The information is organized, presented and communicated in a specific format. The writing is concise, clear and accurate. The writing takes into account the audiences needs, biases and prior understanding. The writing presents information to help readers solve a problem or gain a better understanding of a situation. The writing conveys technical, complex, or specialized information in a way that is easy for a non-technical reader to understand.

In short Technical Writing

is taking complicated subject matter and transforming it into easy-to-understand information for the reader.

What employers say

1/3 of the employees in Americas top companies are poorly trained in writing and cannot compose a coherent business response (National Commission on Writing) Conscientious employers are retraining employees to write in the workplace

SCANS Report
(Secretary's Commission on Achieving Necessary Skills)

Three-Part Foundation needed on the job

Basic Skills (reads, writes, performs mathematical operations, listens and speaks) Thinking Skills (Thinks creatively, makes decisions, solves problems, visualizes, knows how to learn, and reasons) Personal Qualities (Displays responsibility, self-esteem, sociability, self-management, and integrity and honesty)

SCANS Report

Five Workplace Competencies

Resources: Identifies, organizes, plans and allocates resources

Interpersonal: Works with others Information: Acquires and uses information

Systems: Understands complex interrelationships

Technology: Works with a variety of technologies

SCANS Report
Possessing basic writing skills means that students need to communicate thoughts, ideas, information, and messages in writing; and create documents such as letters, directions, manuals, reports, graphs, and flow charts.

American Diploma Project (ADP) Schools need to train students to communicate essential information effectively via email, write proposals to obtain new business, communicate key instructions to colleagues or convey policies to customers.

What do Tech Writers create?

Users manuals System manuals Step-by-step procedures On-line help Training manuals Quick-reference guides How-to video scripts

The Process. . . .
1. Define the project 2. Estimate project hours 3. Retrieve, analyze & synthesize 4. Design the project 5. Write 6. Edit/Revise 7. Deliver

1. Define the Project

Who will read the document?

Executives

System
Clients

Analysts

Operators

1. Define the Project

Whats the Style?

Persuasive Motivational

Instructional
Procedural Historical

1. Define the Project

What type of document do you need?

Printed

reports

Books
Fact

Sheets Videos CDs On-line A combination of print & electronic

1. Define the Project

What resources are available?

Time

People
Equipment

2. Estimate Project Hours

Estimated time includes:

Research

Interviews
Information

Entry Document Design Revisions

2. Estimate Project Hours

Document Item Estimate (hrs/item)

By the page 8-12 Procedure Glossary term Reference topic Window Field Graphic

8-12 1 3-4 3-6 1 2

3. Retrieve, analyze & synthesize

Organize your sources

Subject

Matter Experts (SMEs) Existing documentation Software testing Internet research In-house resources Library

4. Design Project

Tools
The

Chicago Manual of Style RoboHELP Visio Inspiration MS Word Framemaker

5. Write

Writers write
They

sit with information and tools. . . . . . and they write.

6. Edit & Revise the Document

The content is reviewed & edited for:

Accuracy Clarity

Consistency
Conciseness Usefulness Organization Style Format Grammar,

Spelling Punctuation

ABCs of TW

7. Deliver The Project

Its well thoughtout & edited Tailored to the customers needs A reflection of comprehensive methodology

Literary/Academic Writing
Descriptive Writing

Technical Writing
Job Description, Incident Report, Rsum, Process Explanation

Narrative Writing
Analysis Cause and Effect Compare-Contrast Persuasive Writing

Observation Report, Progress Report Performance Evaluation, Feasibility Report Analytical Report, Product Field Test Report Product Comparison, Feasibility Report Proposal, Action Plan

End-products of Technical Writing:

Action

Plans Advertisement Agenda Audit Report Book Review Brochure Budget Business Letter Business Plan Catalog Contract Critique Data Book or Display

Description Diagram, Chart, or Graph Editorial Email Feasibility Report Field Test Report Incident Report Informational Form Informational Poster Informative Summary Instructions Interview Questions Itinerary

End-products of Technical Writing:

Job Application Job Description Lesson Plan Letter of Inquiry Letter of Recommendation Magazine/Newspaper Article Marketing Plan Memo Meeting Minutes Newsletter Observation Report Performance Evaluations Persuasive Proposal Position Paper Product Comparison Proposal Questionnaire Research Report Rsum/Portfolio Scientific Paper/Report Survey Test Transcription Training Manual Travel Guide Web Page Work Order

Questions and Comments?

Reflection
Things I learned Things I confirmed Question I still have

30