Low-Cost, Flat-File XML for the Masses  

When you hear about XML publishing, you mostly hear about databases, workflow tools, and content management systems. These are typically costly systems aimed towards the information management needs of larger enterprises, where the sheer volume of information pumped through these systems provides a fairly rapid return on investment. This fosters the perception that you need one of these complex, expensive, enterprise solutions to use take advantage of the modularity and flexibility of authoring in XML. That is simply not true. You can realize the benefits of publishing from modularized XML, without the expense of an enterprise publishing system, by implementing the authoring environment on top of nothing more than your operating system's file system. Although this environment is not adequate for enterprise publishing needs, it is more than adequate for the needs small writing teams, businesses with a limited number of related products, proof-of-concept demonstrations, and even home users. The AIC documentation group at Cisco Systems has implemented such an authoring environment. We have been able to reuse and re-purpose modular, XML-based information without implementing a database back end. By examining how the AIC team implemented XML in a flat-file environment, you will see: * the decisions you need to make before implementing a flat-file XML system * the trade-offs, drawbacks, and pitfalls of implementing a flat-file environment (as compared to a database publishing environment) * the benefits of XML that are still available, even without the database * a migration path to a more traditional publishing environment

Willebeek-LeMair, Jason. IDEAlliance (2001). Presentations>Publishing>XML>Writing

Nominalizations and Their Impact on Readers  

The study presented here examined the effect of nominalizations in technical documents on readers’ recall and comprehension. Subjects read one of two technical passages in either a nominalized or denominalized form, and took recall and comprehension tests. Results indicate that denominalized passages can help readers retain more information when the original nominalizations are critical to the readers’ understanding of the passage.

Spyridakis, Jan H. and Carol S. Isakson. STC Proceedings (1996). Presentations>Writing>Grammar

Open Source For Technical Writing Teams

A presentation introducting how to support technical documentation teams with open-source tools.

SlideShare (2007). Presentations>Collaboration>Technical Writing>Open Source

Organizing Your Argument  

This presentation reviews the elements of an organized essay, including the introduction, the thesis, body paragraphs, topic sentences, counterarguments, and the conclusion. The twenty-one slides presented here are designed to aid the facilitator in an interactive presentation about constructing a well-organized argument. This presentation is ideal for the introduction of argument to a composition course, the beginning of a research unit, or the assignment of a written argument.

Liethen, Jennifer Kunka. Purdue University. Presentations>Slideshows>Writing

Preparing Writers for a Global Role in Technical Communication through Metacognition, Transfer, and Learning to Learn  

We have added so many visual and electronic aspects to our courses that there is little time for the basic skill of technical communication—clear writing that communicates a specific message to a specific audience for a specific purpose. Because we cannot provide instruction in all skills and strategies students need for all jobs now and in the future, we should focus on the basic concepts required for writing any document in any medium. We must help students learn to transfer the skills and strategies for one communication project to the next; we must help them learn to learn.

Boiarsky, Carolyn. STC Proceedings (2001). Presentations>Writing>International

Presentation on Writing and Web 2.0

This is presentation Keith Hoffman gave on writing and Web 2.0 at the University of Wisconsin. If you recall, Keith wrote the feature article in January's Intercom on Web 2.0.

Hoffman, Keith. Tech Writer Voices (2007). Presentations>Web Design>Writing>Podcasts

Producing Site-Specific Training Materials: How Technical Communicators Can Increase Job Security  

According to the SCANS report, '80 percent of the workers on whom American employers will depend as we enter the 21st century are already on the job.' Onsite employee training and retraining must become a major focus for American companies. Technical communicators can develop site-specific training materials for their employers, but they will need to 'speak another language' in order to communicate the potential savings and benefits to management. Technical communicators who produce site-specific training materials can increase their job security by increasing their employer's ability to compete.

Wietelman, Sherry S. STC Proceedings (1994). Presentations>Documentation>Writing

Rediscovering the Technology of English  

