Showing posts with label robohelp. Show all posts
Showing posts with label robohelp. Show all posts

Tuesday, August 21, 2012

Building your Portfolio - Part 2

If you are planning to shape your career as a freelance writer or actively searching a full time position, you may want to employ a broader paradigm to your portfolio. More often than not, recruiters and interviewers look for web presence that helps them understand candidate’s writing skills. So, instead of highlighting your Facebook or Twitter page, you may demonstrate your skills by your blog or website.

 
There are many things you can add to your blog or website apart from your resume. For example,
  1. You can put samples of your portfolio on your website. You have better chances of showing your versatility as a website does not limit you to submit limited samples (as most interview sessions do). For more about samples, see Building your Portfolio -1.
  2. You can generate HTML help pages (using RoboHelp or Flare) for demonstrating your knowledge of tools.
  3. Emphasize that you are aware of latest trends in the technical communication by building articles on the topics that you have studied or have come across on the forums and other blogs (Please create original content from the knowledge you have gathered. Plagiarism is simply unacceptable for writers.)
  4. You can add samples of eLearning videos to your website as well. One of the innovative ways of creating eLearning videos can be the walk-through of your own website. You can create a small tutorial showing how someone can optimally find information on your website.
  5. You can also create generic user documentation templates like user guide, online help, table of contents, index, glossary, etc.
 Other General Tips: 
  • Try to keep your portfolio relevant and updated. 
  • Study your portfolio thoroughly. You can be thrown any question based on it. 
  • Never reveal proprietary information in your portfolio. If you insist on it, always seek prior permission from the content owners.
  • Always try to keep your website organized and clutter free.
  • Your blog should be categorized well so that the reader can find relevant information easily.
Please leave your comments so that I can keep improving this blog.

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.