Accommodating Active Learners in Software Documentation Decisions  

Recent research focusing on a minimalist approach to computer software documentation has explored ways to design computer software tutorials and workbooks for users with an active learning style. The principles of minimalism and active learning styles, however, are less frequently applied to traditional reference manuals. This paper reviews several elements of minimalism and suggests ways to apply strategies for active learners to traditional reference manuals.

Smart, Karl L. STC Proceedings (1993). Articles>Documentation>Instructional Design>Software

Achieving Success with Intranet-Based Online Documentation  

To key to achieving a successful online documentation implementation on the intranet is to understand that the resulting system is indeed a 'system.' The need for well-written, formatted and structured documents is necessary but the interactive framework in which those documents exist is equally important. It is crucial to understand the role of each individual involved in the system from Reader to Author and I.T. provider.

Frost, Edward D.J. STC Proceedings (2001). Design>Documentation>Intranets>Web Design

Adding User Annotations to Help Topics

This article discusses a feature called User Annotations, whereby users can add their own custom notes to Help topics, and presents a method for implementing it in web pages or in HTML Help topics.

Gash, Dave. WritersUA (2002). Design>Documentation

Advantage of a Rainy Summer

This article deals, despite the title above, with aspects on handling and checking of technical documentation. I consider these aspects as part of the functionality of documentation besides more conventional functionality such as factual correctness, layout, combination of figures and text.

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

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

Applying Object-Oriented Design Concepts to Web Publishing  

This is a story of how one internal project at Sun Microsystems migrated printed user and reference documentation to an internal Web site. The principle architect of this site discusses how she applied object-oriented design concepts to the Web architecture to accommodate many learning styles simultaneously. As important as the successes of this project are its failures, which offer some insight into when and how to use the World Wide Web as a communication vehicle in your overall communication strategy.

Hoft, Nancy L. STC Proceedings (1996). Design>Documentation>Web Design

Applying the Sensation-Perception Continuum to User Documentation  

The sensation-perception continuum represents the interplay of sensation and perception in everything we think and do. Technical communicators must exploit this continuum by understanding and applying sensory filters and perceptual tendencies in the design and development of information. This paper discuss three sensory filters: thresholds, cocktail-party effect, and sensory adaptation; it discusses four perceptual tendencies: perceptual set, figure-ground relationships, laws of grouping, and goodness of figures.

Coe, Marlana A. STC Proceedings (1996). Articles>Documentation>User Centered Design

Applying Web 2.0 Technologies to Technical Documentation

This article is based on my presentation at the Institute of Scientific and Technical Communicators' annual conference in October, 2006. Every now and then, there is a change in the value of what technical authors deliver. These are moments when organisations pay attention to technical documentation. This is because they recognise that these changes mean they can create something that will be of real value to the business and to their customers. In recent years, there have been three "waves of interestingness". The first wave was the introduction of Windows Help (WinHelp). The second major wave was the introduction of the Internet and intranets. This was a time when organisations looked at how they could transfer large amounts of information from paper to online. They were faced with issues such as how users could access and understand all this information easily - issues that technical communicators deal with on a day-to-day basis. I believe we're just about to approach the new wave, which we have called "Tech Writing 2.0".

Pratt, Ellis. Cherryleaf (2006). Articles>Web Design>Documentation>Technical Writing

Automating Development Tasks for a Large-Scale Help System

Although tools like eHelp's® RoboHELP® Classic can speed up and streamline the process of creating help topics, there are still many repetitive tasks needed to build a WinHelp system that supports a large, integrated application. This article summarizes one of the techniques that Fredrickson Communications used to automate the process of developing online help topics. Once the underlying structure and macros were in place, we were able to generate hundreds of help topics at the rate 15-20 per minute.

Lindsay, Bill. Frederickson Communications (2002). Design>Documentation>Single Sourcing

Balancing Act: Keeping Your Screen Movies Small and Beautiful

Screen recordings are a valuable tool for enhancing training, tutorials, manuals and websites. Companies use this technique to produce streaming and downloadable content. The recording tools are readily available and affordable. In this article, we explore some techniques, tips and tricks for recording sound, mouse movement and happenings from your screen to an AVI file. We will talk in both general terms and use specific examples. The examples pertain to HyperCam, a downloadable screen recording application from Hyperionics Technology. Like most screen recording applications, HyperCam captures the action from your Windows screen -- including cursor movements and sound -- and saves it to an AVI movie file.

Rice, William H. IV. WilliamRice.com (2002). Design>Documentation>Multimedia>Screen Captures

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

Building a Better ReadMe    

Surveys and focus groups show that most software buyers use ReadMe files. Users primarily look to ReadMe files for information on software bugs. They identify the following ways that software manufacturers can improve their ReadMe files: 1) keep them short, 2) include a table of contents, 3) use hypertext, and 4) eliminate the need for ReadMe files. Along with these four improvements, this article discusses other ways to create quality ReadMe files that meet concrete user needs.

Johnson, Mark A. Technical Communication Online (1997). Design>Documentation

Building the Treasure House: Creating Knowledge Bases for the World Wide Web

What is a knowledge base? What are the components necessary to build one?

