Combining the Print and Online Media Offers Synergies

Companies had decades of experience in using printed materials to persuade readers to contact them, whether by phone, mail, or in person. This model of interaction with customers had worked so well and so predictably that we simply moved it online, largely unmodified. That was by no means wrong, but as Web technology and our comprehension of that technology both evolved, the approach proved limiting.

Hart, Geoffrey J.S. Geoff-Hart.com (2001). Articles>Document Design>Information Design

Comics for Consumer Communication: Reaching Users with Word and Image

The rising popularity of the comic as an internal communication device for designers has increased our ability to engage our stakeholders as we build interfaces. Yet, social service agencies looking to provide services to hard-to-reach groups like immigrants, cultural minorities, and the poor have taken pride in innovative outreach methods. In situations where traditional printed matter is a barrier, graphical methods can be used very effectively to communicate with audiences. From guerilla theatre to testimonials, posters to graphic instructions, users have benefited from alternative communication methods, particularly in situations where education or cultural barriers make it difficult for people to access services important to their well-being and safety. In some cases, the comic book format has been used as a way to help people get access to critical legal help. This case study from my time as a Publication Manager at the Legal Services Society (LSS) of British Columbia (BC) could inspire the use of comics outside the development process.

Bailie, Rahel Anne. Boxes and Arrows (2008). Articles>Document Design>Technical Illustration>User Centered Design

Coming to Terms  

Picking paper involves deciphering a lot of arcane terminology. Here's a quick reference guide.

Sidles, Constance J. Adobe Magazine (1996). Articles>Document Design>Prepress>Paper

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

Conciseness is Key to Good Technical Documentation

One of the most important and difficult parts of technical documentation concerns writing in a concise manner. Technical writing is different than writing fiction or magazine articles, where a mood may be set or--in some cases--where space must be filled. (People seldom buy thin books.)

Kurtus, Ron. School for Champions (2005). Articles>Document Design>Technical Writing>Minimalism

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

Creating a Template (Part I): The Basics

The natural tendency of most users of word processing applications is to create a document and use it as a model for future documents. That is, you format a letter the way you want all (or most) of your letters to look, save it, and then, when you want to write a letter, open this document and save it under another name as the starting point for your letter. In WordPerfect, until recently, this was the only way to create a template. Word uses a different approach.

Barnhill, Suzanne. Word MVP Site, The (2005). Articles>Document Design>Software>Microsoft Word

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

Cropping Pages to Highlight Areas in Acrobat

When you receive a PDF that contains, say, an image that is surrounded by text, how do you highlight the image? One way is to export the graphic to an imaging application such as Photoshop, but that involves additional applications and the associated loading times. A great 'quick and dirty' fix here is to use the 'Crop' tool to hide the content that surrounds the image, leaving you with PDF which displays only an image, just the way you wanted it. This tip explains how.

Shea, Dan. PlanetPDF (2006). Articles>Document Design>Software>Adobe Acrobat

Cross-Platform Publishing  

Desktop publishing has evolved tremendously over the last 10 years, coming from manual paste-up and manual design to complete digital photo-editing and digital graphic design. The challenges and issues we face in the translation industry are directly related to the authoring methods and build-environments of today’s writers. One of the biggest issues to date is the use of more than one platform for the authoring and localization (translation) of texts, ads, publications and software. The two most prominent platforms used for publishing media are the PC platform (Win 95 & 98) and the Macintosh. When a document is created, it is often authored for the source language; in other words, the authoring is not done with translation in mind.

Knoerndel, Dan. STC Proceedings (1999). Articles>Publishing>Document Design

Custom Toolbar

We recently converted our documents from Word to FrameMaker. Most of the people in my department had been using Word for years and had grown accustomed to applying character formatting using key commands or buttons on the toolbar. I was afraid that they would use the same methods in FrameMaker simply out of habit, rather than using character tags.

Henkel, Rick. Docspages. Articles>Document Design>Software>Adobe FrameMaker

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

Dabbling in Document Design

One of the advantages that print journalists have is that they learn document design on the job. Today, thanks to computers and design packages, design awareness is very high. Even the novice computer user becomes proficient in designing documents within a few days, if not weeks. Usually, templates are available for brochures, reports, books, etc. All you need to do is fill in the contents in the readymade template.

Kamath, Gurudutt R. IT People (2003). Articles>Document Design>Document Design>Visual Rhetoric

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

Designing Automated Custom Templates as Part of A Global Corporation's Style Guide  

When CH2M HILL staff ignored the Times 12 standard for document production and began inventing their own formats, they often bypassed the company's Publications groups, resulting in client bewilderment and anger. We will orient the audience to how creative thinking and innovative programming made it easy for staff to produce consistently attractive and effectively formatted documents. We also will demonstrate the final Toolset version and supply information about how you can apply the benefits of a Toolset product in your company's environment.

Sippel, Martha K., Brock McFarlane and Deborah Gillespie. STC Proceedings (1998). Articles>Document Design>Style Guides

Designing Better Instructional Documents  

Demonstrates how principles of print design and visual literacy can improve the usability of course handouts.

Codone, Susan K. Intercom (2004). Articles>Education>Document Design

Designing Documents with a Word Processor

This tutorial presents a brief overview of how to achieve interesting, effective designs for your pages using the basic features of your word processor. Specifically, it introduces you to important design principles to consider as you design a document and helps you analyze the design of sample documents. Although the design principles presented here apply to both print and online documents, the primary focus is on design strategies for paper documents.

Munger, Roger H. Bedford-St. Martin's (2007). Articles>Document Design>Word Processing

Designing for Interactivity: Role Models, Guides, and Coaches  

This paper presents three methods of user assistance: role models (simple demonstrations), guides (structured walk-throughs), and coaches (active assistants). After a brief introduction, potential uses, available development tools, and additional information sources are discussed for each method.

DeLoach, Scott. STC Proceedings (1998). Articles>Documentation>Help>Interaction Design

Designing Information-Gathering Forms  

Poorly designed information-gathering forms drive up operating costs. Good design depends on a careful analysis of two users: Form-Fillers and Form Readers. Both types ofform user benefit if the form designer follows four principles of overall design. Guidelines for answer sections and user testing can also help designers produce more effective forms. Evaluation of existing forms can lead to successful revision so that costly mistakes can be avoided.

MacNealy, Mary Sue. STC Proceedings (1994). Articles>Document Design>Forms>Usability

Designing Text to Flow Around Objects

Wrapping text around objects—from basic shapes or frames to images with clipping paths—can give any publication a unique look and feel. In this tutorial, you’ll learn several ways to work with text wrap in Adobe InDesign® to achieve the look you want.

Adobe. Articles>Document Design>Software>Adobe InDesign

Desktop Publishing Shootout

Whatever the subject of lists I follow, two basic questions usually come up about every three months. Usually the person posting the question has to make a decision between: Pagemaker or Quark (and often FrameMaker), or Macintosh or PC.

Haugen, Diane. Document Design (2001). Articles>Document Design>Software

Developing a Document Planning Template  

Explains how a document planning template can establish consensus among team members regarding content and layout.

Tremmel, Martina A. Intercom (2004). Articles>Document Design>Document Design>Collaboration