Monday, July 2, 2012

Technical Writer's Toolbox

Technical Writing at the end of the day is not only about writing, but writing effectively (for the reader to grasp). So, to facilitate this need, there are several documentation tools available in the market. If you want a comprehensive list to get an idea about list of tools available, please refer the following link:

http://www.writersua.com/surveys/tools12/index.html

But, the problem with the list is that it does not segregate information as per usability. Traditionally, there are two different output formats readers expect their documentation viz. Printed (Adobe PDF) and Online (HTML Help). So, I will distribute various tools based on their expertise to generate specific output.
There are many other output formats like CHM, Wiki, HTML Help, eLearning videos, etc. Apart from that there are various enhancements tool used extensively in technical documentation.
Printed Publishing – Provides authoring and publishing PDF options
  • Adobe PDF
  • Microsoft Word
  • Adobe Framemaker
  • MadCap Flare
  • WebWorks
  • Author-IT
  • DITA Open tool kit
  • XMetal
Online Publishing – Provides authoring and HTML publishing options (Also supports CHM and HTML Help)
  • RoboHelp
  • Madcap Flare
  • Dreamweaver
  • Frontpage
  • Doc-To-Help
Wiki – Provides interactive and collaborative environment where multiple authors can contribute
  • Atlassian Confluence
  • Microsoft SharePoint
Image Enhancement tools – Provides image enhancements facilitation
  • Corel CorelDraw
  • Techsmith SnagIT
  • Adobe Photoshop
  • Madcap Capture 
eLearning Tools – Provides environment for creating video tutorials for eLearning
  • Madcap Mimic
  • Adobe Captivate
  • Techsmith Camtasia 

There are specific XML editing tools like XMetal and DITA which are currently beyond the scope of this post. On the whole, all these tools are used extensively by various technical writers based on their company’s discretion or their personal choice.  

1 comment:

  1. Nice post. Please elaborate more on these tools and also on how tech writing is essential for everyone - BAs, developers etc. and how some of these tools can help do that.

    ReplyDelete