Tech Writing
- 2. What is Technical Writing? Taking complicated subject matter and transforming it into easy-to-understand information for the reader.
- 3. 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
- 4. 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
- 5. 1. Define the Project Who will read the document? Executives System Analysts Clients Operators
- 6. 1. Define the Project What’s the Style? Persuasive Motivational Instructional Procedural Historical
- 7. 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
- 8. 1. Define the Project What resources are available? Time People Equipment
- 9. 2. Estimate Project Hours Estimated time includes: Research Interviews Information Entry Document Design Revisions
- 10. 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
- 11. 3. Retrieve, analyze & synthesize Organize your sources Subject Matter Experts (SMEs) Existing documentation Software testing Internet research In-house resources Library
- 12. 4. Design Project Tools The Chicago Manual of Style RoboHELP Visio Inspiration MS Word Framemaker
- 13. 5. Write Writers write They sit with information and tools. . . . . . and they write.
- 14. 6. Edit & Revise the Document The content is reviewed & edited for: Accuracy Clarity Consistency Conciseness Usefulness Organization Style Format Grammar, Spelling Punctuation
- 15. 7. Deliver The Project It’s well thought-out & edited Tailored to the customers needs A reflection of comprehensive methodology