ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel

Help authoring tools

Updated on July 12, 2013

Help authoring tools (HATs) are specialized authoring environments that technical writers use to create and maintain technical documentation in a time-efficient way. Technical documentation is often delivered in multiple formats: printed manuals, user guides, knowledge bases, procedures and nowadays very often via online web help.

Technical writers often closely work together with development teams, and are responsible for translating technical jargon into clear and concise end-user-friendly documentation. In order to do so technical writers need to possess didactical skills and have to be able to think as end-users do when they will be using the product.

Help authoring tools often provide the following features:

  • An integrated WYSIWYG (=what you see is what you get) or WYSIOO (=what you see is one option) editor. Preferably an authoring tool should store content as XML. XML provides the advantage of being able to separate content from format and is ideal for single sourcing / repurposing content.
  • Possibility to convert legacy content (=often companies have a lot of existing documentation in the form of MS Office Word files or HTML files) into the help authoring tool.
  • Support multi-lingual content: If your documentation needs to be translated to multiple languages, you will need a tool that supports Unicode. Some help authoring tools provide sophisticated export and import options and allow you to sent content out to Computer-assisted translation (CAT) management tools, that make use of translation memory to lower translation costs, maintain consistency and increase translation quality. Other tools will allow you to translate content in the authoring environment using a two pane view. Some tools combine both.
  • Single sourcing: has made it possible to write content objects only once, reuse these content objects many times and allow technical authors to generate different output formats (HTML, PDF, CHM, WinHelp, DOC) from this single source.
  • Web-based team authoring & delivery: Some help authoring tools have evolved over the years from desktop help authoring tools, where an isolated author writes and stores all the content on a desktop, to a CMS where geographically dispersed authors can collaborate, store content in a database and make ready-to-go content accessible on the web. End-users can consult this published content (=web help) via the web in real time using their browsers. Delivering help & documentation via the web has the big advantage that it is a lot easier to provide up-to-date content to your audience.

Important aspects to consider when selecting a help authoring tool

Selecting a help authoring tool is not only about picking a tool with a rich feature-set at the best possible price. There are other aspects that might be equally if not more important to take into consideration:

  • Long term costs: How much are you willing to pay for training, support and software upgrades?
  • Platform-independent: Is the authoring tool next to Windows also compliant with Mac and Linux operation systems?
  • Ease of managing content from creation till destruction, delivering, versioning and updating content.
  • Collaboration possibilities: Can authors and other colleagues work together from different locations? If team-authoring matters to you, it becomes even more important to go for a very intuitive easy-to-use tool.
  • Vendor lock-in: It might be important to keep in mind that one day your company might decide to move to another help authoring tool at that moment all content will have to be migrated.
  • Software as a service: These days some web based help authoring tools are offered as SaaS by means of cloud-computing subscription model. This might be interesting for some companies since this means the software is installed, hosted, maintained, upgraded by the software vendor. It is the software vendor who also makes sure that your content is backed-up and secure. SaaS allows companies to start using the help authoring software immediately while keeping their initial investment low.

Shortlist of Help authoring tools

What follows is a high level market overview of authoring tools for creating, managing and delivering product documentation to your customers. The tools listed are capable of single sourcing your content to printed and online documentation (often referred to as web help).

  1. 4.ST - HelpServer : http://www.helpserver.eu
  2. Author-it: http://www.author-it.com/
  3. Doc-to-Help: http://www.doctohelp.com/
  4. DR. Explain: http://www.drexplain.com
  5. Flare Madcap: http://www.madcapsoftware.com/products/flare/overview.aspx
  6. Help & Manual: http://www.helpandmanual.com
  7. RoboHelp: http://www.adobe.com/products/robohelp.html

Useful conferences for technical writers

The following conferences are geared towards technical writers. The conferences listed host informative sessions:

USA

Europe

