Analyzing Your Users and Needs Before Creating the Help Deliverables; Interview with Nicky Bleiel

In this podcast, Nicky Bleiel says we should talk to as many users as we can — conducting on-site visits, sending surveys, gathering information from Marketing, Support, and other departments — so we can have a better understanding of our users’ needs and the formats and mediums that will work best for them. After completing this audience and needs analysis, we can then go out and create the deliverables that will best serve our users.

Bleiel, Nicky and Tom H. Johnson. Tech Writer Voices (2008). Articles>Interviews>Documentation>User Centered Design

Annual Report Graphic Use: A Review of the Literature    

Corporate annual reports typically include a narrative section and a financial section. The narrative section is not scrutinized by auditors as the financial section is, yet many readers rely heavily on its graphs to estimate the firm's financial situation. However, the graphs often misrepresent the financial data. To better understand annual report graphs' important role, this article examines more than 25 years of literature related to these four areas: (a) the ways financial graphs are prepared, used, and misinterpreted; (b) differences by country; (c) regulatory influences for accountants; and (d) the parts formatting and media selection decisions play in communication interpretation and persuasion. Across the literature, the author notes consensus that annual report graphs are widely used in many countries and that there is rampant disregard for the guidelines for their accurate, non-misleading presentation. The article concludes with seven proposed directions for future research.

Penrose, John M. JBC (2008). Design>Document Design>Business Communication>Visual Rhetoric

Apple Guide Complete: Designing and Developing Onscreen Assistance

If you've been waiting to give your users more than just onscreen reference information, now you can with Apple Guide, Apple Computer's innovative help delivery system. With Apple Guide, you can produce guide files that actually lead users, step by step, through complex tasks and concepts. If you want to provide task-oriented, context-specific instructions, Apple Guide gives you the ease and flexibility to do so. You'll learn about the complete cycle of designing, scripting, and coding guide files in the four parts of this book.

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

Applying Object-Oriented Design Concepts to Web Publishing  

This is a story of how one internal project at Sun Microsystems migrated printed user and reference documentation to an internal Web site. The principle architect of this site discusses how she applied object-oriented design concepts to the Web architecture to accommodate many learning styles simultaneously. As important as the successes of this project are its failures, which offer some insight into when and how to use the World Wide Web as a communication vehicle in your overall communication strategy.

Hoft, Nancy L. STC Proceedings (1996). Design>Documentation>Web Design

Applying the Sensation-Perception Continuum to User Documentation  

The sensation-perception continuum represents the interplay of sensation and perception in everything we think and do. Technical communicators must exploit this continuum by understanding and applying sensory filters and perceptual tendencies in the design and development of information. This paper discuss three sensory filters: thresholds, cocktail-party effect, and sensory adaptation; it discusses four perceptual tendencies: perceptual set, figure-ground relationships, laws of grouping, and goodness of figures.

Coe, Marlana A. STC Proceedings (1996). Articles>Documentation>User Centered Design

Applying Web 2.0 Technologies to Technical Documentation

This article is based on my presentation at the Institute of Scientific and Technical Communicators' annual conference in October, 2006. Every now and then, there is a change in the value of what technical authors deliver. These are moments when organisations pay attention to technical documentation. This is because they recognise that these changes mean they can create something that will be of real value to the business and to their customers. In recent years, there have been three "waves of interestingness". The first wave was the introduction of Windows Help (WinHelp). The second major wave was the introduction of the Internet and intranets. This was a time when organisations looked at how they could transfer large amounts of information from paper to online. They were faced with issues such as how users could access and understand all this information easily - issues that technical communicators deal with on a day-to-day basis. I believe we're just about to approach the new wave, which we have called "Tech Writing 2.0".

Pratt, Ellis. Cherryleaf (2006). Articles>Web Design>Documentation>Technical Writing

Architecture of Designing Documents  

Both parks and document design share the same goal: to satisfy patrons and entice them to return. The common characteristics - available for many activities, easy navigation and circulation, appropriate equipment, effective use of space, and patron safety - are applied to document design. So take a walk - in a park - to find out about document design.

Lisberg, Beth Conney. STC Proceedings (1999). Design>Document Design>Information Design

Are We Giving Readers What They Want, in the Way They Want and Need It?

With all the talk about Web 2.0 and the attendant technologies, are readers actually being better served by documentation now than they were in the past?

DMN Communications (2008). Articles>Documentation>Technical Writing>User Centered Design

The Attention Map

Attention mapping is a tool to help you start to plan a visual layout around realistic communication between user and site. It can also be a helpful analysis tool, helping you work out what's wrong about a layout.

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

Automatic Magazine Layout

You can't always count on having a professional designer around to resize and position your images for you, but you'd rather your page layout didn't look like it was created by orangutans. Harvey Kane builds a script that makes your life easier.

Kane, Harvey. List Apart, A (2006). Design>Web Design>Document Design>CSS

Automating Development Tasks for a Large-Scale Help System

Although tools like eHelp's® RoboHELP® Classic can speed up and streamline the process of creating help topics, there are still many repetitive tasks needed to build a WinHelp system that supports a large, integrated application. This article summarizes one of the techniques that Fredrickson Communications used to automate the process of developing online help topics. Once the underlying structure and macros were in place, we were able to generate hundreds of help topics at the rate 15-20 per minute.

Lindsay, Bill. Frederickson Communications (2002). Design>Documentation>Single Sourcing>Adobe RoboHelp

