Using Text Organizers  

Many technical documents are rich in text and poor in graphics. Not all documents have photographs and illustrations to provide the reader with visual cues. Text organizers can be used as a method for relieving the visual grayness that happens when a document is all text. Headlines, kickers, subheads, headers, footers, pull quotes, and bulleted lists are all text organizers that can be used throughout a technical document to promote a better flow of information.

Sadowski, Mary A. STC Proceedings (2002). Articles>Document Design>Visual Rhetoric>Technical Illustration

A Visible Ideology: A Document Series in a Women's Clothing Company    

Studying corporate documents provides clues to the larger philosophy of the organization. This article explores a sales document redesign that indicates a subtle shift in ideology for a women's clothing company. The corporation uses direct sales to market clothes to a variety of women. In one season, the documents change from relatively outdated designs to more updated, professional layouts. However, the content of the documents changes very little. The author contends that the document redesign indicates a move to a more feminist out-look for the company and uses the concept of ethos to describe how the document design represents a slowly changing ethos for the corporation. A specific content shift towards feminism is, however, less apparent.

Cronn-Mills, Kirstin. Journal of Technical Writing and Communication (2000). Articles>Document Design>Case Studies

Visual Texts: Format and the Evolution of English Accounting Texts, 1100-1700    

Emphasis on page design, as an aid to visual accessibility, did not receive attention in modern technical writing until the 1970s. However, accounting documents and instructional texts utilized format and document design strategies as early as the twelfth century to enhance the organization of quantitative data and linear bookkeeping entries. Format in text was used to reflect the arrangement used in oral accounting practices and to produce uniform documents. Thus, format was integral to the rise of pragmatic literacy of the commercial reader. During the Renaissance, these early format strategies received impetus from Ramist method. The result was design strategies that attempted to capture the rigid principles of organization fundamental to commercial accounting. These early accounting documents also illustrate the plain style that would become the focus of the later decades of the seventeenth century. Clarity in language paralleled clarity in page design for the sole purpose of eliminating ambiguity on the page and on the sentence level. Plain style was thus nurtured by financial forces long before the advent of natural science.

Tebeaux, Elizabeth. Journal of Technical Writing and Communication (2000). Articles>Document Design>Visual Rhetoric>History

What Do Manuals Say About Your Company?  

According to the Consumer Electronics Association, product returns represent a $10 billion-dollar-a-year problem for the consumer electronics industry. Technical support costs are spiraling (even with the migration to off-shore providers) while consumer satisfaction with this support is plummeting. New technology and expanded offerings to a stabilized market are increasing competition. What can manufacturers do to help combat these problems? Better consumer manuals are a start.

Manual Labour (2003). Articles>Documentation>User Centered Design

What We Can Learn About Document Design From A Study of the Visual Convergence of the News Media  

Information presentation trends that traverse media boundaries point to a visual convergence among print, television, and the web. Examination of how this process takes place through “remediation” in the news media provides insight into the broader media and cultural context in which technical documentation resides. Creating new knowledge for technical communicators who are beyond an elementary understanding of document design requires interdisciplinary research that investigates how usability is redefined in an age of visual convergence.

Cooke, Lynne. STC Proceedings (2002). Articles>Document Design>Visual Rhetoric

When Products Become Easy to Use, What's Next for Writers?

People who follow the right trends will someday lead them. Such an opportunity now lies in the hands of technical writers, as the computer field moves toward standardized, graphical, easy-to-use interfaces.

Oram, Andrew. Boston Broadside (1991). Articles>Usability>User Centered Design>Documentation

Where Is the Instruction in Online Help Systems?    

One of the ironic things about online help systems is that they are very often not helpful and even increase the user's frustration and stress level. This increased frustration sometimes results in the rejection of the software. One solution is to increase the effectiveness of online help systems by designing them from an instructional design perspective. Some of the things we can provide users include: imperative, task-focused procedures; graphic feedback; access to redundant instructions; links to tutorial practice; philosophical and conceptual explanations for 'why' they are completing specific tasks.

Pratt, Jean A. Technical Communication Online (1998). Articles>Documentation>Instructional Design>Online

Why Do All the Page Numbers in my Word 2002 Document Display as 0?

Word 2002 will display 0 for all page numbers in headers or footers, and all page numbers in a Table of Contents, in the following circumstances.

Kelly, Shauna. Word MVP Site, The (2002). Articles>Word Processing>Document Design>Microsoft Word

Why Does the Appearance (or Layout) of My Document Change When I Open it on a Different Machine?

Because Word is a WYSIWYG application, it will always try to represent on screen the result you will get if you print on the printer that is selected as the default. Changing printer drivers will almost always change the layout at least slightly and sometimes radically. There are a number of ways to minimize the changes.

