User Perceptions and Point of View in Technical Illustrations  

Test subjects were asked to match body images shown from varying points of view. Their preference was for images that placed critical distances across the display plane; their error patterns suggest that several variables interact to affect the accuracy of perceiving body positions in illustrations.

Krull, Robert, Debopriyo Roy, Shreyas D'Souza and Marilyn Morgan. STC Proceedings (2003). Design>Documentation>Technical Illustration

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 a Database as a Feedback Mechanism  

The success of any technical document depends on the reliability of information presented in the document. A database can provide an informal mechanism for exchanging information about product development and support, The database system should have a user interface that is easy to use and does not require too many operations. Factors that must be addressed in the design, testing, and implementation of the database include the type of information, ownership, system maintenance, access control, and system development tools. Writers, who have special expertise in information gathering, can take the initiative and build support for the project.

Govindan, Anumarla and Nancy E. Jacobs. STC Proceedings (1993). Design>Documentation>Assessment>Databases

Using Acrobat Standard 6.0 in a Document Review Cycle

A six-part sample lesson on how to use Acrobat and PDF for document review. Included for download are several files referenced in the exercises.

PlanetPDF (2004). Articles>Document Design>Software>Adobe Acrobat

Using Color in Your Documents

People often use colors in their documents in the wrong ways. Many students think that bright colors should be used in a document when they want to attract someone’s eye to a place on the page. Colors alone, however, should be used in synch with white space, font size, type and placement of whatever it is you want someone to be attracted to. Furthermore, just because something is filled with a bright color does not mean that it is eye-catching or attractive. True, bright colors will quickly draw the eye there, but use colors in a way that will make the eye stay there, not glance away in disgust.

Lanier, Clinton R. sense and usability (2008). Articles>Document Design>Visual Rhetoric>Color

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

Using Design Elements as Page Organizers  

Creating a visual hierarchy has always been the primary concern of page design. Whether the purpose is to instruct, inform or sell -- communication is the primary goal. The designer's task is to organize the page so that the viewer can easily find pertinent information on the page and in the appropriate sequence. The layout or appearance of the page establishes relationships between items -- what is most important, what goes together, what is incidental. Structuring the page establishes clearly defined areas to assist the reader. Design elements can be used to add structure to the page by unifying or emphasizing particular page elements. Although conventions for print and online documents may vary slightly, these techniques can be applied to both.

Birchman, Judith A. STC Proceedings (2002). Design>Document Design>Graphic Design

Using Distiller to Build Booklets  

Adobe InDesign and Adobe PageMaker include utilities that create booklets using a simple page imposition routine. However, other applications such as Adobe FrameMaker or Microsoft Word do not have these utilities and leave users with a bit of a dilemma when they want booklets made. Using Adobe Acrobat Distiller and a simple PostScript file (sig.ps), you can create booklets from EPS (encapsulated PostScript) pages printed from your application. The PostScript file takes the EPS files and arranges them on pages in a single PDF document. This technical guide briefly explains impositions and signatures and provides instructions for editing the associated sig.ps PostScript file used to create a booklet. Knowledge of PostScript may be helpful but is not absolutely necessary; you need only to make a few clearly explained edits for the sig.ps file to work with any documents you have.

Virginia Tech. Design>Document Design>Software>Adobe Acrobat

Using Graphics to Help Users Build Mental Models  

Research shows that adults learn more efficiently when they have formed an accurate mental model of the product they are trying to use. We can help our users form accurate mental models more quickly by graphically depicting that model on the interface. One product using that approach allowed engineers to become productive with no reference to user documentation.

Elser, Arthur G. STC Proceedings (1995). Articles>Documentation>Graphic Design

Using Guides Effectively

Adobe InDesign 2 has some incredible features that aren't found in any other page-layout application and that's why so many designers are migrating to it. What's often overlooked, however, are the cool, subtle, yet powerful features for everyday production work.

White, Terry. Mac Design Magazine (2003). Design>Software>Document Design>Adobe InDesign

Using HTML as a Single Source Solution: A Case Study  

This paper presents an overview of the process and toolset developed for maintaining, updating, and generating user documentation for a complex Department of Defense (DoD) vulnerability analysis model. The roles of HyperText Markup Language (HTML) and eXtensible Markup Language (XML) in developing a single source solution are examined. The additional role of the Alchemy toolset, which is a customized solution to address page layout formatting in HTML, is also examined. Finally, practical application of this process/toolset to a generic software project is discussed.

Butkiewicz, Mark and Lisa Garriques. STC Proceedings (2004). Articles>Document Design>Information Design>HTML

Using Layers Creatively

Adobe® PageMaker® 7.0 includes a powerful Layers tool with countless applications—we’ll show you three in this tip: 1. Multiple versions 2. Quick arrangement of layers from top to bottom 3. Layered communication—'stick-on' notes

Adobe (2003). Design>Document Design>Software>Adobe PageMaker

Using OpenType Pro fonts in InDesign 1.x

This document is intended to serve as a brief introduction to both the new OpenType font file format, as well as the ways you take advantage of the advanced features of OpenType Pro fonts within InDesign.

Cole, Tim. Mac Design Magazine (2003). Design>Software>Document Design>Adobe InDesign

Using Perception in Managing Unstructured Documents

