Authoring for Electronic Delivery  

Caterpillar is dramatically changing the way technical, product support information is authored. Book paradigms have been replaced by the more granular Information Element (IE) approach. The new integrated environment utilizes Unix based, TCP/IP connected, ECALS compliant tools on multi-tasking author workstations. Research data, in-process work approved IE's and relational indices are distributed to work group servers. Application software tools include a graphics editor and an interactive, context sensitive, SGML text editor. The environment is managed by a robust file management system that provides file tracking, revision control, workflow sensitive tool launching, burden planning and management reporting capabilities.

Hudson, Dave. STC Proceedings (1993). Articles>Documentation>Online>Help

Browse Sequence in Online Help  

A browse sequence enables users to navigate through a series of help topics in the sequence established by the help author. Although often omitted from help systems, the browse sequence is useful and will become essential as print documentation diminishes. Effective design options for a browse sequence include multiple segments, rings, branching, and the use of a browse button to take the user to the first topic in the current segment of the browse sequence.

Farkas, David K. and Bruce R. Gibbs. STC Proceedings (1994). Articles>Documentation>Online>Help

"By the Way, We Also Want Online Help"  

This presentation describes a strategy to meet a last-minute enterprise demand for online help for a software application program. We established design standards for writing online help, developed a process for gaining consensus from the project team on the content of the online help, and wrote the online help. We accomplished this in less than four months-a task that originally seemed impossible.

Davis, Herbert S. and Meryl Natchez. STC Proceedings (1994). Articles>Documentation>Online>Help

Cherryleaf Survey: Uptake of New Help Trends

During March and April 2003, Cherryleaf carried out an online survey into the current trends in technical communication. One of the questions we asked was: Do the online user assistance documents produced by your organization contain the following advanced capabilities?

Cherryleaf (2003). Articles>Documentation>Help>Online

Choosing and Using Help Topics

This paper describes some common types of help topic and when to use each. Different applications require different mixes of help topics. Choose the topic types that are appropriate for the application you are documenting.

Hollis Weber, Jean. Technical Editors Eyrie (1999). Articles>Documentation>Online>Help

Comparison of HTML Produced by Several Help Authoring Tools (HATs)

Recently, there was a lively discussion on the Help Authoring Tools and Techniques (HATT) mailing list about the relative compactness and efficiency of the HTML code produced by various Help authoring tools. As a result of these discussions, several industry consultants decided to collaborate on a project to compare the HTML, CSS, and CHM files produced by a variety of Help authoring tools.

Knopf Online. Articles>Documentation>Online>Help

Constructing a One-Stop "Answer Station" 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 paper 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. STC Proceedings (2004). Articles>Documentation>Help>Online

Creating a Hypertext Help System for a GUI-Based Client/Server Application  

We are currently in the second phase of development of a large Windows online help system. This paper reviews the major decisions we had to make during the first phase of the project, and lists some project evaluation results that have helped us plan for subsequent phases.

Asher, Betsy, David E. Lasecke and John Wenstrom. STC Proceedings (1994). Articles>Documentation>Online>Help

Customer Support on the Web

Customers avoid web-based customer support if information is not relevant, out of date or hard to find. Without a business commitment to addressing these issues, customers will continue to prefer contacting a service representative by phone.

Szuc, Daniel and Gerry Gaffney. Apogee (2005). Articles>Documentation>Help>Online

The Death of Paper Manuals

I'll pay $20 for a manual. I'd even pay $30-40 for a manual (grudgingly...). But $65 for a manual that should be in the damn box to begin with? Sorry... NO.

DealMac (2003). Articles>Documentation>Online>Help

Delivering Training and Support Using Windows Help  

The Windows Help utility is familiar as a tool to provide context-sensitive and procedural help for people using a software application, but it also a highly effective tool for providing many kinds of desktop-based training and support within an organization. During this session, we look at a variety of systems built using Windows Help and explore why this was a good choice for the particular project.

Deaton, Mary M. STC Proceedings (1997). Articles>Documentation>Online>Help

Design Checklists for Online Help

Online help systems have evolved over the past 20 years to meet the needs of our users. Designers must consider the content, format, presentation, navigation, and access methods of online help systems. A series of design checklists based on the past 20 years of research are presented in this paper, which summarizes a journal article currently being considered for publication. The latest trend in online help system design is embedded user assistance, which includes integrating information into the interface and including an embedded help pane within that interface to display a context-sensitive online help system.

