Friday, June 08, 2007

Types of Documents created by Technical Writer
  • API Guides
  • User Guides
  • Concept Guides
  • Database Guides
  • Developer's Guides
  • Installation Guides
  • Reference Guides
  • Release Notes
  • Implementation Guides
  • Quick Reference Guides
  • Administration Guides
  • Online Help Systems
  • Interactive Media
  • Training Materials
  • Maintenance Guides
  • Troubleshooting Guides
  • White Papers
  • Patch Release Notes
  • Data Sheets
  • Glossaries

Verticals where Technical Writers are required:

  • Aviation
  • Biotechnology
  • Building & Public Utility
  • Consulting/Professional Services
  • Defense
  • Educational Institutions
  • Shipping
  • Financial Institutions
  • Government
  • Hardware and Software
  • Healthcare
  • Insurance
  • Internet
  • Nonprofit Organizations
  • Shipping Ports
  • Telecommunications
  • Pharmaceuticals

How does Technical Writer help the industry?

  • Reduce costs of providing technical support if the instructions are well written.
  • A well-writtten document helps convince a prospective customer.
  • It helps avoid/reduce costly product redesigning.
  • Other team members such as QA/Testing can concentrate on other tasks as opposed to spending time on validating incomplete documents.

Tools that Techncial Writer Use

Authoring Tools:

  • Adobe FrameMaker
  • MS Word
  • Adovbe Dreamweaver
  • WebWorks Publisher
  • Adobe Robohelp

Imaging Tools

  • Microsoft Visio
  • Paintshop Pro
  • Adobe Photoshop
  • SnagIT

Style Guides

  • Microsoft Manual of style guide
  • Chicago manual of style guide

No comments: