technical writing notes

50 %
50 %
Information about technical writing notes

Published on January 3, 2009

Author: dipti


Technical Writing : Technical Writing Methodology 101 What is Technical Writing? : What is Technical Writing? Taking complicated subject matter and transforming it into easy-to-understand information for the reader. What do Tech Writers create? : What do Tech Writers create? User’s manuals System manuals Step-by-step procedures On-line help Training manuals Quick-reference guides How-to video scripts The Process. . . . : 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 : 1. Define the Project Who will read the document? Executives System Analysts Clients Operators 1. Define the Project : 1. Define the Project What’s the Style? Persuasive Motivational Instructional Procedural Historical 1. Define the Project : 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 : 1. Define the Project What resources are available? Time People Equipment 2. Estimate Project Hours : 2. Estimate Project Hours Estimated time includes: Research Interviews Information Entry Document Design Revisions 2. Estimate Project Hours : 2. Estimate Project Hours Document Item Estimate (hrs/item) By the page 8-12 Procedure 8-12 Glossary term 1 Reference topic 3-4 Window 3-6 Field 1 Button .25 Graphic 2 3. Retrieve, analyze & synthesize : 3. Retrieve, analyze & synthesize Organize your sources Subject Matter Experts (SMEs) Existing documentation Software testing Internet research In-house resources Library 4. Design Project : 4. Design Project Tools The Chicago Manual of Style RoboHELP Visio Inspiration MS Word Framemaker 5. Write : 5. Write Writers write They sit with information and tools. . . . . . and they write. 6. Edit & Revise the Document : 6. Edit & Revise the Document The content is reviewed & edited for: Accuracy Clarity Consistency Conciseness Usefulness Organization Style Format Grammar, Spelling Punctuation 7. Deliver The Project : 7. Deliver The Project It’s well thought-out & edited Tailored to the customers needs A reflection of comprehensive methodology

Add a comment

Related presentations

Related pages

Technical Writing Notes #3 -

Technical Writing Notes #3 - Free download as Word Doc (.doc / .docx), PDF File (.pdf), Text File (.txt) or read online for free. Technical writing notes ...
Read more

Technical Writing Tips - Columbia University

Writing Technical Articles. The notes below apply to technical papers in computer science and electrical engineering, with emphasis on papers in systems ...
Read more

Technical Writing made easier - ic#code

Technical Notes, general Series Technical Writing made easier rev. 1.1, March 2002 by Bernhard Spuida, Senior Word Wrangler
Read more

Technical Writing Notes -

Eng 153: Technical Writing. What is Technical Writing? “Technical writing conveys specific information about a technical subject to a specific
Read more

What is Technical Writing? - Tech Writer Today - TechWhirl

Tech Writer Today article that defines technical writing, introduces key concepts and provides guidance for technical writers starting their ...
Read more

Technical writing - Wikipedia, the free encyclopedia

Technical writing is any written form of writing or drafting technical communication used in a variety of technical and occupational fields, such as ...
Read more

Notes on Technical Writing - University of Texas at Austin

Notes on Technical Writing Adnan Aziz The University of Texas at Austin Notes on Technical Writing – p.1/44
Read more

Technical Writing Lecture Notes | Technical Communication ...

Here are the notes of a lecture delivered on Technical Writing. I found it very interesting and wanted to share it with my readers because it gives yet ...
Read more

List of Free Online Technical Writing Courses and Training ...

People who searched for List of Free Online Technical Writing Courses and Training Programs found the following related articles, links, and information ...
Read more

Sentence Structure of Technical Writing

Sentence Structure of Technical Writing Nicole Kelley Program in Writing and Humanistic Studies @ MIT 2.671, Fall 2006 Lecture materials derived from The ...
Read more