the studio of
saul
carliner

content development
for the workplace

e-learning

ideas and
issues

A Brief Guide to Communication Products Used in Online Learning

In this List

"Advertisements"
Celebrations
Coaches and Advisors
Contests
Cue Cards
Demos (also called Guided Tours)
Gaming-Simulations
Help
Job Aids and Quick References

Newsletters
References
Specialized Troubleshooting Procedures
Support Groups
Tips of the Day
Tutorials
User’s Guides
Wizards

"Advertisements"

Description: Promotions of various aspects of a product or service. Often appears inside the front or back covers of a publication, or on the screens displayed by an application when users start or install it.

Situations in Which User Consult this Type of Communication Product:

Users do not consult this type of information; they receive it while performing other activities.

What Users Expect in this Type of Communication Product:

Writing Style:

Communication Medium Used: Online and print

Example: Messages about a product as you install it on your hard drive.

Top

Celebrations

Description: Ceremonies and observances intended to build morale. In some cases, observances may recognize participants for past achievements. In other cases, observances build a positive attitude among new users. A celebration may be as simple as a ribbon or plaque to acknowledge a certain achievement or as elaborate as a party.

Situations in Which User Consult this Type of Communication Product: When users’ feelings play a key role in the acceptance of new products, policies, procedures, or ideas and when many of those users can be gathered in a single place at a single time.

What Users Expect in this Type of Communication Product:

Communication Style:

Communication Medium Used: Live with follow-up by e-mail or newsletter.

Top

Coaches and Advisors

Description: Online tools that assist users with cognitive (intellectual) tasks. Examples of coaches include:

Situations in Which User Consult this Type of Communication Product: The user must make a decision and wants the access to expert advice or the organization feels that the advice of experts can be coded into a program so that workers with less experience can make decisions.

Users are often in the midst of making the decision when they consult the coach, so they have little time for extensive "teaching" as the system coaches them.

What Users Expect in this Type of Communication Product: Partial or full assistance with the decision. Prompting with scripts to be read when appropriate.

Writing Style:

Communication Medium Used: Online

Examples:

Top

Contests

Description: Motivational tool intended to build interest or attention to a subject. For example, an organization might run a contest that rewards a department for reaching certain levels of safety or for levels of usage for a new computer system.

Situations in Which User Consult this Type of Communication Product: When provided with a meaningful incentive.

What Users Expect in this Type of Communication Product:

Writing Style:

Communication Medium Used: Print for instructions and notification, other media as appropriate to promote the contest.

Top

Cue Cards

Description: Instructions that tell users how to perform a task and that are displayed by the system one step at a time and that might visually resemble a cue card.

Situations in Which User Consult this Type of Communication Product:

When they are not familiar with a procedure but want to learn it, such as the first times a user has performed a given procedure or the first time the user has performed procedure after a long period of time.

What Users Expect in this Type of Communication Product:

Writing Style:

Communication Medium Used: Online

Top

Demos (also called Guided Tours)

Description: A trial version of a product that includes a scaled-down version of its features and functions and that provides users with a "tour" of the product. The tour may be "narrated" or may be self-running. Usually, demos provide users with an opportunity to try certain aspects of a product.

Situations in Which User Consult this Type of Communication Product:

What Users Expect in this Type of Communication Product:

Writing Style:

Communication Medium Used: Online, live.

Example: Visit Hello Brain and click on Quick Tour.

Top

Gaming-Simulations

Description: Learning experiences that replicates the central characteristics of complex situations (that’s the simulation) and that let users experience the consequences of decisions made in that situation (the gaming aspect). Examples of gaming-simulations include:

Situations in Which User Consult this Type of Communication Product:

What Users Expect in this Type of Communication Product:

Writing Style:

Communication Medium Used: Online, live.

Example: Sim City.

Top

Help

Description: a special type of user’s guide for software that is available to users online as they use software applications.

Situations in Which User Consult this Type of Communication Product:

Users consult help in these types of instances:

What Users Expect in this Type of Communication Product:

  • Help (what a high level of expectation when the system cannot interrogate the user)
  • Offers, at the least, these types of information:
    • "What’s this help," which explains the various elements of a screen and tells users how to respond
    • "How do I" help, which provides step-by-step instructions for performing tasks
  • Offers, at the most, these additional types of information:
    • Examples and demonstrations, showing users how to perform specific tasks and the likely results
    • Tips and techniques, that quickly acquaint users with aspects of the software that they might not have otherwise noticed
    • Cue cards, which display, one instruction at a time, the instructions for performing tasks
    • Wizards, which automatically perform tasks for users, except for those parts in which users must make choices (for example, a wizard can automatically create a meeting agenda, but might prompt users to choose the appearance of the agenda and to type the names of participants in the meeting)
  • Access to online tutorials (which I describe in a later section)

