ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel
  • »
  • Technology»
  • Computers & Software»
  • Computer Software

Great End User Documentation Tools for Documenting Your Software

Updated on July 9, 2010
Create searchable HTML Help documentation for your end users with these useful end user documentation tools
Create searchable HTML Help documentation for your end users with these useful end user documentation tools

When creating software applications it's a great idea to create documentation so that end users know how to use your new application.

Traditionally software documentation used to take the form of a printed manual to accompany the software's disks or CD-ROMs. Nowadays there's a whole load of delivery options for end user documentation, including:

  • Printed manuals
  • Adobe Acrobat (PDF) manuals available for download or on CD/DVD
  • Microsoft Word or RTF documents
  • Online website help
  • Wiki's
  • Company Intranets
  • Windows Help Files (HTML Help .chm files)

It can be hard to keep all these different sources of documentation up to date, especially if the software often has essential product updates and new releases.

Popular End User Documentation Tools

End user documentation tools are application software packages for creating application help. Popular end user documentation tools include: RoboHelp, Doc-To-Help and WinCHM. There are many other end user documentation tools but which one you choose will largely depend on your budget as well as your requirements.

Adobe's RoboHelp is a sophisticated help authoring tool and is a great choice if you want ot publish your help documentation to many different media such as those listed above. RoboHelp is the closest thing that the user documentation industry has to a standard application for creating help files.

Doc-To-Help can import Word or HTML format documentation and output high quality end user documentation in a variety of different documentation formats including HTML Help, Adobe Acrobat PDF, Microsoft Word, WinHelp, JavaHelp and Help 2.0. Being able to create printed and online documentation means that it has a huge range of flexible output options. It's also possible to use Doc-To-Help to produce customised versions of documentation for different end users. This is a nice feature as it means that you'd be able to create different end user documentation for novice users and power users!

Most documentation software solutions are designed to be easy to use by a range of people including software developers, managers and dedicated technical authors.

A Free End User Documentation Tool

If you have a low (or no!) budget then Microsoft's HTML Help Workshop is available as a free download from the Microsoft website. I've used it to create my own end user documentation for my own shareware applications. It's perfectly capable of building basic HTML Help .chm files for Windows applications. However it can be hard to create good .chm files from heavily customised HTML.

The HTML Help .chm file compiler is also buggy and it can be extraordinarily difficult to pinpoint what HTML is causing the problem. The nice thing about .chm files created with HTML Help Workshop is that they are fully searchable by the end user, and it's also possible to build an index so that users can find important information about your product.

Good luck with writing your end user documentation.

Comments

    0 of 8192 characters used
    Post Comment

    • profile image

      JOhn RIce 6 years ago

      We prefer http://www.helpiq.com for our help documentation, and help authoring. The tool works great and it is free for the basic version.

    • Dobson profile image

      Dobson 8 years ago from Virginia

      Nice presentation of this topic. Welcome to hub pages and keep writing.

    • romper20 profile image

      romper20 8 years ago from California

      I really enjoyed this hub, you nailed the points.

      A+ hub.

      Romper20

    • thevoice profile image

      thevoice 8 years ago from carthage ill

      great detailed hub read thanks

    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)