Contents and Indexes

An index is a vital part of a user manual and a help file. A manual without an index is like a 21-storey house without a names board on the ground floor. You will have to search through all the floors in the building to locate your friend’s residence.

Kamath, Gurudutt R. IT People (2002). Articles>Indexing>Documentation

Context-Sensitive Help: What Programmers and Technical Authors Need to Know

Context-sensitive Help is assistance that is appropriate to where the user is in the software application, and what they are trying to do. Carol Johnston's article describes what programmers and technical authors need to know about Context-sensitive Help.

Johnston, Carol. Cherryleaf (2003). Articles>User Interface>Help>Documentation

Converting and Delivering 750,000 Pages on CD-ROM  

The SIS Conversion Team and Electronic Media Development Team support the Service Information System development by providing data on CD-ROM for Caterpillar customers. This unique project covers eighteen different publication types, requires conversion of 750,000 pages and more than a million gray scale and line art images. The targetted data includes Parts Manuals and a variety of technical documents that were written to cover all Caterpillar machines and engines built since 1977. The conversion to electronic images and SGML-tagged text, and subsequent EMD processing and distribution via CD-ROM required extensive development efforts and a significant investment in leading edge technologies.

Bennington, Roger. STC Proceedings (1993). Articles>Documentation>CD ROM

Converting Documentation to Multimedia  

Multimedia has proven its ability to sell products and educate users. But can it also perform tasks traditionally done with conventional paper documents? Yes. This demonstration shows how several hardware and software documents were converted to multimedia and provides a plan for converting your documents. You learn whether to display, speak, or just eliminate existing text. You see how to replace action words, descriptions of motion, and arrows with animation. YOU see how sound can guide rather than distract the user. You also learn to use interactivity to give control to the user. Along the way you see the compromises needed to keep the project on schedule, within budget, and down to size.

Horton, Katherine W. and William K. Horton III. STC Proceedings (1995). Articles>Documentation>Multimedia

Converting Paper Mountains to Data Highlands

Big producers of equipment and systems of all branches often have piled up enormous volumes of product documentation in various formats on different media over long periods. How does one deal with that in the Internet age? How will brochure-like product catalogs be converted to type-specific clickable web pages, and printed price lists to present-day worldwide retrievable tables? Experiences with a large converting project show the process to achieve such document management.

Pichler, Wolfram. TC-FORUM (2000). Articles>Documentation>Online

Converting to Information Mapping: A Case Study  

Cisco Systems, Inc., uses electronic media as the primary delivery means for customer documentation and training. Information Mapping® techniques are being developed as a methodology for creating and linking modules of customer information. After selecting the Information Mapping methodology, we found it necessary to customize it for our needs. To implement Information Mapping methodology, we defined a system architecture consisting of three main subsystems: a document management subsystem, an authoring environment, and a publishing or delivery subsystem, In parallel with the customization and development of a system architecture, several writers began to implement the Information Mapping techniques to provide content to be put into the system being developed.

Garrett, Aviva, Haggai Mark and Jan Johnston-Tyler. STC Proceedings (1996). Articles>Documentation>Writing>Technical Writing

Cooperative Effort in Producing Paper and Hypertext Documentation  

Using hypertext and paper creates a successful trip for the user of an interactive, mainframe software system. Building integrated, complementary documentation requires thoughtful planning, careful organization, and skillful implementation. The resulting product needs the cooperation of the entire team.

Bibus, Connie M. 'C.J.', Patricia J. Bishop, Mary Ann Clark and Deirdre A. Murr. STC Proceedings (1994). Articles>Documentation>Hypertext

Cost Control for Online Help Localization  

Localizing a large online help system often represents the most expensive part of a localization project. However, when international customers or markets are a product’s lifelines, eliminating the online help translation is not an option, especially when customers have come to expect it. Managers of online help localization are left with a paradoxical mandate: Keep localizing, but quit spending (so much).

Kock, Benjamin C. Intercom (2003). Articles>Documentation>Localization>Language

Review: Counterfeit Capital: Searching for a Silver Lining in Bernadette Longo's Spurious Coin    

Dr. Bernadette Longo, Ph.D., uses the metaphor of devalued currency to trace some of the roots in technological history for technical writing's lack of intellectual and cultural capital. She ingeniously incorporates early threads of management and industrial technology, like the formation of the railroad, in an attempt to contextualize her research. Academics must view Longo's text, Spurious Coin, as just one branch of what must be a webbed tree of intersecting social attitudes towards knowledge definition and science. In understanding the gaps in Longo's narrative, people interested in technical writing might find her book to act as a launch pad for better defining the questions guiding their own research. In this review, I will focus on some of the important gaps I see in Longo's research methodology as she historically situates the emergence of engineering as a discipline and then as the determining factor in technical communication's subjugated position within the academy and industry.

Trim, Michelle. Journal of Computer Documentation (2001). Articles>Reviews>Documentation>History

Creating "Smart Help" with Conditional Content

Discusses several methods for making Web-based Help systems 'smart,' by using conditional content to customize the appearance and behavior of your pages to the users' needs.

Gash, Dave. WritersUA (2005). Articles>Documentation>Help>Personalization

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

Creating an Electronic Service Manual  

