Product Reviews

Automated Help Documentation

RoboHelp Office X3: This first-rate help authoring tool gets better.

After writing about the new RoboHelp a few issues ago, I put it through its paces last month. I looked at the "Office" edition of the product, which combines Microsoft Word-based and HTML help editors. I spent most of my time in the HTML help version, since I was working on help files for a .NET-based product.

What it boils down to is that if you can write, you can produce help files using RoboHelp. All of the messy stuff -- help compiler locations, the exact build steps, all that junk -- is safely hidden from the author. Building a table of contents, adding topics, and making them look pretty, is as easy as it would be with any other HTML editor. Then you go through a simple build process and voila, help comes out of the other end.

One of the nice things here is multiple version support from the same source files. I found it very simple to create both a standalone HTML help file and Web-based help from a single project. There are other available types, including printed documentation and Java-based help, and you can generate multiple versions in a single step with the "batch generate" capability. It's easy to flag content to appear conditionally in certain output types as well.

As you would expect with a help product, the help files and tutorial here are first-rate. There are a variety of tips and other in-product help as well. The only thing that I wished for and couldn't find was a way to integrate the final build step with my build process. This would require a command-line way to launch the batch generate process, and if that's in there, I couldn't find it. But in all other ways, this is a streamlined way to create the help files that any product should have before it ships.

About the Author

Mike Gunderloy, MCSE, MCSD, MCDBA, is a former MCP columnist and the author of numerous development books.

Featured

  • How To Use .CSV Files with PowerShell, Part 1

    When it comes to bulk administration, few things are handier than .CSV files. In this two-part series, Brien demos his top techniques for working with .CSV files in PowerShell. First up: How to create a .CSV file.

  • SameSite Cookie Changes Rolled Back Until Summer

    The Chromium Project announced on Friday that it's delaying enforcement of SameSite cookie changes, and is temporarily rolling back those changes, because of the COVID-19 turmoil.

  • Basic Authentication Extended to 2H 2021 for Exchange Online Users

    Microsoft is now planning to disable Basic Authentication use with its Exchange Online service sometime in the "second half of 2021," according to a Friday announcement.

  • Microsoft Offers Endpoint Configuration Manager Advice for Keeping Remote Clients Patched

    Microsoft this week offered advice for organizations using Microsoft Endpoint Configuration Manager with remote Windows systems that need to get patched, and it also announced Update 2002.

comments powered by Disqus

Office 365 Watch

Sign up for our newsletter.

Terms and Privacy Policy consent

I agree to this site's Privacy Policy.