Cross-Language Information Retrieval: Layout Strategies for Gloss Translation

In this experiment, we study some issues on the user interface design of Cross-Language Information Retrieval (CLIR). In particular, we study some enhancements to the current user interface design for the University of Maryland Translingual Information Retrieval System web page.

Elnahrawy, Eiman M., Nagia M. Ghanem and Moustafa A. Youssef. University of Maryland (2001). Design>Document Design>Localization>Search

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

Customizing Strokes Styles

With Adobe InDesign® you can create and edit custom dash, dot, and stripe stroke styles, giving you more control and freedom over how strokes look in your publications. You can also save the stroke styles you create, and then use them over and over again in other InDesign publications.

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

CyberText Consulting: Newsletter/Blog

Lots of hints and tips for Microsoft Word, PowerPoint, Outlook, AuthorIT, etc.; cool URLs; interesting book reviews; pet peeves; and whatever else piques my interest.

Bracey, Rhonda. CyberText Consulting. Resources>TC>Document Design>Blogs

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

The Design Elements of Medieval Books of Hours    

The commonsense principles of modern document design are direct descendants of the principles used in the Books of Hours, a hybridized religious instruction manual created in the commercial scriptoria of the 13th century. This article analyzes the design of Books of Hours and discusses how these medieval documents fit within the four design criteria (supertextual, extra-textual, intratextual, and intertextual) put forth by Kostelnick and Roberts [1]. The analysis reveals the early user of good document design features as the medieval scriptoria worked to address the audience and task requirements of the Books of Hours.

Webb, Mary and Michael J. Albers. Journal of Technical Writing and Communication (2001). Design>Document Design>History

Design for Reading

To design for attention -- and then be sure the message is read -- several lessons can be learned from that most mundane of printed material, the newspaper.

Woolf, Gordon. Document Design (2001). Design>Document Design

Designing a Distinctive Table

When you're working with complex data, a table may be your best option. Often, a logical series of rows and col-umns can communicate more clearly than paragraphs. Adobe® InDesign® 2.0 introduces a robust table feature that makes it easy to line up those rows and columns—and to format them in striking ways. Here we show you how you can make an easy-to-read table while using the graphical power of InDesign to integrate it into the style of your document.

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

Designing a Help System for a Web Site

When I worked for a large insurance company, my team as tasked with re-designing the customer service area for a external Web site that supports annuities and mutual fund customers. I proposed redesigning the entire site including an actual help system (like with ones you can create with RoboHelp) to reduce customer service support calls. I was really surprised that everyone thought this was such a novel idea -- I thought it made perfect sense. Then, it hit me -- you don't see a lot of help systems for Web sites.

Leonard-Wilkinson, Theresa A. W-edge Design (1999). Design>Web 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 Effective User/Training Documentation with the Learning Style Inventory (LSI), the User Empowerment Inventory (UEI), and Think-Aloud Protocols  

While there are many instruments that measure the capacity for establishing peer-level communication skills, few exist that evaluate the effectiveness of knowledge transfer in the writer-reader relationship. The Learning Style Inventory (LSI), the User Empowerment Inventory (UEI), and thinkaloud protocols help assess how people acquire new knowledge and process information. The results of such measurements/ observations help determine user requirements. This paper presents a case history of how the LSI, the UEI, and think-aloud protocols helped improve both user and training documentation to a technology-averse audience in a reactive project environment.

LeVie, Donald S., Jr. STC Proceedings (1996). Design>Documentation>Methods>Usability

Designing Embedded Help to Encourage Inadvertent Learning    

What do we do when a legacy help system has trained the users not to use it? How do we design a solution that not only lures users back to the user assistance, but also encourages users to learn more about the product? This article follows the decision-making process of a design team that had to solve these problems. Additionally, the design team had to craft solutions for an application that imposed extreme limitations on those solutions, both in help system implementation and information design.

Mobley, Karen L., Clinton Knight and Timothy Meserth. Technical Communication Online (2003). Design>Documentation>Help

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 for the Web: Special Considerations for Safety Information  

Manufacturers are currently grappling with determining whether they should put safety information on the Web and if they do how it should be presented. Technical communicators, Web content developers, and Web designers will ultimately be responsible for the presentation of Web-based safety information. This article discusses special considerations that should be given the formatting (HTML, PDF, etc.), design, (font, size, and color), and location of safety information on the Web. Additionally, areas for future research on the issue of Web-based safety information are identified.

Tallman, Lisa A. STC Proceedings (2001). Presentations>Web Design>Documentation

Designing Help Text

In an ideal world help text would be unnecessary - users would never get stuck in an application or site. It should be enough to provide clear design, carefully chosen titles and labels for the various functions, appropriate field prompts when user entry is required, helpful feedback, a glossary, and 'embedded' help such as default values, example input, on-screen step-by-step instructions and explanatory text next to fields or functions. Help features should certainly be a last resort. Anyone embarking on adding it to an application or site should be sure that they have already followed the best practise listed above. In most cases (certainly online) a help option should not be necessary.

Farrell, Tom. Frontend Infocentre (2001). Design>Documentation>Help>Online

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 Object-Oriented Documentation  

Describes how to construct documentation using the object-oriented model.

Beg, Visja. Intercom (2000). Design>Documentation

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