Barnhill, Suzanne. Word MVP Site, The (2002). Articles>Word Processing>Document Design>Microsoft Word

Why Game Documentation is Essential to a Satisfying User Experience

Documentation and information organization are an integral part of video game construction. The video game industry may be one of the directions technical communicators will move toward in the near future.

Peterson, Martin. Usability Interface (2004). Articles>Documentation>User Experience>User Centered Design

Why Technical Communicators and Usability?

Why technical communicators and usability? Both writers and software development managers have asked me that question. In both cases, it springs from a narrow view of communicators as 'just writers.' It is a point of view that fails to see the many activities, from learning the subject matter to organizing the information or creating good document design, that are hidden behind that final task of writing the words.

Quesenbery, Whitney. STC Usability SIG (2000). Articles>TC>Document Design>Usability

Write Once, Use Many: Why and How We Make Product Information Modular  

Faced with growing demand from customers for specific courses, addressing only their needs, in very short time-frames, we had to re-examine the way we worked. Patching together one-shot customized coursework was labor-intensive for a non-homogeneous and unsatisfactory result. Each new customer request required repetition of the same amount of effort. With reduced turnaround time and dwindling human resources, a solution had to be found.

McClelland, Patricia J. and Alison Bourdel. STC Proceedings (1993). Articles>Documentation>Information Design>User Centered Design

XML and Documentation  

XML provides a robust, non-proprietary, and verifiable file format for the storage and transmission of text and data both on and off the Web. XML removes the complexity of SGML, making it easier to define your own document types, and to write programs to handle them.

Bokil, Manoj. STC India (2003). Articles>Documentation>Information Design>XML

XML Paper Specification (XPS) of a Word 2003 Document

Microsoft breathed new life into legacy office documents by opening an XML window (Office Open XML) to its office products through its royalty-free XPS specification. XPS stands for XML Paper Specification that specifies cross-platform, open standard, document representation that can be used for generating, sharing, printing and archiving of paginated documents. Its virtues in Microsoft's own words are, "With XPS, documents print better, can be shared easier, be archived with confidence, and are more secure."

Krishnaswamy, Jayaram. ASPAlliance (2007). Articles>Document Design>Microsoft Office>XML

Your Document Covers the Facts, But Does It Keep ’Em Coming Back?  

Much technical documentation merely describes the features or appearance of a product or service, leaving readers uninspired and disinterested. In fact, much of what we write probably never gets read. A combined audience, task, and benefits analysis can help us communicate why a user should do a task—not just how to do it.

Fritz, Anne, Jason R. Huntington, Bruce Knorr, and Judith Leetham. STC Proceedings (1995). Articles>Document Design>Usability

Investigating Presentational Change in U.K. Annual Reports    

This article examines structural and format changes in annual reports of U.K. listed companies from 1965 to 2004 with a particular focus on graph use. The article compares a new sample of 2004 annual reports with preexisting samples by Lee and by Beattie and Jones. Lee's identified trends continue. There has been a sharp increase in page length, voluntary information, and narrative information, particularly among large listed companies. A detailed analysis of voluntary disclosure indicates changes in the incidence and pattern of generic sections. Graph usage is now universal. However, key financial graph use has slightly declined, replaced by graphs depicting other operating issues. Impression management through selectivity, graphical measurement distortion, and manipulation of the length of time series graphed are common. Overall, annual reports continue to exhibit many features of public relations documents rather than financially driven, statutory documents, and the analysis of graph usage suggests a need for policy guidelines to protect users.

Beattie, Vivien, Alpa Dhanani and Michael John Jones. JBC (2008). Articles>Business Communication>Document Design>United Kingdom

Acrobat 7 zum komfortablen Erzeugen von Druck und Schnittmarken einsetzen

Wer kennt das Problem nicht? Aus einem riesigen Dokument wurde ein PDF erzeugt. Nun muss es auch noch für den Druck aufbereitet werden. Dafür fehlen aber die Druck- und Schnittmarken. Acrobat 7 hilft hier aus der Patsche.

TECOM (2003). (German) Articles>Document Design>Software>Adobe Acrobat

Web zu PDF

Mit dieser Technik steht Ihnen eine einfache Methode zur Verfügung, Webseiten oder einzelne Bereiche eines Webs downzuloaden und als PDF zu speichern.

TECOM (2003). (German) Articles>Document Design>Software>Adobe Acrobat

Visuals and Specialization Present Possibilities for Handling the Information Overload Crisis

Professional communicators and attorneys have long stood side by side as both fought to win in court—one in the court of law, the other in the court of public opinion. These two sometimes wary compatriots, however, are now beginning to partner more frequently to garner the best results for the executive suite.

Larkin, T.J. and Sandar Larkin. Communication World Bulletin (2005). Articles>Document Design>Visual Rhetoric>Charts and Graphs