Although an expertise in language is our most fundamental, critical asset as technical communicators, it is the skill-set most often taken for granted, undervalued, or inadequately applied. Nevertheless, the huge increase in information competing daily for our readers’ time and attention makes the need for clear, concise, and accessible information products more essential than ever.

Collins, William L. STC Proceedings (2000). Presentations>Writing

Research and the Internet  

This presentation introduces your students to methods for effectively searching the World Wide Web and evaluating the content of web pages. The twenty-four slides presented here are designed to aid the facilitator in an interactive presentation of search and evaluation strategies. This presentation (our most requested workshop!) is perfect for the beginning of a research unit in a composition course or for any research assignment that requires the use of Internet sources.

Liethen, Jennifer Kunka. Purdue University. Presentations>Slideshows>Writing

Sentence Clarity and Combining  

This presentation is designed to teach your students about common sentence clarity problems, including misplaced modifiers, dangling modifiers, and passive voice, as well as strategies for combining sentences together. The twenty-nine slides presented here are designed to aid the facilitator in an interactive presentation of methods for improving sentence structure. This presentation is suitable within any course as a refresher to common sentence problems.

Liethen, Jennifer Kunka. Purdue University. Presentations>Slideshows>Writing

The Sequential Order of Instructions: Impact on Text Quality  

In written instructions, the sequential order of procedural steps is crucial for effective and efficient performance. In this paper we demonstrate several “rules” for optimizing instructions in this respect: First things first: put instructions in an order that prevents users from neglecting important steps. Minimize cognitive load: put instructions in an order that allows readers to forget what they read. Save time and effort: put instructions in an order that “on average” requires as little time as possible of the readers.

Steehouder, Michael F. and Carel J.M. Jansen. STC Proceedings (1996). Presentations>Documentation>Writing

Simplified English Roundup: Fait Accompli or Impossible Dream?  

The increase in the number of products with accompanying documentation sold around the world has shown the need to develop some form of controlled English guideline. Simplified English is just one type of controlled English. The apparent benefits of writing in controlled fashion has led some to consider it a panacea. Others, however, have urged caution in accepting controlled English as the solution to all problems in the comprehension of documents. All forms of controlled English have certain essential features that any technical writer can accept.

Calistro, Ralph F. STC Proceedings (1993). Presentations>Writing>Style Guides>Minimalism

Survey Of Computer-Supported Writing Facility Use In Technical Communication Programs  

Just as the profession of technical communication is fundamentally linked with the use of computers, so technical communication education and computer labs go hand-in-hand to prepare students for the professional world. Because of the importance of computer instruction, we need to discover how technical communication (TC) programs are managing these expensive yet quickly outdated facilities. Described here are the results of a survey of TC program directors questioned about their computer-supported teaching facilities. A profile of a 'typical' computer lab in a technical communication program is offered.

Wharton, Kim Tresselt. STC Proceedings (1994). Presentations>Writing>Workplace>Macintosh

Teaching Audience in Technical Communication  

Teaching technical writing students how to communicate with the different audiences of technical documents requires defining those audiences. Traditional division of audiences by educational level or job function fails to consider the readers’ familiarity with the subject and their interest in it. This paper sets up three categories of audience (lay, middle, and expert) and suggests how to communicate effectively with each, to help students prepare to create documents designed for different audiences.

Samson, Donald C., Jr. STC Proceedings (1993). Presentations>Rhetoric>Writing

Review: A Tech Writer Crosses Over to Marketing and Becomes a "Webinarian"  

Have you ever considered taking on marketing duties at your present job, or even transitioning to a new career as a 'marketeer'? Wistfully, you dream of sipping martinis with your attractive new coworkers under the department’s neon sign, 'Marketing—Two Drink Minimum,' before heading home empty-handed at 5 p.m. Oh, wait a minute—that was a Dilbert cartoon.

Janczy, Amy. STC Four Lakes (2002). Resources>Reviews>Presentations>Technical Writing

Technical Writing

Plan; know your purpose, audience and scope; leave enough time to write and edit several drafts; don't bore the reader.

Kirk, Elizabeth J. and Mary Wiberg. AAAS. Presentations>Scientific Communication>Writing>Technical Writing

