IBM User-Centered Design for the Documentation Designer  

The user-centered design of documentation is an aspect of product design that has often been under-emphasized. Difficulties inherent in documentation design include obtaining user, feedback to high-level design objectives; extracting user. feedback specific to a product’s documentation. rather than to the product as a whole; and managing the various resource constraints inherent in product development. IBM User-Centered Design offers a solution to these difficulties by employing a set of user feedback methodologies from which the documentation designer, a member of a multidisciplinary design team, extracts pertinent data to set design objectives and follow through to low-level designs.

Righi, Carol and Lynn VanDyke. STC Proceedings (1996). Articles>User Centered Design>Documentation>Technical Writing

Ideas on Cooperation Between Suppliers and Users Regarding Documentation

Documentation, operators’ manuals, maintenance instructions, etc, can never be perfect and satisfy all users. The organization of the documentation, particularly for large systems, will never suit all users and there will always be some errors present. This means the supplier and the user need to cooperate in various ways to avoid the fatal consequences of errors and misinterpretations, and for the improvement of documentation over time.

Rullgård, Åke. TC-FORUM (2001). Articles>Documentation>User Centered Design

Improving Document Quality Through Customer Visits  

In an effort to improve the quality of our documentation, our Information Development department personally visited over 80 of our customers in 10 different locations across the United States. Our goal was to find out what we needed to do to create documentation that would satisfy our customers' needs. We came up with a process for planning our visits, gathering the information from our customers, implementing their requirements, and increasing communication with them. From the visits, we not only made changes that immediately satisfied our customers, but we created an environment for them to work with us as a team.

Lass, Laura W. and Wendy L. Reed. STC Proceedings (1993). Articles>Documentation>Quality>User Centered Design

Improving Documentation Through Customer Feedback: A Case Study  

By soliciting and receiving customer feedback, writers learn how customers use existing documentation and what additional information customers may need. In May 2001, we began a formal process of gathering customer feedback for the IBM WebSphere Commerce Suite product. The first phase of this process involved two main initiatives: creating and promoting a documentation questionnaire for customers; creating and working with an internal test team that acted as customers. Feedback allowed us to determine which information strategies helped customers meet their business needs, and which areas we need to concentrate on in future releases.

Heximer, Erin and Lisa Wu. STC Proceedings (2002). Articles>Documentation>User Centered Design

Increasing User Acceptance Of Technical Information in Cross-Cultural Communication    

A significant problem in technical communication is persuading the user that the information is accurate, valid, and useful. All too often, technical communicators treat users as members of their own culture. When authors do consider cultural issues, they often focus on matters such as vocabulary, visuals, and organization. Other strategies, however, can be useful in gaining acceptance of technical information in cross-cultural situations. For example, the communication theory of compliance-gaining offers suggestions for how the technical communicators can adapt the text to enhance user acceptance when communicating to members of their own culture as well as when communicating across cultures. Communicators can use promises, threats, demonstrate positive and negative outcomes, extend friendliness, etc., to develop the text. In this article, I will explain several compliance-gaining strategies authors can use, identify rhetorical strategies they can combine with compliance-gaining strategies, show how these strategies can be effective in a cross-cultural environment by comparing the strategies in two sample cultures, and analyze a brief sample.

Warren, Thomas L. Journal of Technical Writing and Communication (2004). Articles>Documentation>User Centered Design>International

It's Not Enough to Say What it Does

All too often, developers think that documenting their new creations just means writing a detailed technical description of what it does. In a sense, they're explaining things to themselves. But what you really need to do is explain things to someone who's coming across your stuff for the first time.

McManus, Eamonn. Artima (2004). Articles>Documentation>User Centered Design

The Kind of Documentation Users Really Want

