Help Sections

Since tutorials are usually viewed by novices, you'll likely need to include instructions to help users find their way around. Obviously, the items contained within a help section depend largely on your tutorial and who is using it.

Since many people are already familiar with the way Web browsers work, Web-based tutorials often require far less help text than other types of training programs. In fact, a simple explanation of goals and procedures at the beginning of the tutorial should suffice. Again, this depends on your users.

This section provides some sample help sections I have written, which will hopefully give you an idea of the types of items you should include in your own help sections. This section includes a Text-Based Help Section and an Audio Help Section.

Text-Based Help Section

This section shows you how to navigate through (your program here). During this tutorial, you will perform tasks or watch as actions are performed for you.

At the bottom of each screen, text appears in red. This indicates an action you must perform.

The buttons you will use to control the program appear on this navigation panel.

When a button is not used, it does not appear on the navigation panel.

Certain items are highlighted:
A green box indicates information, such as the control buttons above.

A flashing red box indicates an item you can click, such as the forward button.

The help button brings up this screen.

The return button takes you back to the current lesson.

The chapter menu brings up this list of chapters.

The lesson menu button brings up the list of lessons.

The find button allows you to search for specific topics.

The quit button exits the program.

The back button returns you to the previous page.

The forward button advances you to the next page.

Lessons are displayed on a menu. Select a lesson by clicking it.

You should view lessons chronologically, but you can access any lesson at any time.

Each screen shows your current location in the program:

Congratulations! You now know how to use this program.

Audio Help Section
Narrator: Let's take a look at how to use (your program here).

A list of chapters is displayed on this menu. Click a chapter to select it. A lesson menu appears. To begin a lesson, click it.

It is recommended you complete lessons in chronological order. However, you can access any lesson at any time.

I'll always show your location in the program. This icon and the first title show which chapter you're on. The second title shows the lesson.

The meter bar measures your progress through a topic.

During this tutorial, you'll perform specific actions, or watch as I perform those actions for you.

Tasks you must perform will appear on this action bar.

A red box indicates an item you must click.

A green box highlights information.

The control buttons you will use during this program appear on this navigation panel.

The “quit” button exits the program. When you select quit, a dialog box appears. Select the “Yes” button to return to the desktop. Anytime you reenter the program, I'll display your previous location.

Click the “find” button to search for a specific topic.

Click the “help” button. This screen explaining the navigation buttons appears.

The “chapter menu” button displays this list of the chapters.

The “lesson menu” button displays a list of the lessons for the current chapter.

Click the “pause” button to pause the lesson

Click the “back” arrow to move back a page in the topic and select the “forward” arrow to move ahead a page. Sometimes, I'll ask you to perform an action instead of clicking the “forward” button.

Click the “skip” button to move to the next topic.

If a button is not used, it will not appear on the navigation panel.

At the end of each lesson, I will ask you questions about the material we've covered. Answer multiple choice questions by clicking the correct answer. Other questions may ask you to click an item or perform an action.

Congratulations! You now know how to use this program.

| Home | Introduction | Multimedia 101 | History |
| Terminology | Web Writing | Reference |
| Scripts | Instructional Text | Testing | Help Sections |

Mailbox

© 1996 Atomic Rom Productions