Corbin Nichols, Michelle. WritersUA (2004). Articles>Documentation>Help>Online

Designing a Software User Assistance System

This article looks at a methodology for developing a software user assistance (UA) system in a structured manner. The software UA system could have both paper-based user manuals and online help systems.

Ferris, Tamara. Indus (2006). Articles>Documentation>Online>Help

Developing HTML Documents and Help System  

This document explains necessary tips for providing product information in digital form, giving specific examples of choosing the suitable media, classifying information, appropriate linking, file organization, etc. through our experience (in Fuji Xerox Co., Ltd.) during the development of the software product called Web PrintVision.

Ito, Sachi. STC Proceedings (1998). Articles>Documentation>Online>Help

Developing Online Help for OS/2 Applications  

One of the biggest problems facing Help developers is that of providing users with adequate methods of navigation through what can be huge amounts of information. After more than a two or three jumps, users can find themselves in topics that might be useful, but with no clear indication of how they got there or how to return to where they started. OS/2 gives the Help developer extraordinarily flexible tools for creating online documentation that can prevent this situation and provide users with a clearer path through online information than many other platforms can provide. However, this enhanced usability is not without its cost.

Radecki, Steven Lewis. STC Proceedings (1993). Articles>Documentation>Online>Help

Developing Online Help in Lotus Notes  

If you are a technical writer or manage technical writers and have been asked to document Lotus Notes applications, this workshop will give you a jump start. You can use the features available in Notes to create an effective help system as a Notes database. This help database can either be a view in an existing Notes application or a stand-alone database linked to the application. In this workshop, you will learn the basics of creating help systems in Lotus Notes.

Gross, Jacqui, Faye Smith and Steve Charles. STC Proceedings (1998). Articles>Documentation>Help>Online

Developing WebHelp: What 'How to' Design Doesn't Always Tell Us  

Development of the Intranet application STAR.IDN for requesting and receiving medically related supplies illustrates a broad spectrum of technological and user issues. As such it serves as a case study of design and user-related decisions between an application designer and a Help author. Central to the study is the argument that design must be based on an empirically 'informed' rather than 'assumed' user model. The project also challenges Web literature that does not address user considerations in its promotion of design methods.

Eiler, Mary Ann and Kathleen Bright. STC Proceedings (1998). Articles>Documentation>Online>Help

Distributing Cross-Platform, Cross-Browser HTML Help Using the Microsoft Java Applet  

In a previous article we discussed what browser-based HTML Help is, and how you can use the HTML Help ActiveX control to create and distribute web-based HTML Help to Microsoft Internet Explorer Users. In this article we'll explain how to use the Microsoft Java Applet to create and distribute Help systems that can be viewed by an Java-enabled browser.

ComponentOne (1999). Articles>Documentation>Online>Help

Distributing Web-based HTML Help

In this article we discuss what browser-based HTML Help is, the sitemap file that's behind the HTML Help table of contents, how the HTML Help ActiveX control HHCTRL.OCX interprets and displays this sitemap file, and how you can automatically distribute HHCTRL.OCX.

ComponentOne (1998). Articles>Documentation>Online>Help

A Dozen Techniques to Improve Your Software Online Help

There are several main reasons why putting your software manual on-line is necessary. It makes your web-site attractive for search engine crawlers and therefore brings you targeted traffic from Google, Yahoo!, MSN, and other search engines. A good online manual presents your product as serious and credible. Moreover, if a user faces difficulty using your software and asks for technical support, you may easily resolve the issue by referring that user to a certain page of your online help. Simply give the page's URL. With just one click the user will see screenshots and explanations which will help them to resolve the issue.

Crane, Dennis. Dr. Explain (2005). Articles>Documentation>Online>Help

Electronic Documentation Basics

Below you can find a compilation of the most frequently asked questions about electronic catalogs. You will find answers to general as well as to technical questions.

ITEDO Software (2003). Articles>Documentation>Online>Help

Embedded Help – Meeting the Needs of Your Users  

Designing and developing an embedded help solution involves several stages. A successful solution starts with identifying user wants and needs. As you sort through these needs, identify common threads and design a solution that addresses these common threads. Consistency, flexibility, and experimentation are keys to developing a successful solution. Your design should be intuitive to use, and should provide users with the options they need. As you design your solution, consider your develop and maintenance requirements. You want the time you invest in the first version of your solution to pay off for future releases.

Mueller, Paul. STC Proceedings (1999). Articles>Documentation>Online>Help