Apple Guide Complete: Designing and Developing Onscreen Assistance

If you've been waiting to give your users more than just onscreen reference information, now you can with Apple Guide, Apple Computer's innovative help delivery system. With Apple Guide, you can produce guide files that actually lead users, step by step, through complex tasks and concepts. If you want to provide task-oriented, context-specific instructions, Apple Guide gives you the ease and flexibility to do so. You'll learn about the complete cycle of designing, scripting, and coding guide files in the four parts of this book.

Apple Inc. (1996). Design>Documentation>Help

Beyond Software Manuals and On-line Help: Interactive Help

Software user guides have traditionally provided assistance when the user requested help. Context-sensitivity enabled help systems to predict the most appropriate topic to present. For Windows applications, the move from Microsoft WinHelp to the new Microsoft HTML Help format allows user instructions to be presented in the same window as the application. This offers technical authors some extraordinary opportunities to provide intelligent, predictive, interactive help without the user having to request it. In this paper, we will explore one of the first such interactive help systems (for the Archivist e-mail archiving software), and see where the technology is moving.

Self, Tony. HyperWrite (2003). Articles>Documentation>Interaction Design>Help

Constructing a One-Stop "Answer Station" Website for Software Users

The web allows us to easily provide updated documentation to our users, but why stop there? There is more to making users successful quickly than just providing documentation. By creating a complete 'Answer Station' that is accessible from the application or product, we can not only direct users to that updated documentation, but we can also provide information about technical support, consulting, training, sales, etc. This article discusses writing a proposal for an Answer Station, determining content, working with other departments to gather information, designing the site, making that design work with an existing corporate website, dealing with tool issues, and finally, going live.

Bleiel, Nicoletta A. and Beth A. Williams. WritersUA (2004). Articles>Documentation>Web Design>Help

Designing Embedded Help to Encourage Inadvertent Learning    

What do we do when a legacy help system has trained the users not to use it? How do we design a solution that not only lures users back to the user assistance, but also encourages users to learn more about the product? This article follows the decision-making process of a design team that had to solve these problems. Additionally, the design team had to craft solutions for an application that imposed extreme limitations on those solutions, both in help system implementation and information design.

Mobley, Karen L., Clinton Knight and Timothy Meserth. Technical Communication Online (2003). Design>Documentation>Help

Designing for Interactivity: Role Models, Guides, and Coaches  

This paper presents three methods of user assistance: role models (simple demonstrations), guides (structured walk-throughs), and coaches (active assistants). After a brief introduction, potential uses, available development tools, and additional information sources are discussed for each method.

DeLoach, Scott. STC Proceedings (1998). Articles>Documentation>Help>Interaction Design

Designing Help Text

In an ideal world help text would be unnecessary - users would never get stuck in an application or site. It should be enough to provide clear design, carefully chosen titles and labels for the various functions, appropriate field prompts when user entry is required, helpful feedback, a glossary, and 'embedded' help such as default values, example input, on-screen step-by-step instructions and explanatory text next to fields or functions. Help features should certainly be a last resort. Anyone embarking on adding it to an application or site should be sure that they have already followed the best practise listed above. In most cases (certainly online) a help option should not be necessary.

Farrell, Tom. Frontend Infocentre (2001). Design>Documentation>Help>Online

Developing an Embedded Help Solution    

As we grow up, we learn to develop our independence and to ask for help less and less. No wonder that, when confronted with a problem, so few users click the Help button. Standard help systems have several common issues: help is separate from the product; users have to leave the task they are performing to get help, and they return and try to remember what they were doing; users cannot find the required information; users get lost in the help.

Mueller, Paul. Technical Communication Online (2003). Design>Documentation>Help

Developing Help for the Web: Designs, Trends, Strategies  

Zubak reviews the current state of Web-based help technology. Her article prepares technical communicators for upcoming challenges in this increasingly important field.

Zubak, Cheryl Lockett. Intercom (2001). Design>Documentation>Help

Document to the Question: Understanding What Users Ask and Where They Look for the Answers  

The user's idea of the problem is often very different than the help or program designer's. The online help topics often reflect the designer's viewpoint, not the user's.

STC India (2003). Articles>Documentation>User Centered Design>Help

From Online Help to Integrated User Assistance: One Company’s Journey Beyond the Online Help Paradigm  

For usability’s sake, the development group at Strohl Systems created a navigational coach that embedded user assistance within the company's flagship product. Now we're redesigning the product and building it around the user assistance.

Marion, Craig. STC Proceedings (1999). Design>Documentation>Help

Help Strategies and Their Effect on Graphical Icon Usage

An increasingly popular component of modern graphical human-computer interfaces are graphical command buttons. Studies have shown that graphical command buttons can enhance user productivity. However, two factors, the time required to acquire a working knowledge of the graphical command set and the need for frequent use to maintain the knowledge limit the effectiveness of graphical command buttons as a user interface strategy. This study attempts to quantify the effects of four types of help (balloon style, a mouse documentation line at the bottom of the screen, a help browser, and hardcopy documentation) on the ability of novice users to acquire a working knowledge of a graphical command set. The study did not find any significant difference (based on the anova and manova tests) between the four treatments.

