Technical Writing_An Introduction

3,573 views

Published on

Published in: Technology, Business, Education
0 Comments
3 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
3,573
On SlideShare
0
From Embeds
0
Number of Embeds
23
Actions
Shares
0
Downloads
378
Comments
0
Likes
3
Embeds 0
No embeds

No notes for slide

Technical Writing_An Introduction

  1. 1. Technical Writing An Introduction By: Tamanna
  2. 2. <ul><li>Understanding the target audience for a document, analyzing what information they need and determining how best to deliver it. </li></ul><ul><li>Presenting and Communicating complex technical information in simple language. </li></ul>What is Technical Writing?
  3. 3. Characteristics of Technical Writing <ul><li>Effective Writing should be: </li></ul><ul><ul><li>Clear </li></ul></ul><ul><ul><li>Concise </li></ul></ul><ul><ul><li>Correct </li></ul></ul><ul><ul><li>Complete </li></ul></ul><ul><ul><li>Consistent </li></ul></ul><ul><li>This can be achieved by: </li></ul><ul><ul><li>Appropriate Word Choice </li></ul></ul><ul><ul><li>Clear Sentence Structure </li></ul></ul><ul><ul><li>Coherent Paragraphs </li></ul></ul><ul><ul><li>Logical Progression of Paragraphs </li></ul></ul>
  4. 4. <ul><li>Make Sure to Use </li></ul><ul><ul><li>Simple words </li></ul></ul><ul><ul><li>Clear sentences </li></ul></ul><ul><ul><li>Coherent paragraphs </li></ul></ul><ul><li>Ensure </li></ul><ul><ul><li>Consistency </li></ul></ul><ul><ul><li>Conciseness </li></ul></ul><ul><ul><li>Objectivity </li></ul></ul><ul><ul><li>Accuracy </li></ul></ul><ul><li>Watch out for </li></ul><ul><ul><li>Acronyms, abbreviations, and jargon </li></ul></ul><ul><ul><li>Slangs and foreign words </li></ul></ul><ul><ul><li>Biased language </li></ul></ul>Characteristics of Technical Writing (Contd…)
  5. 5. <ul><li>Define the project </li></ul><ul><li>Retrieve, analyze & synthesize </li></ul><ul><li>Design the document </li></ul><ul><li>Write the document </li></ul><ul><li>Edit/Revise the document </li></ul><ul><li>Deliver the document </li></ul>Process of Technical Writing
  6. 6. <ul><li>Who will read the document? </li></ul><ul><li>What’s the Style? </li></ul><ul><li>What type of document do you need? </li></ul><ul><li>What resources are available? </li></ul>Define the Project
  7. 7. <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>Library/Books </li></ul></ul>Retrieve, Analyze, and Synthesis
  8. 8. <ul><li>Tools </li></ul><ul><ul><li>The Microsoft Style Guide </li></ul></ul><ul><ul><li>RoboHELP </li></ul></ul><ul><ul><li>Framemaker </li></ul></ul><ul><ul><li>Captivate </li></ul></ul><ul><ul><li>Visio </li></ul></ul><ul><ul><li>Quark Express </li></ul></ul><ul><ul><li>MS-Word </li></ul></ul>Design the Document
  9. 9. Write the Document <ul><li>Write the document </li></ul><ul><li>Review the document </li></ul><ul><li>Send document to the subject-matter expert (SME) for technical review </li></ul><ul><li>Incorporate the SME comments </li></ul>
  10. 10. <ul><li>The content is reviewed & edited for: </li></ul><ul><ul><ul><li>Accuracy </li></ul></ul></ul><ul><ul><ul><li>Clarity </li></ul></ul></ul><ul><ul><ul><li>Consistency </li></ul></ul></ul><ul><ul><ul><li>Conciseness </li></ul></ul></ul><ul><ul><ul><li>Usefulness </li></ul></ul></ul><ul><ul><ul><li>Structure </li></ul></ul></ul><ul><ul><ul><li>Style </li></ul></ul></ul><ul><ul><ul><li>Format </li></ul></ul></ul><ul><ul><ul><li>Grammar, Spelling </li></ul></ul></ul><ul><ul><ul><li>Punctuation </li></ul></ul></ul>Edit and Revise the Document
  11. 11. <ul><li>Deliver the document in the form of: </li></ul><ul><ul><li>Integrated documents </li></ul></ul><ul><ul><li>Printed Documents/Reports </li></ul></ul><ul><ul><li>CDs </li></ul></ul><ul><ul><li>Books </li></ul></ul><ul><li>The delivered documents must be tailored to the customers needs </li></ul>Deliver the Document
  12. 12. What do Tech Writers create? <ul><li>User’s Manuals </li></ul><ul><li>Installation Guide </li></ul><ul><li>On-line Help </li></ul><ul><li>API Manuals </li></ul><ul><li>Training Manuals </li></ul><ul><li>Quick-reference Guides </li></ul><ul><li>Release Notes </li></ul><ul><li>Catalogues </li></ul><ul><li>Brochures </li></ul>
  13. 13. Summary In a nutshell, this presentation included: <ul><li>The concept of technical writing </li></ul><ul><li>The characteristics of technical writing </li></ul><ul><li>The process of technical writing </li></ul><ul><li>Deliverables of technical writing </li></ul>
  14. 14. Thank You Happy Writing!!!

×