Comments

    0 of 8192 characters used
    Post Comment

    • profile image

      Andy Beckhum 

      2 years ago

      Hi there,

      Loved the article. Very informative and clearly explained.

      I was just curious if you have checked ProProfs Knowledge Base Software:

      http://www.proprofs.com/knowledgebase/

      It is a fully hosted SaaS help authoring tool that has all the important features you mentioned such as:

      WYSIWYG editor

      Multi-lingual support

      Single sourcing

      Multiple import feature - MS Word docs, text version etc

      Collaboration tools such as version control, workflows and conditional content

      Low-cost and pay as you go option.

    working

    This website uses cookies

    As a user in the EEA, your approval is needed on a few things. To provide a better website experience, hubpages.com uses cookies (and other similar technologies) and may collect, process, and share personal data. Please choose which areas of our service you consent to our doing so.

    For more information on managing or withdrawing consents and how we handle data, visit our Privacy Policy at: https://hubpages.com/privacy-policy#gdpr

    Show Details
    Necessary
    HubPages Device IDThis is used to identify particular browsers or devices when the access the service, and is used for security reasons.
    LoginThis is necessary to sign in to the HubPages Service.
    Google RecaptchaThis is used to prevent bots and spam. (Privacy Policy)
    AkismetThis is used to detect comment spam. (Privacy Policy)
    HubPages Google AnalyticsThis is used to provide data on traffic to our website, all personally identifyable data is anonymized. (Privacy Policy)
    HubPages Traffic PixelThis is used to collect data on traffic to articles and other pages on our site. Unless you are signed in to a HubPages account, all personally identifiable information is anonymized.
    Amazon Web ServicesThis is a cloud services platform that we used to host our service. (Privacy Policy)
    CloudflareThis is a cloud CDN service that we use to efficiently deliver files required for our service to operate such as javascript, cascading style sheets, images, and videos. (Privacy Policy)
    Google Hosted LibrariesJavascript software libraries such as jQuery are loaded at endpoints on the googleapis.com or gstatic.com domains, for performance and efficiency reasons. (Privacy Policy)
    Features
    Google Custom SearchThis is feature allows you to search the site. (Privacy Policy)
    Google MapsSome articles have Google Maps embedded in them. (Privacy Policy)
    Google ChartsThis is used to display charts and graphs on articles and the author center. (Privacy Policy)
    Google AdSense Host APIThis service allows you to sign up for or associate a Google AdSense account with HubPages, so that you can earn money from ads on your articles. No data is shared unless you engage with this feature. (Privacy Policy)
    Google YouTubeSome articles have YouTube videos embedded in them. (Privacy Policy)
    VimeoSome articles have Vimeo videos embedded in them. (Privacy Policy)
    PaypalThis is used for a registered author who enrolls in the HubPages Earnings program and requests to be paid via PayPal. No data is shared with Paypal unless you engage with this feature. (Privacy Policy)
    Facebook LoginYou can use this to streamline signing up for, or signing in to your Hubpages account. No data is shared with Facebook unless you engage with this feature. (Privacy Policy)
    MavenThis supports the Maven widget and search functionality. (Privacy Policy)
    Marketing
    Google AdSenseThis is an ad network. (Privacy Policy)
    Google DoubleClickGoogle provides ad serving technology and runs an ad network. (Privacy Policy)
    Index ExchangeThis is an ad network. (Privacy Policy)
    SovrnThis is an ad network. (Privacy Policy)
    Facebook AdsThis is an ad network. (Privacy Policy)
    Amazon Unified Ad MarketplaceThis is an ad network. (Privacy Policy)
    AppNexusThis is an ad network. (Privacy Policy)
    OpenxThis is an ad network. (Privacy Policy)
    Rubicon ProjectThis is an ad network. (Privacy Policy)
    TripleLiftThis is an ad network. (Privacy Policy)
    Say MediaWe partner with Say Media to deliver ad campaigns on our sites. (Privacy Policy)
    Remarketing PixelsWe may use remarketing pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to advertise the HubPages Service to people that have visited our sites.
    Conversion Tracking PixelsWe may use conversion tracking pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to identify when an advertisement has successfully resulted in the desired action, such as signing up for the HubPages Service or publishing an article on the HubPages Service.
    Statistics
    Author Google AnalyticsThis is used to provide traffic data and reports to the authors of articles on the HubPages Service. (Privacy Policy)
    ComscoreComScore is a media measurement and analytics company providing marketing data and analytics to enterprises, media and advertising agencies, and publishers. Non-consent will result in ComScore only processing obfuscated personal data. (Privacy Policy)
    Amazon Tracking PixelSome articles display amazon products as part of the Amazon Affiliate program, this pixel provides traffic statistics for those products (Privacy Policy)