Massa, Jack A. STC Orange County (1998). Presentations>Documentation>Information Design>Databases

Building the Treasure House: Creating Knowledge Bases on the World-Wide Web  

Web knowledge bases offer an excellent platform for delivering technical documentation and customer support information. They also represent an area of great opportunity for technical communicators to expand their skills, satisfy their customers, and create value for their employers or clients. This session explores the components of a web knowledge base and the tasks involved in planning and building one.

Massa, Jack A. STC Proceedings (1998). Articles>Documentation>Online>Web Design

A Case of Exhaustive Documentation: Re-centering System-oriented Organizations Around User Need    

Braun Corporation's home-grown documentation processes served the organization well for its first 50 years as it grew from a local to a nationally-competitive producer of mobility and accessibility products. Now poised to become a global leader in its field, this corporation found its efforts hampered by ineffective and outdated documentation practices, which were hurting the company's competitive advantage. This article describes Braun Corporation's curious mixture of global reach and local isolation. By bringing in a technical communicator with expertise in user-centered design, Braun has begun reforming its formerly exhaustive documentation and communication practices. While technical communicators have incorporated a variety of strategies to develop user-centered and task-based documentation, less attention has been placed on changing the cultures of these organizations. The case presented here represents a shift from establishing documentation procedures to critically assessing and reforming existing procedures for the global workplace, describing the shift from ineffective and exhaustive processes to effective processes with defined goals and measurable outcomes. The article concludes with an inventory for determining whether other organizations are over-documenting processes and products, and offers suggestions for creating better documentation procedures.

Salvo, Michael J., Meredith W. Zoetewey and Kate Agena. Technical Communication Online (2007). Articles>Documentation>Management>User Centered Design

Communicating Design: Web Design Documentation

An overview of web design methods, including a survey of questions one should ask during the process.

Brown, Dan. SlideShare (2006). Presentations>Web Design>Documentation

Communicating Rapidly Changing Information  

When purchasing complex software products, users frequently receive large quantities of information; however, to use the product efficiently, they need a visually obvious starting point that helps them locate the specific information they need. With maintained With the quantity and diversity of information, customers need to be able to find the information they need without flipping through endless pages. In order to give the users a starting point in all of the printed and ASCII file information. we created a document entitled the Guide to products, users can use the features available with a new release most efficiently if they have an overview of the major changes to the product and to the information about the product. By using visual devices and creating an overview document. for each release, technical communicators can decrease their costs and increase users' productivity.

Bown, Jennifer and Connie M. Bibus. STC Proceedings (1993). Articles>Documentation>User Centered Design

Comparative User-Focused Evaluation of User Guides: A Case Study    

A comparative evaluation of two user guides,--the document traditionally used by a company and a model document designed on the basis of research results and recommendations,--was carried out using a number of complementary approaches focusing on the user. The quality and suitability of these documents for the target audience were assessed in terms of content, structure, presence of certain organizational devices (such as headings) and pictures included. The results revealed that the model document was more attractive, more efficient, and better adapted to users' needs, thanks to its modular organization (being structured according to "functions"), a large number of pictures, the presence of headings, and rationalization of the vocabulary used.

Ganier, Franck. Journal of Technical Writing and Communication (2007). Articles>Documentation>Assessment>User Centered Design

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

The Convergence of Web 2.0 with Help Documentation

This podcast talks about the convergence of web 2.0 with help documentation. It mentions examples of Web 2.0 sites, such as Flickr, Payscale, and Digg, and what help files need to incorporate these same Web 2.0 features.

Johnson, Tom H. Tech Writer Voices (2007). Design>Web Design>Documentation>Podcasts

Creating Documentation that Shows  

Advocates using screen shots, text balloons, arrows, and scannable text to create picture-like documentation.

Eaton, Janet M.F. Intercom (2000). Design>Documentation>Technical Illustration>Screen Captures

Creating User-Friendly Documentation

We often hear that users do not read documents. To lure readers into reading our documents, we must make documents user-friendly.

Bhatia, Neeraj. Indus (2002). Articles>Documentation>User Centered Design>Technical Writing

Customer Partnering: Data Gathering for Complex Online Documentation  

Technical communicators today must document complex applications used in complex environments. Information about users and use models is important under these conditions, especially if documentation will be presented online. Customer partnering, a method of information gathering that supplements surveys, contextual inquiries, usability testing, and interviews, provides a way of involving the users of complex applications in the design of information delivery systems. We used this method to help a client gather important information about user and use models and design a new information library for complex server computer systems.

Hackos, JoAnn T., Molly Hammar and Arthur Elser. ComTech Services (1997). Articles>Documentation>User Centered Design>Collaboration

Defining Information Architecture Deliverables

One of the hottest topics these days in Information Architecture circles is documentation. This is probably partly because the IA's role is so ill defined. Our jobs sit perched between engineering and graphic design: go too far in one direction, we're doing the coding, go to far in the other and we are doing the design. Neither role maximizes the architect's key skills; defining the organizational structure and behavior of the web site or application. An IA is most effective when they leave implementation and final graphic design out of the mix. The documents they create to express this have to be crafted with equal skill and diplomacy.

Wodtke, Christina. SitePoint (2001). Articles>Information Design>Documentation