Is This Ethical? A Survey of Opinion on Principles and Practices of Document Design    

In a national survey, 500 technical communicators and 500 technical communication teachers were asked to assess the ethics of seven document design cases. According to the 455 respondents, manipulating typography and leading to fit more or less information on a page and using persuasive coloring or spacing are ethical practices, while the manipulation of pictorial illustrations and the distortion of graphics are unethical. Opinion on using typography to decrease readability is divided. In five of the seven cases, women are consistently more lenient or men consistently more strict in their answers: common practices, specifications, reader's responsibility, writer's responsibility, writer's intentions, consequences, judgments, principles, and insufficient information. The explanation most often given was consequences, indicating a 'goal-based' philosophy of ethics.

Dragga, Sam. Technical Communication Online (1996). Careers>TC>Document Design>Graphic Design

Is Your Website Poised to Deal With Its Growth?  

Every webmaster nourishes the dream that his or her website will make it the big way. This is very much human because people carry out any task in ardent hope. What is more human out here is that earthy fellows like us base our aspirations more on speculation rather than specific set of steps undertaken to bring the dream a bit closer to reality. And this is not all, particularly in case of growth of a site which brings newer problems in the wake of its growth. It cannot be disputed that you can probably get some good web hosting on economy price. But if you expect top of the line service on this price, acknowedge gracefully that your are just asking for the moon. Probably you are not catching up with wisdom that business needs decisive investments.

Azam, Rahbre. Amateur Writerz (2008). Articles>Documentation>Web Design>Technical Writing

It's a Colorful, Wired World  

Adobe® PostScript 3 printing systems offer a variety of new features for better, faster, Web-savvy printing. Here's an overview of what they are and how they're likely to affect you.

Nordling, Tamis and Wendy Katz. Adobe Magazine (1997). Articles>Document Design>Prepress>Color

It's Not Enough to Say What it Does

All too often, developers think that documenting their new creations just means writing a detailed technical description of what it does. In a sense, they're explaining things to themselves. But what you really need to do is explain things to someone who's coming across your stuff for the first time.

McManus, Eamonn. Artima (2004). Articles>Documentation>User Centered Design

John Carroll's The Nurnberg Funnel and Minimalist Documentation    

A review of the use of minimalist theory in the creation of documentation sets.

Farkas, David K. and Thomas R. Williams. IEEE Transactions on Professional Communication (1990). Design>Documentation

Just Say "Help": Implementing Help in VoiceXML

One of the exciting aspects of XML is the number of ways it is being used to provide new means of communicating and gathering new information. One such use is VoiceXML, an emerging W3C standard that brings voice to the Web or the Web to the phone.

Beebe, Allen. WritersUA (2002). Design>Documentation>XML

Karen A. Schriver: The InfoDesign interview

Karen Schriver is the author of Dynamics in Document Design: Creating texts for readers, an extensive, multidimensional portrait of what readers need from documents and of ways to integrate word and image in order to better meet those needs. She is the former co-director of the graduate program in technical communication and document design at Carnegie Mellon University. Her company, KSA Document Design and Research, helps organizations improve the quality of their paper and electronic communications through strategies based on research and best practices.

Bogaards, Peter J. InformationDesign (2005). Articles>Interviews>Document Design>Visual Rhetoric

Keeping Pace with Change

Documentation isn't the most fun part of design and IA, but does it have to be the most painful? Samantha Bailey looks at a tool that may help.

Bailey, Samantha. Boxes and Arrows. Articles>Documentation>Information Design

The Kind of Documentation Users Really Want

Have you ever asked your users what kind of training materials they want, or how they prefer to learn software? This kind of information is critical to figuring out what help deliverables to produce. But really when it comes down to it, there are only so many options — printed manuals, short guides, interactive flash guides, videos, online help, live training, reference cards, context-sensitive help, workbooks and exercises, or, usually the favorite, someone to stand by their computer and answer questions whenever they need help.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>Usability>User Centered Design

Large-Scale HTML Conversion Using a Word Processor  

In 2000, the Hitachi Technical Information Department carried out a large-scale documentation project requiring the revision of 47 English manuals (about 15,000 pages) and production of the manuals in both paper and HTML formats. Many projects of this size would normally use more complex software and file formats, such as FrameMaker and SGML. However, most of the English manuals were already in Microsoft Word (hence forth 'Word') format, and we decided to use Word 2000 to convert the manual document files into HTML files directly. The presentation discusses solutions to problems encountered in this HTML conversion project.

Hara, Takayoshi and Mayumi Seitou. STC Proceedings (2001). Design>Documentation>Web Design

Layout

The way elements are arranged on screen carries lots of meaning that we interpret subconsciously when decoding web pages.

Hunt, Ben. Web Design From Scratch (2006). Design>Web Design>Document Design

The Leap Online  

McGowan discusses how documentation departments can ease the transition from a paper-centered work environment to an online one.

McGowan, Kevin S. Intercom (2000). Design>Documentation>Online