McAlister, Britt and Chavi Greengart. SHORE (1997). Design>Documentation>Human Computer Interaction>Help

Interactive Help: Adapting Content for Multiple Users  

Most online help systems present a 'one-size-fits-all' solution—fixed content for each topic—but users’ experience levels and backgrounds are complex and diverse. Users lose time and patience sifting through topics that either do not match the problem a user is trying to solve, or that present information that does not match a user's knowledge level. A group of Masters students at Carnegie Mellon University tackled this problem. As a course project, the team created an online help prototype that contains different levels of help, a prototype that gives users a choice about how much information they want to see.

Downs, Christina M. and Anne F. Jackson. STC Proceedings (2001). Design>Documentation>Online>Help

An Introduction to Embedded Assistance  

Everyone hates help, right? Why? Help is inherently reactive, anticipating users' failure rather than providing information when users need it--before they fail. Print documentation, further from the user’s task at hand, is even more guilty of these sins. This paper presents an overview of embedded assistance, describing the current help paradigm and why it's failing and the basics of embedded assistance, as well as the technologies and infrastructure and the skills and knowledge you need to develop effective embedded assistance.

Ames, Andrea L. STC Proceedings (2002). Design>Documentation>Help>Embedded

Making Help More Human, and Other Discussions

Discusses a number of trends in the technical writing world, particularly the need to make help more human by adopting conversational tones and addressing the angry/frantic state of the user.

Johnson, Tom H. and Heidi Hansen. Tech Writer Voices (2007). Articles>Documentation>User Centered Design>Help

The Narrative User Interface  

Only a small percentage of users open Help, and they usually do that only when they have trouble with the application. One way to reach a broader audience is to integrate assistance into the user interface so that people understand the product as they use it. This paper describes our reasons for moving in this direction, provides examples of integrated user assistance, and discusses issues and concerns inherent in moving away from traditional Help.

Raiken, Nancy, Diane Stielstra and Richard Bloch. STC Proceedings (1998). Design>Documentation>User Interface>Help

Online Help: Beyond Error Messages  

Knoth-Weber describes how her company developed an efficient means to collect customer feedback about system errors and publish solutions on their Web help page.

Knoth-Weber, Lieselotte. Intercom (2002). Design>Documentation>Help

Online-Dokumentation aus Anwendersicht  

Benutzerinstruktion muß sein. In Form von Online-Documentation ist sie unmittelbarer Teil des Programms.

von Obert, Alexander. Techwriter.de (1998). Articles>Documentation>User Centered Design>Help

The Return to Content in Help Design  

Zubak discusses four trends she has observed in the content development of online user assistance.

Zubak, Cheryl Lockett. Intercom (2003). Design>Documentation>Help

Strategies for Producing Browser-Based Technical Documentation

This Technical Note attempts to provide a few good strategies for resolving some of the issues around producing and viewing Web-based technical documentation. The Note may be useful for engineers, technical writers and content producers who must wrestle with issues of producing documents such as ReadMe files, Release Notes, technical articles, and other forms of technical communication that land on the Web.

Apple Inc. (1996). Design>Documentation>Help>Online

Tips for the Help Developer: Reliability Testing  

Walstad presents a process for reliability testing in the development of help systems. She offers tips for ensuring reliability in each of the three steps: designing, planning, and testing. This article includes a list of online resources.

Walstad, Catherine M. Intercom (2000). Design>Documentation>Help

Where is the Instruction in Online Help? Designing it Right the First Time  

One of the ironic things about online help systems is that they are very often not helpful and even increase the user's frustration and stress level. A consequence of this increased frustration sometimes results in the rejection of the software. One solution is to increase the effectiveness of online help systems by designing them from an instructional design perspective. Some of the things we can provide users include: imperative, task-focused procedures; graphic feedback; access to redundant instructions; links to tutorial practice; philosophical and conceptual explanations for “why” they are completing specific tasks.

Pratt, Jean A. STC Proceedings (1997). Presentations>Documentation>Instructional Design>Help

Users Read Help Manuals Like an Encyclopedia, Not a Novel

Users turn to help to look for a specific question, just as someone consults an encyclopedia for a specific question. No one reads the entire encyclopedia/manual, nor is anyone expected to. Well-written encyclopedias allow users to find information through indexes, tables of contents, alphabetical organization, and search fields.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>User Centered Design>Help

Progressive User Adoption

User assistance can add value to a product or Web service’s business model by influencing how deeply users adopt new features or services. As more products employ pay-as-you-go models like that of SaaS (Software as a Service), the contribution user assistance makes becomes increasingly more important.

Hughes, Michael A. UXmatters (2009). Articles>Documentation>User Centered Design>Help

Calling Accessible Context-Sensitive Help with Unobtrusive DOM/JavaScript: A Help Authoring Guide

This Fast Track tutorial demonstrates two methods to call Context-Sensitive Help in a Web Form. We'll discover how Unobtrusive DOM/JavaScript achieves the desired result in calling Context-Sensitive help, and demonstrate how to keep the Structure, Presentation, and Behavior layers of a web page completely separate from one another ensuring good practice with current web standards and accessibility rules.

Palinkas, Frank M. helpware.net (2009). Articles>Web Design>Documentation>Help