Hypertext for Handling Conceptual Material

Turning 'help' systems and 'browsers' into robust structured-document viewers: the DocBrowser.

Hoffman, Michael. Hypertext Navigation. Articles>Documentation>Web Design>Web Browsers

I Know What You Need to Know: Is that User Centered Documentation?

Quality management is forcing technical communicators to meet the challenge of writing user-centered documentation. Adequate preparatory work would be to categorize potential users according to experience, knowledge, tasks to be performed, and other use-relevant features. Users' requirements and requests should then be incorporated into the document's design.

Bock, Gabriele. TC-FORUM (1999). Articles>Documentation>User Centered Design

I Want to Include the Chapter Number with the Page Number in the Header

If you insist on doing this – and if you do, don't say I didn't warn you! – then the best procedure is as follows.

McGhie, John. Word MVP Site, The (2002). Articles>Word Processing>Document Design>Microsoft Word

IBM User-Centered Design for the Documentation Designer  

The user-centered design of documentation is an aspect of product design that has often been under-emphasized. Difficulties inherent in documentation design include obtaining user, feedback to high-level design objectives; extracting user. feedback specific to a product’s documentation. rather than to the product as a whole; and managing the various resource constraints inherent in product development. IBM User-Centered Design offers a solution to these difficulties by employing a set of user feedback methodologies from which the documentation designer, a member of a multidisciplinary design team, extracts pertinent data to set design objectives and follow through to low-level designs.

Righi, Carol and Lynn VanDyke. STC Proceedings (1996). Articles>User Centered Design>Documentation>Technical Writing

Ideas on Cooperation Between Suppliers and Users Regarding Documentation

Documentation, operators’ manuals, maintenance instructions, etc, can never be perfect and satisfy all users. The organization of the documentation, particularly for large systems, will never suit all users and there will always be some errors present. This means the supplier and the user need to cooperate in various ways to avoid the fatal consequences of errors and misinterpretations, and for the improvement of documentation over time.

Rullgård, Åke. TC-FORUM (2001). Articles>Documentation>User Centered Design

Implementation of Medical Research Findings Through Insulin Protocols: Initial Findings from an Ongoing Study of Document Design and Visual Display    

Medical personnel in hospital intensive care units routinely rely on protocols to deliver some types of patient care. These protocol documents are developed by hospital physicians and staff to ensure that standards of care are followed. Thus, the protocol document becomes a _de facto_ standing order, standing in for the physician's judgment in routine situations. This article reports findings from Phase I of an ongoing study exploring how insulin protocols are designed and used in intensive care units to transfer medical research findings into patient care 'best practices.' We developed a taxonomy of document design elements and analyzed 29 insulin protocols to determine their use of these elements. We found that 93% of the protocols used tables to communicate procedures for measuring glucose levels and administering insulin. We further found that the protocols did not adhere well to principles for designing instructions and hypothesized that this finding reflected different purposes for instructions (training) and protocols (standardizing practice).

Longo, Bernadette, Craig Weinert and T. Kenny Fountain. Journal of Technical Writing and Communication (2007). Articles>Document Design>Scientific Communication>Biomedical

Implementing New Desktop Publishing Tools  

When faced with having to respond to increased demands for online documentation using outdated tools, the technical writing staff of Hughes Network Systems (HNS) realized the need for a whole suite of state-of-the art tools and techniques. The challenge lay in convincing management to spend the time and money to acquire them. By coupling an understanding of their own needs as well as those of their customers with an appreciation for the HNS corporate culture, the writers were able to effect a strategy that guaranteed success.

Lipkin, Regina M. STC Proceedings (2001). Articles>Document Design>Software>Case Studies

Import Text Without Surprises

With a little forethought, placing text in InDesign becomes almost effortless.

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

Importing and Exporting Form Data in Acrobat

When using PDF forms, it's possible to export, store and import the data in Form Data Format (FDF). Since an FDF file only includes the form data and not the form itself, it is much smaller and more lightweight that the complete PDF form, making it more efficient to manipulate. This tip explains how to export and import FDF data using Acrobat.

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

Improving Document Quality Through Customer Visits  

In an effort to improve the quality of our documentation, our Information Development department personally visited over 80 of our customers in 10 different locations across the United States. Our goal was to find out what we needed to do to create documentation that would satisfy our customers' needs. We came up with a process for planning our visits, gathering the information from our customers, implementing their requirements, and increasing communication with them. From the visits, we not only made changes that immediately satisfied our customers, but we created an environment for them to work with us as a team.

Lass, Laura W. and Wendy L. Reed. STC Proceedings (1993). Articles>Documentation>Quality>User Centered Design

Improving Documentation Through Customer Feedback: A Case Study  

By soliciting and receiving customer feedback, writers learn how customers use existing documentation and what additional information customers may need. In May 2001, we began a formal process of gathering customer feedback for the IBM WebSphere Commerce Suite product. The first phase of this process involved two main initiatives: creating and promoting a documentation questionnaire for customers; creating and working with an internal test team that acted as customers. Feedback allowed us to determine which information strategies helped customers meet their business needs, and which areas we need to concentrate on in future releases.

Heximer, Erin and Lisa Wu. STC Proceedings (2002). Articles>Documentation>User Centered Design

Improving Documentation with Learning Techniques  

