Technical Writing Methodology 101
What is Technical Writing? <ul><li>Taking complicated subject matter and transforming it into easy-to-understand informati...
What do Tech Writers create? <ul><li>User’s manuals </li></ul><ul><li>System manuals </li></ul><ul><li>Step-by-step proced...
The Process. . . .  <ul><li>1. Define the project </li></ul><ul><li>2. Estimate project hours </li></ul><ul><li>3. Retriev...
1. Define the Project <ul><li>Who will read the document? </li></ul><ul><ul><li>Executives </li></ul></ul><ul><ul><li>Syst...
1. Define the Project <ul><li>What’s the Style? </li></ul><ul><ul><li>Persuasive </li></ul></ul><ul><ul><li>Motivational <...
1. Define the Project <ul><li>What type of document do you need? </li></ul><ul><ul><li>Printed reports </li></ul></ul><ul>...
1. Define the Project <ul><li>What resources are available? </li></ul><ul><ul><li>Time </li></ul></ul><ul><ul><li>People <...
2. Estimate Project Hours <ul><li>Estimated time includes:  </li></ul><ul><ul><li>Research </li></ul></ul><ul><ul><li>Inte...
2. Estimate Project Hours <ul><li>Document Item Estimate </li></ul><ul><li>  (hrs/item) </li></ul><ul><li>By the page 8-12...
3. Retrieve, analyze & synthesize <ul><li>Organize your sources </li></ul><ul><ul><li>Subject Matter Experts (SMEs) </li><...
4. Design Project <ul><li>Tools </li></ul><ul><ul><li>The Chicago Manual of Style </li></ul></ul><ul><ul><li>RoboHELP </li...
5. Write <ul><li>Writers write </li></ul><ul><ul><li>They sit with information and tools. . .  </li></ul></ul><ul><ul><li>...
6. Edit & Revise the Document <ul><li>The content is reviewed & edited for: </li></ul><ul><ul><li>Accuracy </li></ul></ul>...
7. Deliver The Project <ul><li>It’s well thought-out & edited </li></ul><ul><li>Tailored to the customers needs </li></ul>...
Upcoming SlideShare
Loading in...5
×

Tech Writing

1,272

Published on

technical writing

Published in: Education, Business
1 Comment
0 Likes
Statistics
Notes
  • Be the first to like this

No Downloads
Views
Total Views
1,272
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
137
Comments
1
Likes
0
Embeds 0
No embeds

No notes for slide

Tech Writing

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

    Clipping is a handy way to collect important slides you want to go back to later.

×