Your SlideShare is downloading. ×
Technical Writing_An Introduction
Upcoming SlideShare
Loading in...5
×

Thanks for flagging this SlideShare!

Oops! An error has occurred.

×

Introducing the official SlideShare app

Stunning, full-screen experience for iPhone and Android

Text the download link to your phone

Standard text messaging rates apply

Technical Writing_An Introduction

2,753
views

Published on

Published in: Technology, Business, Education

0 Comments
2 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
2,753
On Slideshare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
237
Comments
0
Likes
2
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide

Transcript

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