Redesigned Help File with graphics and video

My work machine uses the program IZArc for compressing (zipping) and extracting archives. Some time ago, I was looking for some information in the Help File (a .chm file called “IZArc Help” that comes with the program) and noticed that it covered many topics but that the topics I was interested in (compressing and archiving) contained little useful information. Most of the topics could be considered “glossary” information rather than “help.” Furthermore, the entire Help File didn’t contain one graphic for procedures, or even a graphical overview of the user interface (UI).

What is a help system?

A help system is a reference document designed to assist users with learning how to use a product or feature. This form of documentation creates the least personal relationship between the writer and user. It is designed to be a quick way for users to find information about the program. Overall, a help system should help users get back to using the program quickly so they can accomplish whatever task they set out to do.

Regular users of software often need product support beyond a task-oriented procedure. This information is usually not needed on a daily basis, but must be easily accessible to users when they need to complete task. The use of context-sensitive help in the form on a built-in help system is typically the “first line of help” for a user.

Using graphics and video in context-sensitive Help Files

Along with my previous video tutorial showing the step-by-step procedure for archiving and password protecting files, I created a sample Help File that covered what I believe would be the most important topics about which a user of this program would want more information. Additionally, I included many UI and procedural images and for the most common procedure, I embedded a video tutorial for opening an existing archive.

How to view the sample Help File

The procedures used in the Help File are based on version 3.81 build 1550 using Microsoft Windows XP. I used RoboHelp 8 to create the .chm.

IZArc Help File -- Properties window

You have to “Unblock” non-native CHM files to view them on your computer

Viewing a .chm Help File that didn’t come with software requires a few extra steps:

  1. Click the following link to my Google Drive folder, click “folder contents”, and then click “Download”.
    IZArc_Help_Fer.chm
  2. After saving the file to your computer, right-click it and click Properties.
  3. At the bottom of the default General tab, click Unblock and then click Apply.

Side-by-side comparison

Original IZArc Help File

“After” IZArc Help File

 

*This project was completed in collaboration with Joseph Sass at Minnesota State University, Mankato.

Advertisements

1 Comment

Filed under How-to, Technical Writing

One response to “Redesigned Help File with graphics and video

  1. Pingback: Report: Usability testing of the MnOnline website | ferswriteshoe

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s