Over the last ten years, the increased availability of documents in digital form has contributed significantly to the immense volume of knowledge and information available to computer users. The World Wide Web has become the largest digital library available, with more than one billion unique indexable web pages. Yet, due to their dynamic nature, fast growth rate, and unstructured format, it is increasingly difficult to identify and retrieve valuable information from these documents. More importantly, the usefulness of an unstructured document is dependent upon the ease and efficiency with which the information is retrieved. In this paper, we define an unstructured document as a "general" document that is without a specific format e.g., plain text. Whereas, a document divided into sections or paragraph tags is referred to as semi-structured e.g., a formatted text document or a web page.

Cheng, Ching Kang and Xiaoshan Pan. ACM Crossroads (2004). Articles>Document Design>Online>Cognitive Psychology

Using Photography to Illustrate Technology Trends and New Capabilities  

The very best of today’s public relations photography devises visual statements by carefully blending composition and lighting. Dramatic use of color has emerged as a strong graphic element over the past decade. Today’s inexpensive scanners and related image manipulation software provide new capabilities to manipulate B/W and color photos.

Brus, John M. STC Proceedings (1993). Design>Document Design>Image Editing>Visual Rhetoric

Using RoboHelp to Develop a Simple Web-Based Tutorial

RoboHelp is a top application for developing online help. It is also used for developing Web-based help, such as JavaHelp and RoboHelp's WebHelp. Besides being used for online or Web-help, RoboHelp can also be used to develop simple tutorials.

Kurtus, Ron. School for Champions (2001). Design>Documentation>Software>Adobe RoboHelp

Using Text Organizers  

Many technical documents are rich in text and poor in graphics. Not all documents have photographs and illustrations to provide the reader with visual cues. Text organizers can be used as a method for relieving the visual grayness that happens when a document is all text. Headlines, kickers, subheads, headers, footers, pull quotes, and bulleted lists are all text organizers that can be used throughout a technical document to promote a better flow of information.

Sadowski, Mary A. STC Proceedings (2002). Articles>Document Design>Visual Rhetoric>Technical Illustration

Using Usability “Use Cases” in Documentation Planning  

This workshop presents an introduction to use cases - a planning tool which can be used for capturing a future documentation system's functional requirements as well as the overall information requirements of end users. You learn what a use case is and what recommended guidelines there are for creating use cases. You also learn how use cases are applied in the documentation development process as a whole.

Nurminen, Mary and Leena M. Rasinaho. STC Proceedings (1997). Presentations>Documentation>User Centered Design

Version Cue: Balancing Simplicity, Functionality in CS Workflow Tool

Adobe's release of Creative Suite last fall introduced Version Cue, a tool designed to help individuals and small creative teams keep track of the latest versions of their graphics and page layouts. The Seybold Reports took it for a test drive to assess its performance.

Dyson, Peter and Mark Walter. Creative Pro (2004). Design>Document Design>Software>Workflow

Viruses and the Desktop Publisher

Viruses are of particular interest to the desktop publisher because we frequently exchange disks with clients, open other people's Word files to edit them, and receive unsolicited files via email — all examples of 'at risk' behavior. Everyone should practice 'safe computing' and Windows users especially should make certain their anti-virus software is kept up to date. A list of vendors and informational sites can be found in the sidebar on the right.

Adams, Peter C.S. Makingpages.org (2002). Design>Document Design>Security>Viruses

A Visible Ideology: A Document Series in a Women's Clothing Company    

Studying corporate documents provides clues to the larger philosophy of the organization. This article explores a sales document redesign that indicates a subtle shift in ideology for a women's clothing company. The corporation uses direct sales to market clothes to a variety of women. In one season, the documents change from relatively outdated designs to more updated, professional layouts. However, the content of the documents changes very little. The author contends that the document redesign indicates a move to a more feminist out-look for the company and uses the concept of ethos to describe how the document design represents a slowly changing ethos for the corporation. A specific content shift towards feminism is, however, less apparent.

Cronn-Mills, Kirstin. Journal of Technical Writing and Communication (2000). Articles>Document Design>Case Studies

A Visual Guide to Document Design and Layout  

Technical publications departments in their infancy seem to have great difficulty producing documentation that is well designed and consistent in appearance throughout all documents. As the department matures, it attempts to "consistify" the appearance of the documentation, but, unless there is an experienced template designer on board, this is often a drawn-out process involving focus groups and much squabbling. Once the design is complete, however, it tends to be nearly identical to the templates designed by every other technical publications department in the world. Aside from a handful of design features that distinguish the look and feel of one company's documentation from that of its competitors, everything else is pretty much the same. Whether the focus group spends six months or two years designing templates, they all discover that a well-designed user guide contains some specific and standard design elements.

Amott, Lyndsey. Docsymmetry (2003). Resources>Style Guides>Design>Documentation

Visual Texts: Format and the Evolution of English Accounting Texts, 1100-1700    

Emphasis on page design, as an aid to visual accessibility, did not receive attention in modern technical writing until the 1970s. However, accounting documents and instructional texts utilized format and document design strategies as early as the twelfth century to enhance the organization of quantitative data and linear bookkeeping entries. Format in text was used to reflect the arrangement used in oral accounting practices and to produce uniform documents. Thus, format was integral to the rise of pragmatic literacy of the commercial reader. During the Renaissance, these early format strategies received impetus from Ramist method. The result was design strategies that attempted to capture the rigid principles of organization fundamental to commercial accounting. These early accounting documents also illustrate the plain style that would become the focus of the later decades of the seventeenth century. Clarity in language paralleled clarity in page design for the sole purpose of eliminating ambiguity on the page and on the sentence level. Plain style was thus nurtured by financial forces long before the advent of natural science.

Tebeaux, Elizabeth. Journal of Technical Writing and Communication (2000). Articles>Document Design>Visual Rhetoric>History