Bridging the Gap Between Design and Editorial

With both Adobe InDesign® CS and Adobe InCopy® CS in your publishing workflow, writers and editors can compose stories in InCopy at the same time designers are laying out the pages using InDesign—without overwriting each other’s work.

Adobe (2003). Articles>Document Design>Software>Adobe InDesign

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

Bulletproof Your Brochures

Brochures are good for some things but not others. The key to not wasting your money is to understand what brochures do well, and what they don't do well.

Bennaco (2005). Articles>Document Design>Marketing

Buying Laser Paper That Won't Jam  

How to choose paper for laser printing.

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

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

Charles Morris's Semiotic Model and Analytical Studies Of Visual and Verbal Representations in Technical Communication    

In this article, the author demonstrates that the semiotic model proposed by Charles Morris enables us to optimize our understanding of technical communication practices and provides a good point of inquiry. To illustrate this point, the author exemplifies the semiotic approaches by scholars in technical communication and elaborates Morris's model through analyzing visual and verbal elements of technical communication brochures from semantic, syntactic, and pragmatic levels. The discussion of semiotic approach reinforced by various examples illustrates that the semiotic model can be a tangible theoretical and practical tool to help students and practitioners study and analyze the use of visual and verbal elements in technical communication.

Fan, Jiang-Ping. Journal of Technical Writing and Communication (2006). Articles>Document Design>Assessment>Semantic

Choice Paper  

Even the pros forget the basics sometimes. Constance Sidles gives a quick refresher course on asking yourself, and your client, all the right questions when you're choosing paper.

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

Cleaning up PDF Documents in Acrobat

If you are posting your PDF document to a web site, you'll generally want to upload a clean copy that will streamline the viewing experience for your site visitors. This tip outlines a quick way to remove unnecessary annotations, widgets, JavaScript, links, bookmarks and attachments, along with optimizing your documents for fast web viewing.

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

Review: Coherence, Continuity, and Cohesion: Theoretical Foundations for Document Design by Kim Sydow Campbell    

A review of Kim Sydow Campbell's book Coherence, Continuity, and Cohesion: Theoretical Foundations for Document Design.

Kirloskar, Mukta. International Journal for Technical Communication (2006). Articles>Reviews>Document Design

Color in Technical Documents for Paper, Web, and PDF  

Traditionally, technical documents have been produced in black and white because the cost of color reproduction on paper is high. With new delivery options of the Web and PDF, color is suddenly available at no cost online. And new digital printers make color on paper increasingly affordable. When opportunity knocks, issues tend to follow. Writers will find that using color is a learning experience. There is a new alphabet soup: RGB, CMYK, GIF, JPEG, CSS. There are new buzzwords: spot colors, process colors, digital printing. There are new techniques for representing color in Web pages and in PDF documents intended for paper or screen. Our presentation focuses on practical techniques, not graphic design.

Jackson, Ken and Sonya E. Keene. STC Proceedings (1999). Design>Document Design>Prepress>Color

Color Management in PageMaker

Establishing color control on the desktop can prove to be a frustrating task. And when you're dealing with color-critical customers or just plain want decent color, that's not the best situation. This PDF by Scott Olswold and Rick Dumont explains the fundamentals behind color management and then applies this discussion in terms of PageMaker.

Olswold, Scott. Makingpages.org (2002). Design>Document Design>Software>Adobe PageMaker

Color Management Made Easy

See the same colors in InDesign, Photoshop, Illustrator, and Acrobat, thanks to the Adobe Color Engine.

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

Color Under Control  

Several years after the hype began, color management is maturing into a useful tool that can solve real problems. Here's a comprehensive overview.

Fraser, Bruce. Adobe Magazine (1995). Design>Document Design>Prepress>Color

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

Commenting on PDF Comments

If your response to the question 'How do you use Acrobat comments?' is a mumbled 'No comment,' then listen up. Comments and annotations are some of the most powerful ways in which Acrobat can streamline your creative workflow. Here are some tips.

Dennis, Anita. Creative Pro (2003). Design>Document Design>Workflow>Adobe Acrobat

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