Have you ever asked your users what kind of training materials they want, or how they prefer to learn software? This kind of information is critical to figuring out what help deliverables to produce. But really when it comes down to it, there are only so many options — printed manuals, short guides, interactive flash guides, videos, online help, live training, reference cards, context-sensitive help, workbooks and exercises, or, usually the favorite, someone to stand by their computer and answer questions whenever they need help.

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

Let's Stop Writing Documentation and Start Working for the Users  

Nearly 20 years ago, the profession of technical communication began to focus on developing task-oriented documentation. Although task-oriented documentation has always been produced, particularly for consumer products, it was not the standard in the computer industry. More often, people writing about computer systems focused on the system rather than on the tasks people needed to perform. Systems-oriented documentation was the norm.

ComTech Services. Articles>Documentation>User Centered Design

Let's Stop Writing Documentation and Start Working for the Users  

Technical communication's long-time focus on task-oriented documentation has left customers with too many tasks and too much information; itï¿Âs time for a new approach. A user-centered approach reflecting a thorough understanding of users and how they engage the product is the surest route to effective documentation and training. To understand what users need, we need to get closer to them by spending time in their workplaces, watching them execute everyday tasks, and listening to them. Through this kind of ethnographic activity, we will become user experts, gaining credibility within our own organizations and our user communities.

Hackos, JoAnn T. STC Proceedings (1999). Articles>Documentation>User Centered Design

Little Machines: Understanding Users Understanding Interfaces    

This paper questions the ubiquitous practice of supplying minimalist information to users, of making that information functional only, of assuming that the Shannon-Weaver communication model should govern online systems, and of ignoring the social implications of such a stance. Help systems that provide fast, temporary solutions without providing any background information lead to the danger of users completing tasks that they do not understand at all. (Word will help us write a legal pleading, even if we have no idea what one is.) As a result, we have help systems that attempt to be invisible and to provide tool instruction but not conceptual instruction. Such a system presents itself as a neutral tool, but it is actually an incomplete environment, denying both the complexity and alternative (and possibly improved) modes of thinking about the subject at hand.

Johnson-Eilola, Johndan. Journal of Computer Documentation (2001). Articles>Documentation>User Centered Design>Usability

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

New Life for Product Documentation

Here are some 'truths' we've all heard: 'Documentation is just a band-aid for poor design.' 'Real users don't read manuals.' 'Super users never read anything.' 'Help doesn't.' But are they really true? I've seen some signs of life in the use of documentation for digital products recently.

Quesenbery, Whitney. UXmatters (2006). Articles>Documentation>User Interface>User Centered Design

Non-Fatal Errors: Creating Usable, Effective Error Messages

It's often easy to identify what kinds of error messages don't help users, but it can be tricky to avoid them, and even more of a challenge to create the opposite: error messages that give users a clear indication of the problem, offer information to help them fix it, and provide tips on how to avoid the same situation in the future. This paper details the steps involved in creating understandable, helpful error messages, and suggests ways of communicating the value of good error messages to managers and executives.

Wilska, Emily. WritersUA (2004). Articles>Documentation>User Centered Design>Online

On My Little Planet...

Nobody reads user manuals for pleasure. And yet we all make our living from them, and hope that what we produce is at least useful, if not actually enjoyable

Bardez, Jean-Paul. TC-FORUM (2000). Articles>Documentation>User Centered Design

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

Peaks and Pitfalls of Implementing a New Documentation Strategy  

In 1993, Compaq Computer Corporation ventured into a totally different market--the consumer market. Once known primarily as a company that manufactured high quality, expensive business computers through its elaborate dealer network, Compaq was faced with selling its units to consumers through retail outlets. As a result, the PC Marketing Communications department concluded that its current documentation set was not giving the students; retirees; homemakers; and small business owners, who work out of their home offices, the kind of information they needed to be productive. This led the department to the challenge of creating a new documentation set that would meet the needs of these new customers.

Clifton, Deborah, Deborah R. Crockett, Diana Jaques and Sharon B. Jones. STC Proceedings (1995). Articles>Documentation>User Centered Design

