Aligning Theme and Information Structure To Improve The Readability Of Technical Writing    

The readability of technical writing, and technical manuals in particular, especially for second language readers, can be noticeably improved by pairing Theme with Given and Rheme with New. This allows for faster processing of text and easier access to the "method of development" of the text. Typical Theme-Rheme patterns are described, and the notion of the "point of a text" is introduced. These concepts are applied to technical writing and the reader is then invited to evaluate the improvements in readability in a small sample of texts.

Moore, N.A.J. Journal of Technical Writing and Communication (2006). Articles>Writing>Technical Writing>Rhetoric

Engaging and Educating Readers Through a Progressive Writing

Although technical communication documents cannot possibly be tailored to exactly match the interest, reading level and many-faceted influences of a reader, they can I believe, take measures to engage the reader to believe that the information he or she is receiving from the document is valuable to their experience in some way.

Comstock, Jeanie. Orange Journal, The (2003). Articles>Writing>Rhetoric>Technical Writing

Implicature, Pragmatics, and Documentation: A Comparative Study    

This study investigates the link between the linguistic principles of implicature and pragmatics and software documentation. When implicatures are created in conversation or text, the listener or reader is required to fill in missing information not overtly stated. This information is usually filled in on the basis of previous knowledge or context. Pragmatics, the study of language use in context, is concerned with the situational aspects of language use that, among other things, directly affect implicatures required of the reader. I investigate how two manuals for the same software product can be analyzed on the basis of implicature and pragmatics. One is an original copy of the documentation that came with the product, the other an after-market manual. Results show that the aftermarket manual requires far fewer implicatures of the reader and does a better job of providing pragmatically helpful information for the user.

Wright, David. Journal of Technical Writing and Communication (2007). Articles>Documentation>Rhetoric>Technical Writing

Modeling Rhetoric in Scientific Publications    

Despite the advent of computer-centered ways of creating and accessing scientific knowledge, the format of the scientific research article has remained basically unchanged. We have developed a model of a more appropriate form for research publications to structure scientific articles, based on a rhetorical structure which is ubiquitous in (natural) science papers. The model has three components: defining rhetorical elements inside the documents, the identification of the argumentational relationships between these elements; and the connection of data elements and entities to external sources.

de Waard, Anita, Leen Breure, Joost G. Kircz and Herre van Oostendorp. INSCIT (2006). Articles>Scientific Communication>Rhetoric>Technical Writing

The Nature of the Narrator in Technical Writing  

Writers of technical information need to be aware of their rhetorical stance and think of themselves as narrators, as people telling other people about something or how to do something or what they propose to do. Too often writers of technical information write in passive voice and third-person narrative perspective, disguising or blurring their involvement in the activities they describe and often blurring and dulling the information as well. Writing in active voice and, when appropriate, the first person, enlivens information, removing it from the realm of the stuffy and stale.

Deming, Lynn H. STC Proceedings (1993). Articles>Writing>Technical Writing>Rhetoric

Nuclear Information: One Rhetorical Moment in the Construction of the Information Age  

Since the late 1970's we have been said to be living in the information age, and that name has stuck, with the phrase increasingly appearing throughout the closing decades of the millennium. The slogan, like all slogans, attempts to assert unity in the face of complexity; nonetheless, it captures, better than most such slogans, a dominant theme of almost all aspects of our everyday life. The slogan has its visual icons in advertising and journalism: binary bits flashing down wires and across the sky, tied to no location and independent of the humans who may need or use that information. Information has become an abstract universal, like atoms and electrons, to create or serve any entity, in no particular configuration, serving no particular purpose, gathered and used by no particular people (but of course provided or facilitated by specific companies who make this information their business). Information, however, is a human creation for human purposes, even if our devices now produce terrabytes of signals that travel only to other devices, never to be seen or touched by humans. This essay recovers a small piece of the history by which we constructed our understandings and uses of information, so that information has become pervasive in everyday life, needs, and action. It considers how information came to have major governmental and military meanings to the U.S. public during World War Two and after, and how an anti-nuclear test activist group asserted an alternative understanding of information to foster public opposition to government policy. This rhetorical reconstruction of information advanced a culture of citizen information, validated by citizen scientists to serve the needs and concerns of citizens, which pervaded the anti-war, environmental, and consumer movements that became our everyday reality in the second half of the century. Such citizen information embodies multiple assumptions about threats to everyday life, the necessity of reliable and up-to-date information for action to oppose the threats, large institutions whose interests are served by the threatening situation and which limit access to relevant information, science as an independent and objective source of information, and the responsibilities of a citizen to be informed.

Bazerman, Charles. UCSB. Articles>Scientific Communication>Technical Writing>Rhetoric

The Rhetoric of Critical Procedures

One important aspect of technical writing is the production and use of procedures. Though technical writing serves a variety of purposes, teaching, informing, persuading, and even questioning, one of its primary and most common purposes is the 'how-to' function of providing procedures. There is a great deal of information available on writing procedures, the vast majority of it focusing on software documentation and product documentation.

Boelter, Walter H. Orange Journal, The (2003). Articles>Documentation>Rhetoric>Technical Writing

They'll Thank You for Sharing: Make Those Reports, Memos and White Papers Clear and Readable

Words, words, words. It seems as if we're being asked to write something every minute for every need and occasion. Your boss wants a report; your colleagues need a memo explaining a procedure; your clients send e-mails that need to be considered and answered; your company's products or services should be described in a descriptive white paper, and on and on. How can you deal with all that? Are there any general writing rules that apply to business writing of all sorts?

Canavor, Natalie and Claire Meirowitz. Communication World Bulletin (2007). Articles>Business Communication>Rhetoric>Technical Writing

What Historical Rhetoric Concepts Can Tell Us about Contemporary Professional and Technical Writing Practices  

A study of how three historical rhetorical concepts (kairos, memoria, and mestiza consciousness) are relevant to professional communication practices today, and productive historical concepts for contemporary practitioners.

Haas, Angela. Michigan State University (2004). Articles>Rhetoric>History>Technical Writing

Whose Ideas?: The Technical Writer's Expertise In Inventio    

Compelling arguments from researchers studying the rhetoric of science have convinced both scientists and humanists that technical writing involves invention, or discovery of the available means of argument. If we agree that inventio is crucial to technical writing, however, we encounter a problem: namely, that the rhetor engaged in invention as part of a technical writing process does not necessarily have expertise in the subject matter of the composition. What, then, is the expertise that the technical writer contributes to the invention process? Working from the notion that knowledge is an activity rather than a commodity, I argue that a technical writer's expertise in invention lies in an ability to adapt rhetorical heuristics to situations of interdisciplinary collaboration. This focus expands our understanding of how invention works when the goal of communication is producing knowledge across disciplinary boundaries, rather than winning an argument with persuasive techniques.

Harkness Regli, Susan. Journal of Technical Writing and Communication (1999). Articles>Writing>Technical Writing>Rhetoric

Why Write Instructions That No One is Going to Read?

I know that a lot of people never read instruction manuals or online help. But you know what? Some people do.

HelpScribe (2008). Articles>Documentation>Rhetoric>Technical Writing

Your Reader

It is critically important to consider the needs of your reader when writing. If you can do this well, everything else follows naturally.

Young, V.L. and K.J. Sampson. Ohio University (2004). Articles>Rhetoric>Writing>Technical Writing