Smart Quotes

One of the most irritating typographic faux pas is the use of straight quotation marks (also called ‘dumb’ quotes) instead of true typographic quotation marks (‘smart’ or ‘curly’ quotes). How did this dumb-versus-smart muddle begin? Blame the engineers: the standard keyboard layout (which was not created by typographers!) has straight quotes in place of real quotes. As designers, it’s our job to use our ‘smarts’ to work around this all-too-common problem.

Strizver, Ilene. Upper and lowercase Magazine (2002). Design>Typography>Document Design

The Soapbox, Please

I admit that my intelligence is easily insulted. It’s probably because I’ve got so little of it left – raising a child, running a business, and working in the software industry take their toll, after all – that I’ve got to defend it with the ferocity of a rabid fruit bat. But, as I review the state of the art in desktop publishing software, I’m left with one nagging question: Just exactly how dumb do these guys think I am?

Kvern, Olav Martin. Upper and lowercase Magazine (1999). Articles>Software>Document Design

Sony HDV HC1 High-Definition Camcorder

Introduces the high-definition Sony HDV-HC1 digital camcorder for technical/professional communication practice.

Karlin, Erin and Amy Tehan. Studio for New Media (2006). Articles>Document Design>Video>High Definition

Stop Writing Documentation!  

Redesign your information; write topics, not books.

Hackos, JoAnn T. ComTech Services (2001). Articles>Documentation>User Centered Design

Strategies for Producing Browser-Based Technical Documentation

This Technical Note attempts to provide a few good strategies for resolving some of the issues around producing and viewing Web-based technical documentation. The Note may be useful for engineers, technical writers and content producers who must wrestle with issues of producing documents such as ReadMe files, Release Notes, technical articles, and other forms of technical communication that land on the Web.

Apple Inc. (1996). Design>Documentation>Help>Online

Structured Authoring and XML: Part One

Implementing structured authoring with XML allows organizations to create better content. The addition of hierarchy and metadata to content improves reuse and content management. These benefits, however, must be weighed against the time and money required to implement a structured authoring approach. The business case is compelling for larger writing organizations; they will be the first to adopt structured authoring. Over time, improvements in available tools will reduce the cost of implementing structured authoring and make it affordable for smaller organizations.

O'Keefe, Sarah S. Carolina Communique (2003). Articles>Documentation>Information Design>XML

Structured Authoring and XML: Part Three

Not every content-creation group will benefit from structured authoring and XML. Sometimes, the expense of implementation outweighs the benefits realized, especially in smaller groups with less total page count.

O'Keefe, Sarah S. Carolina Communique (2004). Articles>Documentation>Information Design>XML

Structured Authoring and XML: Part Two

In a structured authoring environment, authors create documents by assembling elements and text in an order permitted by the structure definition document. You might think of structured authoring as being similar to template-based authoring with a strict template. Authors do not assign formatting; the formatting is automatically assigned based on the structure of the document. Formatting may differ for different output media.

O'Keefe, Sarah S. Carolina Communique (2003). Articles>Documentation>Information Design>XML

Structuring Help for Re-Use  

Many teams are still laboring to transform poorly organized manuals into online help. But the biggest cllallege you face going from paper to online is not interface, but structure The better your structure, the easier your users will navigate.

Price, Jonathan R. STC Proceedings (1995). Presentations>Documentation>Information Design

The Successes and Challenges of Visual Language  

Discusses efforts to create manuals that rely entirely on pictures for communication.

Hofmann, Patrick. Intercom (2004). Design>Document Design>Graphic Design>Visual Rhetoric

Successfully Merging Litho and Digital  

The merger of offset lithography with digital printing is a highly successful technique that maximizes the benefits of both technologies.

Copresco (1999). Articles>Document Design>Prepress>Printing

Supra-Textual Design: The Visual Rhetoric of Whole Documents    

Supra-textual design encompasses the global visual language of a document and operates in three modes: textual, spatial, and graphic. The rhetoric of supra-textual design includes structural functions that provide global organization and cohesion and stylistic functions that affect credibility, tone, emphasis, interest, and usability. Supra-textual rhetoric extends to other documents through conventional codes and through sets and series. Because writers may not control the end product of supra-textual design, intention may also be a rhetorical factor.