Developed by the Technical Information Division of Caterpillar Inc., the Service Information System (SIS) is a state of the art process using the latest in computer technology to electronically create, process and deliver technical service information to Caterpillar dealers worldwide. It utilizes authoring workstations and servers on a distributed network to create and store information elements (I/E's). The I/E's are written using Caterpillar Technical English (CTE) which allows for complete automatic language translation. I/E's are taken from the data base to make traditional publications as well as CD-ROM's. A personal computer is used to display information for shop and field servicemen and to perform interactive diagnostics.

Rennich, Merv and Gerry Meixsell. STC Proceedings (1993). Articles>Documentation

Creating an SDK: Writing on the Edge  

Sarr presents guidelines for the challenging task of creating a software development kit (SDK). The purpose of SDKs, the author writes, is to 'provide developers with information and coding examples to enable them to develop applications that will work with a newly developed technology.'

Sarr, John T. Intercom (2001). Articles>Documentation>SDK

Creating and Using Online Documentation  

This workshop provides hands-on experience in preparing and using online documentation as well as setting up and maintaining an online library.

Jedlicka, Linda Barnes, Margaret Eissler Jones and Herbert E. Vogt. STC Proceedings (1994). Articles>Documentation>Online

Creating Dual-Mode Context-Sensitive Help

Want to provide your users with state-of-the art HTML Help but don't want to force them to install Internet Explorer (which is required to run compiled HTML Help files)? In this article we show you how to create context-sensitive Help that displays a topic from a .CHM file if IE is installed on the user's system, and displays the equivalent topic from a .HLP file if IE isn't installed.

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

Creating Easy-To-Use Documentation for Paper, Online and Multimedia  

The term 'easy to use' is typically used in connection with the user interface of software applications. However, the term can also be used to describe documentation, referring to techniques of organization, layout, or design that make information both easy to understand and easy to find. As the technology associated with documentation moves toward online and multimedia documentation, the concept of ease of use becomes even more important and relevant. In this paper, we address some of the differences between paper and online documentation that impact the development of easy-to-use online documentation, and outline some of the high-level, emerging issues to be aware of in the development of multimedia documentation.

Baldasare, John, Marie T, Dumbra and Barbara C. Trevaskis. STC Proceedings (1994). Articles>Documentation>Usability

Creating Goal-Oriented, Task-Based Navigation for Information with the Darwin Information Typing Architecture (DITA)  

By organizing information around the goals that users are trying to accomplish, you can provide task-based information that truly addresses user needs. This article walks through the steps for creating more useful information navigation by implementing information development best practices with examples in the Darwin Information Typing Architecture (DITA).

Swope, Amber and Michael Priestley. STC Proceedings (2005). Articles>Documentation>XML>DITA

Creating Modular HTML Help Systems  

It is possible to create good, efficient, easy-to-maintain HTML Help systems - and it really isn't that difficult. The bad news is that if you're not sure exactly what settings need to be made, you will find creating modular HTML Help systems very frustrating. Read this article and avoid being frustrated.

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

Creating Multimedia Hardware Procedures with ShowMe How  

Learning the correct steps to install or remove a computer component, such as a memory module, can involve, at best, hands-on instruction or, at worst, only written instructions. To increase the likelihood that customers and service personnel will be able to perform correctly the hardware service procedure for each fieldreplaceable component, Sun MicrosystemsTM now ships high-quality multimedia of removal and replacement procedures, called ShowMeTM How, on CD with each UltraTM Workstation and Enterprise Workgroup Server.

Barron, Rick, Steve Hix, Paul Lorence and Jenny R. Redfern. STC Proceedings (1999). Articles>Documentation>Software

Creating Multiplatform Information Sets  

The proliferation of open systems and software that runs on multiple platforms is a challenge to those of us who are responsible for documenting these systems. This paper attempts to address the issues that arise when trying to create multiplatform information sets. Writing multiplatform documentation is a challenge not only for those responsible for documentation, but for those responsible for creating the software. You are starting with many pieces of a puzzle that you need to sort through and put together to create a usable information set.

Flanagan, Ruth-Ellen. STC Proceedings (1994). Articles>Documentation>Online

Creating Online Help from FrameMaker Files Using WebWorks Publisher  

WebWorks Publisher from Quadralay lets you develop online help from FrameMaker files without dealing with the inefficiencies associated with help authoring tools (HATs). No longer do you have to convert the FrameMaker files to RTF for use in a HAT—and consequently lose all the formatting, which you must rebuild. You also do not have to maintain two sets of files.

O'Keefe, Sarah S. STC Proceedings (1999). Articles>Documentation>Online>Adobe FrameMaker

Creating Online Tutorials and Demos  

An online tutorial or demo is a powerful way to pique interest and get users started on a new software program. Join a workshop that covers the how-to’s of creating your first project. (1) Make a plan. (2) Analyze audience needs and technical issues. (3) Form a team. (4) Write the script. (5) Design the interface. (6) Build it. (7) Test it.

Beren, Wendy G. STC Proceedings (1996). Articles>Multimedia>Documentation>Online

Creating Professional Documentation with Linux Tools

While Linux lacks standard Windows tools such as FrameMaker, RoboHelp, and WebWorks Publisher, it's still a viable environment for technical writers. Linux users can take advantage of a number of documentation tools, including both free or open source software (FOSS) and proprietary software. All of them give technical writers the ability to author and publish professional documentation.

Nesbitt, Scott. Linux.com (2006). Articles>Documentation>Technical Writing>Linux

Creating the Vision: Developing Graphic Strategies  

Making documentation more visual is a two phase process. First comes the brainstorming, where ideas bubble up: the weird the funny, the wonderful, the breakthrough, the lame brain — no idea discriminated against, all equally enjoying the bright, spring air of the creative process. Once You begin to brainstorm you may find putting concepts into graphics is easier than you thought. Then comes the second phase: the hard realization that even if you throw out all the crazy ideas, you still have to pick and choose. You have to develop a strategy for graphic use, one that goes beyond the basic visual unity a good graphic designer can give a document. You have to see the graphics in light of the user's need.

Malone, Jacquelyn. STC Proceedings (1994). Articles>Documentation>Visual Rhetoric