Learning PageMaker

One way to learn PageMaker is just to use it. If you have experience in publishing, PageMaker is designed to be familiar to you, like using a light table. There are a few 'gotchas,' of course, but if you're an experienced publisher, learning PageMaker should be a snap. It's a complex program. But the good news is that PageMaker is a lot easier to learn than competing products like QuarkXPress. In addition to the obvious — the PAGEMAKR mailing list — you may want to take advantage of the many training materials available. In 1985, desktop publishing was brand new and unexplored territory. Today, millions of people use desktop publishing software worldwide. Of course, there's a lot more to learning desktop publishing than learning PageMaker: there's typesetting and graphic design, for starters.

Adams, Peter C.S. Makingpages.org (2002). Design>Document Design>Software>Adobe PageMaker

Let's Stop Writing Documentation and Start Working for the Users  

Nearly 20 years ago, the profession of technical communication began to focus on developing task-oriented documentation. Although task-oriented documentation has always been produced, particularly for consumer products, it was not the standard in the computer industry. More often, people writing about computer systems focused on the system rather than on the tasks people needed to perform. Systems-oriented documentation was the norm.

ComTech Services. Articles>Documentation>User Centered Design

Let's Stop Writing Documentation and Start Working for the Users  

Technical communication's long-time focus on task-oriented documentation has left customers with too many tasks and too much information; itï¿Âs time for a new approach. A user-centered approach reflecting a thorough understanding of users and how they engage the product is the surest route to effective documentation and training. To understand what users need, we need to get closer to them by spending time in their workplaces, watching them execute everyday tasks, and listening to them. Through this kind of ethnographic activity, we will become user experts, gaining credibility within our own organizations and our user communities.

Hackos, JoAnn T. STC Proceedings (1999). Articles>Documentation>User Centered Design

Linking 101  

Linking is surely one of the least understood functions of many applications. But if anyone can explain how it works in PageMaker, Illustrator, and FrameMaker, Professor Kvern can.

Kvern, Olav Martin. Adobe Magazine (1998). Design>Document Design>Hypertext

Little Machines: Understanding Users Understanding Interfaces    

This paper questions the ubiquitous practice of supplying minimalist information to users, of making that information functional only, of assuming that the Shannon-Weaver communication model should govern online systems, and of ignoring the social implications of such a stance. Help systems that provide fast, temporary solutions without providing any background information lead to the danger of users completing tasks that they do not understand at all. (Word will help us write a legal pleading, even if we have no idea what one is.) As a result, we have help systems that attempt to be invisible and to provide tool instruction but not conceptual instruction. Such a system presents itself as a neutral tool, but it is actually an incomplete environment, denying both the complexity and alternative (and possibly improved) modes of thinking about the subject at hand.

Johnson-Eilola, Johndan. Journal of Computer Documentation (2001). Articles>Documentation>User Centered Design>Usability

Logical Order of Page Components

There is a natural flow to many visual interactions - the flow of a visual dialogue between page your features and your user's private mental commentary.

Hunt, Ben. Web Design From Scratch (2006). Design>Web Design>Document Design

Making Help More Human, and Other Discussions

Discusses a number of trends in the technical writing world, particularly the need to make help more human by adopting conversational tones and addressing the angry/frantic state of the user.

Johnson, Tom H. and Heidi Hansen. Tech Writer Voices (2007). Articles>Documentation>User Centered Design>Help

Making Manuals Obsolete: Getting Information out of the Manual and into the Product    

Users loathe reading the operating manuals that accompany new equipment. Manuals often sit unused on a shelf, far from their targeted audience, while the costs of technical support soar. This article promotes integrating information traditionally found in printed manuals into the product itself and reports the experience of a design team in developing an easy-to-use product requiring minimal printed documentation. As part of design teams, technical communicators can advocate both reducing the amount of information required to operate a product and making the information immediately available when needed. These strategies can produce increased customer satisfaction and lower post-sales support costs.

Millar, Carol. Technical Communication Online (1998). Design>Documentation>User Interface

Making PDFs Smaller

How can I reduce the size of several PDFs at once?

Rosenthol, Leonard. PDFzone (2003). Articles>Document Design>Software>Adobe Acrobat

Making Screen-Ready PDFs

Is there a quicker way of making screen PDFs from print-ready PDFs?

Miller, James. PDFzone (2003). Articles>Document Design>Software>Adobe Acrobat

Managing Quality Graphic Design in a Documentation Project  

Supervising the design of documentation is challenging for documentation managers who have little or no educated knowledge of design. However, quality design that maintains ease of reading, accessibility, comprehension, retention, and aesthetics is vital to the usability and success of the documentation and should be carefully monitored by the documentation manager. Decisions must be made up front on four design areas -- packaging, layout, typography, and highlighting -- before the project is underway. In addition, audience analysis and a design style guide are two techniques that managers should embrace in supervising design.

Listeman, Amy J. STC Proceedings (1995). Careers>Graphic Design>Document Design>Documentation