Reader-Centered Documentation Provides the Necessary Context    

A features-based approach to documentation is appropriate for reference manuals, where the goal is to provide information on something the reader already knows. This article explores how to meet the needs of the reader when providing documentation for user manuals.

Hart, Geoffrey J.S. Intercom (2007). Articles>Documentation>User Centered Design

Rethinking User-Centered Information Development  

Often in the computer industry there is a tendency to provide information about the features of a system. However, customers usually purchase the system based on knowledge of its features, when they receive the product they need information on how to accomplish tasks. Developing task-oriented information requires a shift in perspective from what the computer technology can do, to what your customers want to do with the technology. The resulting information must be usercentered rather than feature-driven. These types of customer requirements demand afresh development approach.

Stertzbach, Lori A. STC Proceedings (1995). Articles>Documentation>User Centered Design>Usability

Stop Writing Documentation!  

Redesign your information; write topics, not books.

Hackos, JoAnn T. ComTech Services (2001). Articles>Documentation>User Centered Design

Technical Writing in Everyday Life: One User's Experience

The experience of setting up a new home theater system also sharply reminded me of what it is like to look at something as a new user: staring at a bunch of knobs and holes for the first time, holding a tassel of wire in one hand and a manual in the other, and really just wanting the darn piece of ?%^%! to do what it's supposed to do.

Vedrody, Sarah. MetroVoice (2002). Articles>Documentation>User Centered Design>Technical Writing

User-Driven Documentation: From Usability Testing to User Guide  

Rockwell Software is a $90-million company specializing in plant automation software. Offices in West Allis, Wisconsin, and Mayfield Village, Ohio allow technical communicators to work closely with development teams to design, test, and release usable, consistent software and information products. While Rockwell Software’s information development process is a multi-faceted endeavor, this paper focuses on the following three steps we implement to create our information products: interviewing customers to establish information guidelines, conducting usability tests, and writing Getting Results guides.

Butler, Scott A., Jennifer L. Giordano and Myron M. Shawala III. STC Proceedings (1999). Articles>Documentation>User Centered Design>Usability

Using Customer Data to Drive Documentation Design Decisions    

This article shows how user-centered design can be applied to documentation and reports the results of a two-year contextual design study. The article (1) demonstrates how contextualdesign can be applied to information and (2) reports some of the study's results,outlining key insights gleaned about users. The study found that users vary widely intheir information needs and preferences. Users employ a variety of learning strategies inlearning new software and in overcoming problems encountered within applications.Documentation can better meet variances in learning styles and user preferences whentightly integrated into applications, accessible in the user's own language. Additionally,documentation is most beneficial when several assistance options exist for users tochoose among, varying according to context, task, and user need. Finally, the article discussesthe constraints that affect the implementation of design ideas and explores implicationsfor practice and additional research.

Smart, Karl L. and Matthew E. Whiting. Journal of Business and Technical Communication (2002). Articles>Documentation>User Centered Design

Using Customer Inquiries as a Basis for Revising and Editing User Manuals  

The Documentation Development Department (DDD) of Hitachi has been improving manuals by collecting, classifying, and analyzing inquiries from its customers to the Hitachi Customer Answer (HCA) Center. The HCA Center is a telephone inquiry center established to give quick and clear answers to inquiries from customers who use Hitachi computers.

Masuda, Tadashi. STC Proceedings (1994). Articles>Documentation>User Centered Design

What Do Manuals Say About Your Company?  

According to the Consumer Electronics Association, product returns represent a $10 billion-dollar-a-year problem for the consumer electronics industry. Technical support costs are spiraling (even with the migration to off-shore providers) while consumer satisfaction with this support is plummeting. New technology and expanded offerings to a stabilized market are increasing competition. What can manufacturers do to help combat these problems? Better consumer manuals are a start.

Manual Labour (2003). Articles>Documentation>User Centered Design