To find information in help, users consult:

  • Contents, which lists the major sections within help; some communicators group these by types of information, such as reference information and examples and demos, rather than subject, such as installing and troubleshooting
  • "Search for help on," which acts like an index in that it lets users type in the term they seek information about, then displays all of the index entries that mention that term
  • Index, which lets users scan through the entire index
  • Links, which let users directly "jump" from one topic to a related one by clicking on a highlighted term; links are sometimes called hyperlinks because the technology used to link topics so that users can move among them without going through an index or table of contents is called hypertext

Ideally, when users display instructions for performing a task, those instructions should be visible to users as they perform the task. This is called stay-on-top help because the text "stays on top" of the screen when users perform the task.

Writing Style: Much like that of a user’s guide. Because the information is displayed online, however, technical communicators should make generous use of visuals. This might be difficult, however, because many organizations are restricting the use of visuals in help to limit the size of help files.

Communication Medium Used: Online

Example: Click on Help in any Windows or Mac application.

Top

Job Aids and Quick References

Description: A technical communication product intended to give users a brief refresher of a training module on the job. Job aids also go by the name quick references. Examples include:

  • A Post-ItÒ

    note with the name of a commonly used command and placed on the side of a computer screen
  • An audiotape that summarizes the key points of a day-long training seminar in 12 minutes
  • A laminated card or poster with a list of the 10 most commonly used commands
  • A poster in a fast food restaurant bidding employees to be swift and courteous

Situations in Which User Consult this Type of Communication Product:

  • In the middle of a task
  • When they need a quick reminder about a key point.

They might locate the job aid or, in many instances, find the job aid already available.

What Users Expect in this Type of Communication Product: to contain cryptic, but meaningful, reminders.

Writing Style: Terse, almost to the point of seeming incomplete. The physical design of job aids is usually imaginative, ranging from pocket-size cards that users can carry with them anywhere and mouse pads that have key messages written on them and that users can see any time they sit by their computer to audiotapes that users can play in their car on the way to work.

Communication Medium Used: Print, online, live, audio.

Example: See the posters for making sandwiches in fast food restaurants.

Top

Newsletters

Description: contains a collection of articles and provides ongoing communication with a target group. For example, a product newsletter provides ongoing contact with the customers who have already purchased a product. An employee newsletter provides ongoing contact with the employees in a department or within an entire organization.

Situations in Which User Consult this Type of Communication Product: Users usually receive newsletters when the receive their mail; they might skim the newsletter at that time and, if they any interesting articles, read those at a later time.

Generally, users read in depth those articles that help them address an immediate need or provide them with a much needed skill.

What Users Expect in this Type of Communication Product: Varies, depending on the nature of the newsletter.

  • A newsletter whose primary purpose is maintaining contact with existing customers might suggest additional ways of using existing products, highlights of new products and, if customers have contact with the staff, profiles of people whom customers might deal with.
  • A newsletter that is intended to provide the users supported by a technical support group might provide answers to them most common questions, tell users about new software available to them and provide profiles of the members of the technical support team.

For all newsletters, users expect regular placement of certain information in each issue of a newsletter. For example, one financial newsletter always publishes a table with current exchange rates on the next to last page. Users who want this information immediately turn to it.

Writing Style: varies, depending on the purpose of the article. In general, technical communicators use a persuasive, informative style and write in the second person.

Communication Medium Used: Printed or online.

Examples:

Top

References

Description: An encylopedic listing of all major topics on a particular subject. A telephone directory reference. So is the Physician’s Desk Reference, as are the programming references provided with software. Programming references list all of the commands that programmers can use to create their own applications using that software.

Situations in Which User Consult this Type of Communication Product:

To look up specific piece of information. The subject might be broad, such as all of the commands used for copying information or all the medications used to treat influenza. The subject might be tightly defined, such as the use of global characters with the DOS command, diskcopy, or the side effects of a certain influenza vaccine on patients with pacemakers. Users generally do not read references in their entirety.

What Users Expect in this Type of Communication Product:

  • Comprehensive coverage of a subject, with every major topic listed and thorough descriptions within each. For example, if a programming language has 118 commands, users expect listings for each. If doctors have access to 1 089 drugs, they expect their reference to describe all 1 089 of them.
  • Alphabetic listing. User expect the reference to begin with A and continue to Z.
  • Expect everything about the topic. If, for example, a particular command has 7 options, users expect the reference to describe all 7. Similarly, if a drug has 6 side effects, users expect the reference to describe all 6.
  • Examples and illustrations to explain concepts.