Kostelnick, Charles. Technical Communication Quarterly (1996). Articles>Document Design>Rhetoric>Visual Rhetoric

A Systematic Approach to Visual Language in Business Communication    

Although business communication relies heavily on the visual, current approaches to graphics and text design are prescriptive and unsystematic. A 12-cell schema of visual coding modes and levels provides a model for describing and evaluating business documents as flexible systems of visual language. Emphasizing clarity and objectivity, the 'information design' movement has generated guidelines for creating functional visual displays. However, visual language in business communication is seldom rhetorically 'neutral' and requires adaptation to the contextual variables of each document, a goal the writer can achieve by com bining visual and verbal planning in the same holistic process.

Kostelnick, Charles. JBC (1988). Articles>Business Communication>Document Design>Visual Rhetoric

Systems That Get Better the More People Use Them

In Publishing 2.0, Tim O'Reilly says Web 2.0 is 'any network effect that makes a system better the more people use it.' Web 2.0 isn’t just user-generated content; it’s harnessing the collective intelligence of your users to make your system better.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>Web Design>Social Networking

Tabular Data: Finding the Best Format  

Discusses the results of a study comparing several formats for displaying data in tables.

Tullis, Tom and Stan Fleischman. Intercom (2004). Design>Document Design>Visual Rhetoric>Charts and Graphs

Taking a Second Look at Screen Captures  

Asserts that screen captures aren't as necessary and helpful as many writers of documentation might think.

Bright, Kathy. Intercom (2001). Design>Documentation>Graphic Design>Screen Captures

Taking Stock of Paper

Paper stock makes a big difference in the appearance of a product, and even though prices have come down recently, it's probably the most expensive element in your print run, so you need to make it count. Though budget is probably the biggest factor in choosing stock, here are several other considerations.

Dahlman, Gayle. Editorial Eye, The (1996). Design>Document Design>Prepress>Paper

Technical Writing for Desktop Publishers

Writing and book indexing help for desktop publishers. Often desktop publishers become jack-of-all-trades and need at least a basic understanding of technical writing.

Howard Bear, Jacci. About.com (2002). Resources>Document Design>Software>Technical Writing

Technical Writing in Everyday Life: One User's Experience

The experience of setting up a new home theater system also sharply reminded me of what it is like to look at something as a new user: staring at a bunch of knobs and holes for the first time, holding a tassel of wire in one hand and a manual in the other, and really just wanting the darn piece of ?%^%! to do what it's supposed to do.

Vedrody, Sarah. MetroVoice (2002). Articles>Documentation>User Centered Design>Technical Writing

The Changing Face of Document Design and Technical Communication: The Impact of Trends on How We Think about Our Work  

Characterizes the evolving trends, and helps you consider the impact of trends on your thinking and doing.

Schriver, Karen A. IDblog (2004). Presentations>Document Design>TC

There and Back  

Taking FrameMaker files on the road can present a few challenges, but it doesn't have to be difficult. Here are some tips that'll help ensure that you get the best results.

Valiulis, Dave. Adobe Magazine (1997). Design>Document Design>Software>Adobe FrameMaker

Think WYSIOP, not WYSIWYG

Several years ago, someone used the term WYSIOP (What You See Is One Possibility) when talking about the RoboHelp HTML editor, because what developers saw in the editor didn't usually match the results. I had what I thought was an absolutely brilliant leap of logic ;-) a couple of months ago when I realized that today's WYSIWYG (What You See Is What You Get) editors are really WYSIOP, because the results are determined by whatever layout template is assigned at the time the results are viewed.

James-Tanny, Char. Helpstuff (2006). Articles>Web Design>Document Design>Adobe RoboHelp

ThinkCreation Blog

You can find desktop publishing tutorials, tips of the day and design resources.

Bruno, Elisabetta. ThinkCreation (2005). Design>Graphic Design>Document Design>Blogs