It is important to recognize that because we all differ in our experience and background the learning process is different for each of us. Consequently, in our documentation we should by to put users on an equal footing by, for example, clearly and exactly defining terms we use and including a glossary. We can also put everyone on an equal footing by using 'bridges to understanding,' from analogies, examples, and metaphors to mnemonic strategies. For overall comprehension, we can employ 'frameworks,' from conceptual maps to road maps, that give patterns of meaning to what we say.

Livingston, Dick. STC Proceedings (1993). Articles>Documentation>Instructional Design>Glossary

Increasing User Acceptance Of Technical Information in Cross-Cultural Communication    

A significant problem in technical communication is persuading the user that the information is accurate, valid, and useful. All too often, technical communicators treat users as members of their own culture. When authors do consider cultural issues, they often focus on matters such as vocabulary, visuals, and organization. Other strategies, however, can be useful in gaining acceptance of technical information in cross-cultural situations. For example, the communication theory of compliance-gaining offers suggestions for how the technical communicators can adapt the text to enhance user acceptance when communicating to members of their own culture as well as when communicating across cultures. Communicators can use promises, threats, demonstrate positive and negative outcomes, extend friendliness, etc., to develop the text. In this article, I will explain several compliance-gaining strategies authors can use, identify rhetorical strategies they can combine with compliance-gaining strategies, show how these strategies can be effective in a cross-cultural environment by comparing the strategies in two sample cultures, and analyze a brief sample.

Warren, Thomas L. Journal of Technical Writing and Communication (2004). Articles>Documentation>User Centered Design>International

InDesign Tutorial: Setting up a Document

Let's start with some basics. Here you will learn how to create a new document, add pages and other basic functions. A second tutorial will follow to complement this one.

Bruno, Elisabetta. Designorati (2005). Articles>Document Design>Software>Adobe InDesign

InDesign's Work Area

This tutorial goes through the different parts that compose InDesign's work area. If you want to drive a car, you want to make sure that you know where the break is, where your wheel is, where your indicator is and so on. The same is for InDesign. You want to know where you can find all the tools that you will be using to create your InDesign documents.

Bruno, Elisabetta. Designorati (2005). Articles>Document Design>Software>Adobe InDesign

Influence of Burke and Lessing on the Semiotic Theory of Document Design: Ideologies and Good Visual Images of Documents    

The syntactic aspect of semiotic theory, especially its "aesthetic principle," is very influential in document design theories and practices. It has its roots in Burke's and Lessing s gender-related theories of images. Thus, it is laden with ideologies: it embodies our patriarchal attitudes and our iconophobia. Employing the semiotic theory in document design, we are making choices to reinforce the gender-related ideology in Burke's and Lessing's theories. It is time for us to re-conceive the "aesthetic principle" by de-emphasizing it and to adopt the reconciliation approach to design effective documents targeted at various rhetorical situations.

Ding, Daniel D. Journal of Technical Writing and Communication (2000). Articles>Document Design>Visual Rhetoric>Theory

Information Layering: Providing Need-Based Information

Information Layering is not new, but it has acquired a new dimension through modern technical and interactive possibilities. Even as of now, this technique can be used to make HTML-help considerably more user friendly.

Achtelig, Marc. indoition engineering (2005). Articles>Documentation>User Centered Design>Online

Information Planning for Successful Online Documentation  

Creating an information plan should be the first phase of any publication development life cycle, whether hard copy or online. The plan is a tool for reporting the results of your research about your audience, their tasks, the market, and the product. The plan presents the basic organization and content of the publications you intend to build, effectively directing the documentation team to produce a publication with very specific goals in mind.

Stevens, Dawn M. STC Proceedings (1996). Articles>Information Design>Management>Documentation

The Ins and Outs of InDesign

If you ever create multi page layouts such as brochures, newsletters or booklets there is an application that is made for you. InDesign, which can be purchased as a stand alone product or as part of the Adobe Creative Suite, has many, many tools for streamlining the process of setting up and working on these types of projects. In this article we will look at what InDesign is for and highlight some of the features that set it apart from other applications.

Dudley, Kim. Community MX (2006). Articles>Document Design>Software>Adobe InDesign

Inserting Special Characters in FrameMaker

In Adobe FrameMaker, it is necessary to use special keyboard combinations to insert special typographic characters in your work. You can find an extensive list of special characters in FrameMaker's online help. You also can paste in special characters from Word or HTML.

EDITsphere (2007). Articles>Document Design>Software>Adobe FrameMaker

Instruction-Writing Exercises (for High School)

These guidelines and 14 scaffolded exercises respond to the unmet need for a psychologically solid, work-relevant way to learn technical writing by students who are NOT facile writers already.

Girill, T.R. STC East Bay (2001). Articles>Education>Instructional Design>Documentation

Instructional Design and Software Quality Assurance, Part I  

Describes how instructional design principles can improve documentation.

Nayar, Pawan. Intercom (2001). Articles>Documentation>Instructional Design

Instructional Design: Choosing the Proper Authoring Tool  

Searching for the right tool for your instructional design needs? Learn about your options through capsule reviews of instructional simulation programs and full-service authoring tools.

Holden, Gene. Intercom (2004). Articles>Documentation>Instructional Design

Instructions for installing Adobe PS 4.26 for Windows 95/98 And Attaching it to Acrobat Distiller for use with FrameMaker 5.5x, with Acrobat 3.0x  

Instructions for installing Adobe PS 4.26 for Windows 95/98 and attaching it to Acrobat Distiller for use with FrameMaker 5.5x.

Halva, Wade C. InFrame (1998). Articles>Software>Document Design>Adobe FrameMaker