In addition, users have specific expectations for certain types of references. For example, users expect programming references to include a description of the command, a diagram showing the syntax¾

structure¾

of the command, a description of each parameter with the command and the options available for each parameter, an comprehensive discussion of considerations for use, and examples of commands that handle particular situations.

Writing Style: direct, explanatory, and terse. In fact, references often use sentence fragments and lists to present information. They generally do not give step-by-step procedures; communicators expect users to integrate the information and determine for themselves how to use it. Communicators expect users of most technical references to have a certain level of technical expertise and use technical terminology. However, because many users might not be familiar with the terms, communicators also provide definitions of the terms, at the least, within a sentence and, at the most, in a glossary.

Communication Medium Used: Print, online.

Examples:

  • Programming references.
  • Physician's Desk Reference.
  • Encyclopedias.

Top

Specialized Troubleshooting Procedures

Description: a special type of instruction manual that tells trained service representatives how to repair a piece of equipment or how to resolve a problem with software. Service representatives usually receive training in how to use troubleshooting procedures. The service guide for a computer is an example of a service guide. The repair manual for a washing machine is also an example of a troubleshooting procedure.

Situations in Which User Consult this Type of Communication Product: are usually working in challenging circumstances. Their clients have usually tried, without success, to resolve the problem on their own. The broken equipment or the non-functioning software usually brings business to a standstill, and they often pay for the service representative’s time, so the clients of the service representative are anxious for the service representative to resolve the problem as quickly as possible.

What Users Expect in this Type of Communication Product:

  • Procedures helping them to isolate the problem and, once isolated, instructions on how to fix the problem. Users do not expect explanations of the problem; most of them have sufficient technical knowledge to determine that on their own.
  • Illustrations, if they would be useful in isolating and resolving the problem. For example, users of a hardware service guide might appreciate illustrations of the parts of the hardware, so that they can match the parts they see with their names and purposes.

Service representatives generally expect to receive training in using troubleshooting procedures. Many such communication products use unique formats that are not, on first glance, intuitive, but have proven extremely effective with their users. To make most effective use of this training, many organizations follow a standard format for all troubleshooting procedures.

Writing Style: directive writing style that extensively uses technical terminology.

Communication Medium Used: Print, online, live, audio.

Top

Support Groups

Description: Groups of people facing a similar challenge and who benefit from sharing individual problems. Sometimes are self-run, other times are led by an outside facilitator.

Situations in Which User Consult this Type of Communication Product:

  • When using complex software
  • When handling complex interpersonal situations

What Users Expect in this Type of Communication Product:

  • Compassionate facilitator
  • Open format that allows each person to describe problems (if any)
  • Regular meetings
  • Confidentiality

Communication Medium Used: Live, online "chats."

Examples:

Top

Tips of the Day

Description: A tip about something that is not required for basic use, but the knowledge of could increase the productivity of the user.

Situations in Which User Consult this Type of Communication Product: As an option presented:

  • At the beginning of the day (or when the user starts the program)
  • As a refresher (the user originally may have received the tip at a time when it wasn’t needed, but now has that need)

What Users Expect in this Type of Communication Product:

  • Brief
  • Limited to one topic at a time.
  • Cover a broad range of issues over a period of time:
  • Primarily cover procedural topics
  • Also concepts
  • Delivered at the beginning of the day.
  • Lets users turn off tips
  • Lets users easily refer back to tips

Writing Style:

  • Terse, no more than 3 - 5 lines.
  • Answers the question: "Did you know"
  • Provides instructions if they are brief (no more than 2 or 3 steps).
  • Refers users to appropriate sources for instructions that exceed 2 or 3 steps.
  • Tailor to needs of different users.
  • Ideally, offer a scratch pad to which users can copy relevant tips for future reference.

Communication Medium Used: Online (either through e-mail or when user starts the application)

Examples: See opening screen in Quicken.

Top

Tutorials

Description: A lesson, or series of lessons, that are intended to develop a skill that users can immediately use.

Situations in Which User Consult this Type of Communication Product: A variety of reasons. In some instances, they’re told to. For example, employees may be required to take training about a new company policy or to fulfill a legal requirement (the reason for most safety training). In some instances, users take tutorials to know how to perform a task in a more instructive way than might be found in a procedures manual or online help. Examples include users consulting commercial books about software, such as Windows for Dummies, to learn how to backup systems and tutorials provided with spreadsheets that teach users how to use formulas. In still other instances, users take tutorials to learn about an entire subject, such as tutorials on CD-ROM about career management and workbooks about preparing taxes.