Background Positioning vs. Centered Elements

When the browser is told to center a background image within that container, it has to decide where the actual center lies. In the case of an odd total pixel width, the browser must select one side or the other of the central odd pixel as the "center" of the container.

Bergevin, Holly and John Gallant. Position is Everything (2006). Design>Web Design>Document Design>CSS

Baking up a Batch of PDF Files  

Customize how Acrobat works for you by building and using batch sequences. The beauty of a batch sequence is that you can modify or run it as you like.

Baker, Donna L. Adobe (2007). Articles>Document Design>Software>Adobe Acrobat

Balancing Act: Keeping Your Screen Movies Small and Beautiful

Screen recordings are a valuable tool for enhancing training, tutorials, manuals and websites. Companies use this technique to produce streaming and downloadable content. The recording tools are readily available and affordable. In this article, we explore some techniques, tips and tricks for recording sound, mouse movement and happenings from your screen to an AVI file. We will talk in both general terms and use specific examples. The examples pertain to HyperCam, a downloadable screen recording application from Hyperionics Technology. Like most screen recording applications, HyperCam captures the action from your Windows screen -- including cursor movements and sound -- and saves it to an AVI movie file.

Rice, William H. IV. WilliamRice.com (2002). Design>Documentation>Multimedia>Screencasting

Bastien PROT: XPS une alternative au format PDF

XPS (XML Paper Specification) est un format de fichier électronique à présentation fixe comme le PDF du concurrent Adobe qui préserve la mise en forme du document et permet le partage des fichiers sans perte dinformation. Le format XPS garantit que, lorsquun fichier est affiché en ligne ou imprimé, il conserve le format souhaité.

Rédacteur Technique, Le (2007). (French) Articles>Document Design>Standards>XML

Becoming a "Business Communications Service Provider"

Print service providers have historically been defined by output technology such as commercial color, sheet-fed, web offset and large-format. These print technologies by themselves can be easily commoditized. As the market begins to migrate to a digital infrastructure, Print on Demand – or POD – represents something far more interesting and important than technology for technology’s sake. POD hardware and software offer the potential for new ways to communicate business information. The primary focus of successful users of POD technology is building a services portfolio and positioning their companies to provide 'business communications solutions and services.' These users are looking at digital printing and the associated services as a way to decommoditize printing and increase both profitability and customer loyalty.

Pellow, Barbara A. Digital Output (2004). Design>Document Design>Prepress>Printing

Best of Show -- Winners of STC's International Competitions  

Read about the Best of Show winners of the 2005•2006 competitions in international technical art, international online communication, and international technical publications. Also, meet the winner of the international student technical communication competition.

Intercom (2006). Articles>TC>Document Design>International

Beyond Help: Making Help a Core Component of an Electronic Performance Support System   

With the advent of HTML Help and the ability to embed Help directly inside an application, there’s been an increased interest in creating Help systems that are seamlessly integrated with their host applications. By blurring the line between the application and the Help that supports it, and by developing Help that automatically responds to user actions, application developers and Help authors now have the ability to develop true electronic performance support systems (EPSS). With this new ability will come a paradigm shift in the ways applications are developed and documented.

Wexler, Steven S. STC Proceedings (1999). Articles>Document Design>Help>EPSS

Beyond Software Manuals and On-line Help: Interactive Help

Software user guides have traditionally provided assistance when the user requested help. Context-sensitivity enabled help systems to predict the most appropriate topic to present. For Windows applications, the move from Microsoft WinHelp to the new Microsoft HTML Help format allows user instructions to be presented in the same window as the application. This offers technical authors some extraordinary opportunities to provide intelligent, predictive, interactive help without the user having to request it. In this paper, we will explore one of the first such interactive help systems (for the Archivist e-mail archiving software), and see where the technology is moving.

Self, Tony. HyperWrite (2003). Articles>Documentation>Interaction Design>Help

Beyond the Phone Book  

Whether you know it or not, 'database publishing' probably describes some of what you do. Here's how to do it better!

Kvern, Olav Martin. Adobe Magazine (1996). Design>Document Design>Databases

The Bleach Wars  

Blank paper...could anything be more basic and uncontroversial? Who'd have thought those innocuous white sheets could cause such a ruckus? Learn what the fuss is about and why paper mills and environmentalists are lining up on either side of the presses.

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

Book Design

An overview of the typical components of a printed technical book and the typical content, format, style, and sequence of those components.

McMurrey, David A. Illuminati Online (2001). Articles>Document Design>Publishing

Book Layout, PDF Creation, Preparing Documents for Press

This is a 10 hour, 5 week course taught one-on-one or in a small group (2-5 people) that is an introduction to the Adobe InDesign application. In the course we will cover the fundamentals of designing rich documents, including books, pamphlets, and posters.

Newman, Rob. University of California San Diego (2004). Academic>Courses>Document Design>Printing

Booklet Publishing

Write a book this afternoon. Sound preposterous? To the contrary--you can create an information-packed, 16-page booklet using a single sheet of paper in little more time than it takes to type the text. Use it to market your product or service, to tell the story of your organization or to offer tips and how-to information to prospects and clients. Print five or ten copies directly from your laser printer or take your master artwork to a commercial printer and have it reproduced by the thousands. No matter how you cut, fold and staple it, this book is proof-positive that big things do come in small packages.

Chuck Green. Ideabook.com (1999). Design>Document Design>Prepress>Printing