Technical Writing: An Overview  

A PDF document intended as a resource for teachers. The overview handout defines technical writing, lists examples, states rationale for teaching technical writing, reviews principles for writing instruction, explains basic technical writing concepts to be taught to students, and outlines methods for evaluating technical writing.

Zuidema, Leah A. Michigan State University (2003). Presentations>Writing>Technical Writing

Tips for Writers and Publishers: Making the Most of Acquisitions Programs  

The production of books that suit a publisher’s guidelines and find their appropriate market requires a perfect match of publisher and author. This panel discussion will explore the dynamics of authors and publishing professionals working to achieve that match. Acqui-sitions professionals and a technical book writer and editor will pro-vide information about what publishers expect from manuscripts and how they work with authors, suggest how writers can find the right publishers for their books, and describe how one successful techni-cal book acquisitions program was built. The discussion should be of interest to technical writers and editors hoping to publish and to publishing professionals in the trade or college book market.

Sakson, Donna M., Ted Buchholz, Eric Stroo and Jennifer M. Ginn. STC Proceedings (1993). Presentations>Writing>Publishing

UNIX Man Pages  

Experienced programmers find the man pages very useful but a naive user often finds them overwhelming.

Gururaj, B.S. STC India (2003). Presentations>Documentation>Technical Writing>UNIX

The Use Of Computerized Readability Formulas: Bane Or Blessing?  

A survey of 39 communicators in high-tech industries reveals low use of computerized readability formulas. Both technical and business communicators find current measures ill suited for the process or product of technical writing.

Shehadeh, Carol M. El. and Judith B. Strother. STC Proceedings (1994). Presentations>Writing>Assessment>Formulas

Using a Problem Focus to Quickly Aid Users in Trouble  

Users are encountering more and more situations where task dotumentation separates topics too much for the interconnected nature of the task. These complex processes require an approach that takes into account the effect of strategy on the outcome of the task. Users have to know what factors affect the quality and type of output, and the stages where branching will depend upon these choices. This paper deals with the methodology required to help users in trouble in complex tasks. It also presents the types of situations where this approach is most useful.

Hallgren, Chris. STC Proceedings (1997). Presentations>Writing>Rhetoric

Using Writing to Negotiate Knowledge and Power

In Language and Symbolic Power, Pierre Bourdieu demonstrates how the language practices of institutions can generate symbolic violence and relations of power. At the same time, these language practices make existing power relationships seem natural and thus hide the symbolic violence from both more and less powerful inhabitants of these sites. Research has only recently begun to examine critically these practices as they function in corporate America. This talk will examine textual practices within a large manufacturer of agricultural equipment to show how they require subordinates to document their work in forms determined by management. Such documentation represents work in terms acceptable to managers and prevents subordinates from developing alternative understandings of the possibilities of their labor.

Winsor, Dorothy A. University of Illinois (2001). Presentations>Writing>Streaming>Video

A View from the Crossroads: New Hope for the Technologically Oppressed  

Recent advances in technology have brought today’s technical communicators to a crossroads. Writers are faced with the choice of learning a host of new skills not related to traditional writing skills or of becoming dependent on specialists in other fields to complete the technical communication process. By viewing new technologies asopportunities rather than problems, writers can gain control of the media as well as the message, increasing their ability to control the entire communication process.

Weber, Barbara C. and Arthur H. Pike. STC Proceedings (1993). Presentations>Writing>Technology

What Do Technical Writers Do?  

Information session, suitable for general audience. (40 slides)

Walsh, Tina K. Read Pen Inc. (2004). Presentations>TC>Writing>Technical Writing

Who is the Author?  

Who should be listed as the authors of an article for a journal or conference proceedings? The basic requirement for authorship is that an author should be able to take public responsibility for the content of the paper. People who may have contributed intellectually to the work but whose contributions do not justify authorship may be acknowledged in the appropriate section of the paper.

Burgan, Murrie W. STC Proceedings (1994). Presentations>Rhetoric>Writing