What Users Expect in this Type of Communication Product: Users expect the following material in a tutorial:

  • At the beginning of a lesson, users expect:
    • A brief description of the purpose of the lesson (about 30 to 50 words)
    • A list of skills users will develop (take them directly from your content objectives)
    • Prerequisite skills and knowledge
    • Length of time needed for the lesson, so they can decide whether they have sufficient time now or need take the lesson later
  • In the lesson, users expect:
    • Clear explanations of concepts and procedures
    • Practical examples of the skills
    • Opportunities to apply the new skills through
    • Active involvement in the learning process, through exercises, simulations, questions, and other techniques
  • At the end of the lesson, users expect:
    • Descriptive summary, that repeats the main points they should remember
    • Glossary, which defines new technical terms presented in the tutorial

To find information in a tutorial, users consult:

  • Table of contents (or, for online tutorials, the menu of lessons)
  • Running headers and footers
  • Forward and backward buttons to reread information they already seen.

In some instances, users prefer that you recommend a sequence through the tutorial and do not give them alternate methods of going through it. In other instances, users prefer to have total control over their movement through the tutorial.

Writing Style: The writing style for tutorials is persuasive, because the tutorial needs to motivate users to take an interest in the subject matter, as well as clear and involving, in which users understand the material presented and how it relates to them, and feel actively involved in the lesson. Finally, the style should be polite, though direct, like that of a good teacher with a student.

Communication Medium Used: Online (called computer-based training), printed, classroom, video, audio.

Top

User’s Guides

Description: a "how-to" communication product that tells typical users how to perform the most commonly performed tasks with a product or service. User’s guides are typically printed.

Situations in Which User Consult this Type of Communication Product: in two instances:

With an immediate need, either to find out how to do something, whether a particular task is possible, or why something isn’t working as expected. In such instances, users only consult a small section of the information product.

To become familiar with the product. In such instances, users read entire sections or read the communication product in its entirety.

What Users Expect in this Type of Communication Product:

  • Something to acquaint them with the product, such as a picture of the product or a "tour" of features
  • Installation or setup instructions
  • Instructions for performing the most common tasks (and if a task can be performed many ways, descriptions of just one or two of those ways)
  • Instructions for tailoring¾

    customizing¾

    the product
  • Instructions for troubleshooting

In some instances, users expect advanced tips and techniques.

To find information in a user’s guide, users consult:

  • The table of contents to find a particular chapter
  • Running headers and footers, which are printed at the top (header) or bottom (footer) of the page or screen and that provide the page number and the name of a section or communication product, to help pinpoint the exact page
  • Headings and subheadings to locate particular information on a page
  • Charts and tables to locate specific facts
  • Glossary to locate definitions of unfamiliar terms
  • Index to locate specific topics; for users looking for specific facts, this is often the first part checked

Users expect user’s guides to be written in the second person and expect a polite, direct writing style. They expect instructions to be written in the imperative mood, that is, as directions, and they expect lists of materials needed, examples, and definitions when appropriate. Users of user’s guides tolerate some technical jargon, but prefer no more than necessary.

Writing Style: to be written in the second person and expect a polite, direct writing style. They expect instructions to be written in the imperative mood, that is, as directions, and they expect lists of materials needed, examples, and definitions when appropriate. Users of user’s guides tolerate some technical jargon, but prefer no more than necessary.

Communication Medium Used: Online and printed.

Top

Wizards

Description: An online "agent" that automatically performs a task for users, only prompting users when they must make a decision. When users are prompted to make decisions, the system should have a backup choice.

Situations in Which User Consult this Type of Communication Product:

  • To perform once-in-a-lifetime or similarly rare tasks
  • To perform tasks that intimidate users

What Users Expect in this Type of Communication Product:

  • To be shielded from the complexity of the process
  • To make simple decisions within their realm of knowledge, such as entering their name or choosing the style of the finished product
  • A limited number of steps (no more than 10)
  • Well-chosen defaults

Writing Style:

  • When presenting instructions: directive, such as "do this"
  • When presenting choices: a therapists’ sensitivity, "would you prefer..." rather than "you should..."
  • Only use plain language; avoid technical terminology unless absolutely necessary or the audience has the training to understand it

Communication Medium Used: Online.

Example: (Reservation requests on Travelocity)

Top

Home

other resource websites by saul carliner
models, processes, and techniques of information design | the commerce of content |

(c) Copyright. 2001, 2002. Saul Carliner. All rights reserved.