Journal of Technical Writing and Communication
1534 articlesJanuary 2001
-
Constructing Usable Documentation: A Study of Communicative Practices and the Early Uses of Mainframe Computing in Industry ↗
Abstract
This study suggests that documentation is a complex technical communication genre, encompassing all the texts that mediate between complex human activities and computer processes. Drawing on a historical study, it demonstrates that the varied forms given to documentation have a long history, extending back at least to the early days of commercial mainframe computing. The data suggest that (1) early forms of documentation were borrowed from existing genres, and (2) official and unofficial documentation existed concurrently, despite efforts to consolidate these divergent texts. The study thus provides a glimpse into the early experimental nature of documentation as writers struggled to find a meaningful way to communicate information about their organization's developing computer technology.
-
Testing the Usability of Interactive Visualizations for Complex Problem-Solving: Findings Related to Improving Interfaces and Help ↗
Abstract
In visual querying, users analyze data for their decisions and problems by interacting with graphics that are dynamic and linked. This querying paradigm is new, a dramatic break from the more familiar retrieving of data via search statements and displaying of it in static charts and graphs. For this new visual querying paradigm, analysts conceptually and operationally need to master new approaches. To discover salient relationships, they need to manipulate displays. To drill down for detail or causes, they have to select data of interest directly from a graph. And to draw inferences, they have to consider meanings across several dynamically linked graphics. With the aim of studying users' success in these new approaches, particularly focusing on the approach of directly selecting data from graphs, I conducted a scenario-based usability test with 10 data analysts. They interacted with visualizations to complete a realistic complex analysis—evaluating employee performance. Test findings reveal a range of difficulties in visual selection that, at times, gave rise to inaccurate selections, invalid conclusions, and misguided decisions. To overcome these difficulties, support for visual selection needs to be built into interfaces and help. Results and recommended improvements are presented.
October 2000
-
Abstract
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.
-
Abstract
The basis for effective scitech communications is formed by: focusing on the needs of the audience; structuring the substantive and language content accordingly; concentrating on accuracy, clarity and brevity; meeting logical requirements; and presenting in a communicative style and layout, including the use of visuals. In many scitech communications, the Appendix is the right place for detail not of immediate interest to most readers; this option is grossly under-utilized.
-
Speaking Ebonics in a Professional Context: The Role of Ethos/Source Credibility and Perceived Sociability of the Speaker ↗
Abstract
Within a theoretical context of speech accommodation theory, this study follows Lambert et al.‘s (1960) “matched-guise” technique. Seventy-two African-American students at a mid-south university listened to and evaluated a tape-recorded excerpt of a speech given by Jesse Jackson at the 1996 Democratic National Convention. The first version of the speech was translated into Ebonics. After students listened to the first four-minute speech in Ebonics, students then proceeded to answer a questionnaire concerning the ethos/source credibility and perceived sociability of the speaker. Next, students listened to the same audiotaped speech (given by the same speaker), except the text of the speech was translated (and subsequently delivered) in Standard English. The students then rated this second speaker on those same ethos/source credibility and sociability scales. The speaker who used Standard English was viewed as more credible (i.e., more competent and having a strong character) and sociable than the Ebonics speaker. Both of these scores were significant at the p .05 level. Future research replicating these results is urged across other African-American samples.
-
Abstract
Teachers at all levels of college instruction use service learning, a popular pedagogical tool since the mid-eighties, to teach students both social consciousness and pragmatic, real-world writing skills. This article explores the concept of service learning as rhetorical action in the field of technical communication in general, and the question of whether service learning is appropriate in beginning level technical writing courses. Using my experience through two years of service learning instruction in community college classes, I respond to the charge that students in lower-division courses may lack the maturity to successfully enact service learning assignments. I also analyze the appropriateness of the community college as a catalyst for community-based writing projects.
-
Abstract
Structured abstracts contain more information, are of higher quality, and are easier to search and read than are traditional abstracts. However, there is a bewildering variety of ways in which structured abstracts can be printed and little is known about how the typography of structured abstracts can affect their clarity. The aim of this article is to delineate some of these major typographic variables and to comment on their effects upon the layouts of structured abstracts.
July 2000
-
Plain English in Corporate Disclosures: Review and Implications for Consumers, Producers, and the Free-Market System ↗
Abstract
The Internet is revolutionizing the investment world. There are clear benefits to these changes, including lower costs and faster access to the market for investors. There also are consequences to these changes when investors take risks without having access to clear, accurate, and full disclosures. In a free-market system, investors must have access to information they can understand and use autonomously to have full and equal access to the investment market. The Securities and Exchange Commission (SEC) recently passed a rule requiring businesses to use plain English to try and rid disclosures of their traditionally complex and ambiguous language. However, SEC's rule only addresses the front and back sides of prospectus disclosures. Consequently, the success of plain English will depend on the writer and business using it. Public corporations committed to using plain English will empower investors with the information they need to participate in the market freely and safely. In return, businesses will create a more effective and efficient free-market system by maximizing utility, benefiting producers, consumers, and the market as a whole.
-
Book Reviews: Rhetoric, the Polis, and the Global Village: Selected Papers from the 1998 Thirtieth Anniversary Rhetoric Society of America Conference: Scientific Discourse in Sociohistorical Context: The Philosophical Transactions of the Royal Society of London, 1675–1975: Electronic Literacies: Language, Culture, and Power in Online Education: Technical Report Writing Today: Writing for the Technical Professions: Plato on Rhetoric and Language: The Future of the Electronic Marketplace: Meaning in Technology ↗
-
Abstract
Advocates of brain-based learning have argued that instructional methods, to be successful, must be based on an understanding of how the brain processes information. In the past most descriptions of neurocognitive function were largely speculative, relying on theoretical constructions of how we believed the brain to work. Recent advances in functional imaging—Positron Emission Tomography and Magnetic Resonance Imaging—have, however, opened the brain to empirical study. This article will consider the potential importance of brain study for composition instruction, briefly describe functional imaging techniques, and review the findings of recent brain-mapping studies investigating the neurocognitive systems involved in language function. In short, understanding how language systems are organized in the brain represents the first step in our attempts to create brain-compatible instructional methods in the composition classroom. Following a review of the recent literature, the article will consider the possible implications of this information for pedagogical practice.
-
Abstract
This article describes the linguistic and semantic features of technocratic discourse using a Systemic Functional Linguistics (SFL) framework. The article goes further to assert that the function of technocratic discourse in public policy is to advocate and promulgate a highly contentious political and economic agenda under the guise of scientific objectivity and political impartiality. We provide strong evidence to support the linguistic description, and the claims of political advocacy, by analyzing a 900-word document about globalization produced by the Australian Department of Foreign Affairs and Trade (DFAT).
-
Abstract
This article aims to expound the importance of a knowledge of linguistics and the theories of human language to a technical author. Linguistics is often seen as a specialised branch of language for language experts. When technical authors communicate, they do need the tools of linguistics to handle the rhetorical grammar and patterns of technical prose. The linguistic features and semanics involved in technical writing also become relevant, as is visual and graphic representation.
April 2000
-
Abstract
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 outlook 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.
-
Book Reviews: The Copyright Book: A Practical Guide: Worlds Apart: Acting and Writing in Academic and Workplace Contexts: Electronic Literacies: Language, Culture, and Power in Online Education: Literacy in a Digital World: Teaching and Learning in the Age of Information: Art Information and the Internet: How to Find It, How to Use It: Writing in the Sciences: Exploring Conventions of Scientific Discourse: Scientific Discourse in Sociohistorical Context: The Philosophical Transactions of the Royal Society of London, 1675–1975 ↗
-
Abstract
The foundation for Rome's imperial bureaucracy was laid during the first century B.C., when functional and administrative writing played an increasingly dominant role in the Late Republic. During the First and Second Triumvirates, Roman society, once primarily oral, relied more and more on documentation to get its official business done. By the reign of Augustus, the orator had ceded power to the secretary, usually a slave trained as a scribe or librarian. This cultural and political transformation can be traced in the career of Marcus Tullius Tiro (94 B.C. to 4 A.D.), Cicero's confidant and amanuensis. A freedman credited with the invention of Latin shorthand (the notae Tironianae), Tiro transcribed and edited Cicero's speeches, composed, collected, and eventually published his voluminous correspondence, and organized and managed his archives and library. As his former master's fortune sank with the dying Republic, Tiro's began to rise. After Cicero's assassination, he became the orator's literary executor and biographer. His talents were always in demand under the new bureaucratic regime, and he prospered by producing popular grammars and secretarial manuals. He died a wealthy centenarian and a full Roman citizen.
-
Learning-To-Communicate and Communicating-To-Learn in Veterinary Medicine: A Survey of Writing, Speaking, and Reading in Veterinary Medical Curricula ↗
Abstract
This article reports the results of a survey of thirty-one colleges of veterinary medicine in the United States and Canada to identify common writing, speaking, and reading tasks performed by veterinary medical students and practicing veterinarians. From the twenty-seven colleges that responded (87% response rate), we learned that writing, speaking, and reading tasks are assigned in almost every veterinary medical course and that the communication tasks assigned in veterinary medical courses accord well with the communication tasks expected to be performed by practicing veterinarians. Along with these learning-to-communicate tasks, veterinary medical students are also assigned communicating-to-learn tasks. Unlike many of the writing-to-learn tasks associated with writing-across-the-curriculum programs, communicating-to-learn tasks in veterinary medical courses seem concerned with teaching students to think like veterinary medical practitioners. The emphasis on communication in veterinary medical curricula is probably due to some extent to the emphasis on problem-based learning, a curricular innovation popular in veterinary medical education. Problem-based learning requires that instruction be designed around cases or problems to be solved rather than topics or information to be covered. This merging of research and practice in the education of veterinary medical students may offer lessons for the education of professional practitioners in technical communication.
-
Abstract
This longitudinal study was conducted to identify trends in entry-level technology, interpersonal, and basic communication competencies and skills using entry-level classified newspaper advertisements from ten standard U.S. metropolitan statistical areas. Two competencies and one skill were selected from the “Workplace Know-How's” identified by the 1991 U.S. Department of Labor Secretary's Commission on Achieving Necessary Skills (SCANS). Specifically, ads including interpersonal competencies increased for the fourth consecutive year; ads including basic communication skills increased for the second consecutive year. Ads including technology competencies decreased slightly; however, the overall trend for technology remains strong. Therefore, the workplace continues seeking the competencies and skills advocated by the SCANS authors.
January 2000
-
Influence of Burke and Lessing on the Semiotic Theory of Document Design: Ideologies and Good Visual Images of Documents ↗
Abstract
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.
-
Abstract
This article supplements existing rhetorical scholarship by returning to the notion of invention as general preparation of the communicator. Although much scholarship about invention in technical communication exists, it consists mainly of heuristics, checklists, ethical considerations, and audience awareness. Part of invention is using basic strategies to prepare the communicator to assess any communication situation and its context and to generate the appropriate discourse. Rhetorician Kenneth Burke's theories of dialectic and rhetoric are a twentieth-century version of this; this article explains important Burkean strategies such as etymological extension, limits of agreement with the thesis, finding the complex in the simple, expanding the circumference, translation or alembication, the four master tropes, and the pentad, and it shows how to apply these in technical communication. The article closes with a classroom assignment that uses Burkean invention strategies.
-
Abstract
Although studies of actual communication practices in the workplace are now commonplace, few historical studies in this area have been completed. Such historical studies are necessary to help researchers understand the often complicated origins of genre conventions in professional discourse. Historical research that draws on contemporary genre theory helps address this void. A genre perspective is particularly valuable for helping researchers trace a given type of document's emergence and evolution. This perspective also provides a way of accounting for the connections between communicative practices and the other activities that occupy the attention of workplace organizations. To illustrate what this perspective brings to historical research in professional communication, I examine the development of communicative practices at a national production company that relied on texts to mediate its organizational activities across geographically dispersed locations.
-
Abstract
Ethics as a topic in technical communication has grown in interest in the past quarter century as the field itself has matured. We now understand technical communication as involved in communicating not only technical information but also values, ethics, and tacit assumptions represented in goals. It also is involved in accommodating the values and ethics of its many audiences. This understanding is linked to an awareness of the social nature of all discourse and the root interconnectedness of rhetoric and ethics. This article presents an introduction and annotated bibliography of articles from technical writing and communication journals over this period, arranged in categories of professional, academic, and systematic approaches. Ethics is broadly conceived to include not only particular theories but also systems of values and principles.
-
(RE)Constructing Arguments: Classical Rhetoric and Roman Engineering Reflected in Vitruvius' De Architectura ↗
Abstract
Augustus is often described as the emperor who transformed Rome from a city of brick to a city of marble. When he returned victorious to Rome in BCE 29, Augustus embarked on a project to rebuild Rome with the splendor its new imperial status demanded. Despite the tranquility and prosperity enjoyed by most Romans during the Early Empire, many also felt a sense of loss. Much had changed in their social order at the end of the Republic. The nobility and the lower classes began to share more interests and Roman society took on a more egalitarian and commercial nature. Under Emperor Augustus, the function of rhetoric was stripped from legislative arenas and confined mainly to legal courts and ceremonial competitions. In the spirit of renewed patriotism and pragmatism, principles of rhetoric were also applied to writing about technical subjects, such as engineering and architecture. Both Vitruvius and Cicero used his writing to persuade Roman citizens to reclaim their heritage: of building arts in Vitruvius' case; of philosophy and meaningful public oratory in Cicero's case.
October 1999
-
Abstract
Despite claims for at least the past quarter century of mature professional status for the field of technical communication, studies in the history and sociology of the professions provide criteria that suggest we are not yet truly a profession. This article reviews economic, sociopolitical, and ideological factors that characterize the modern professions and argues that the technical communication field, at best, only partially meets the criteria. The prospects for professional status of technical communication might be improved by developing a critical consciousness of the processes of professionalization and concertedly acting in ways that facilitate those processes.
-
Abstract
This article examines the communicative categories and linguistic features of university textbook prefaces. The textbook preface is a highly interactive genre, with a double purpose: informative and promotional. The analysis of the genre moves and of their realization reveals that the preface is used by the author both to help the audience use the book and to convince them of the value of the book. This twofold purpose accounts for the most relevant features of prefaces: the frequent use of textual metadiscourse and the pervasive presence of evaluation. The criteria used in the preface to evaluate the textbook are related to the audience's expectations about introductory textbooks: novelty, usefulness, accessibility, comprehensiveness, importance, and interest.
-
Abstract
The redefinition of logos as an appeal to logic is a mistaken association found all too often in the technical communication classroom. Logic inheres in all three proofs of persuasion; moreover, Aristotle used logos within the context of classical rhetoric to refer to the argument or speech itself. In this light, the proofs of persuasion represent the set of all logical means whereby the speaker can lead a “right-thinking” audience to infer something. If that something is an emotion, the appeal is to pathos; if it is about the character of the speaker, the appeal is to ethos; and if it is about the argument or speech itself, the appeal is to logos. This interpretation reinstates all three proofs of persuasion as legitimate, logical means to different proximate ends and provides a coherent definition of logos, consonant with Aristotle's Rhetoric, to the next generation of technical communicators.
-
Abstract
This philosophical article explores individuality and innovation (creating new technology) as they relate to the communication approaches of scientists, engineers, and technologists. I suggest that effective communication between technical and non-technical people is difficult because technical communication lacks humanity, a personal dimension. I also suggest that dimension is lacking because technical people give up their identity to be considered competent and I argue that a different approach to communication education for scientists, engineers, and technologists is required to equip them with requisite communication skills to make their personal contribution to successful innovation.
-
Abstract
This study attempts to show how the purpose of three types of business and technical documents (instructions, annual reports, and sales promotional letters) affects the syntactical and rhetorical choices authors make in writing these documents. While the results of the examination rendered some predictable results, there were some surprises in the absence of many rhetorical schemes in sales promotional letters. Another value of this study is that it provides partial syntactical and rhetorical “fingerprints” of three important documents in business and technical writing to offer students norms they can go by in constructing such documents.
-
Abstract
Classical rhetorical theory has been used for relatively discrete, practice-oriented purposes in its application to teaching Scientific and Technical Communication. However effective these appropriations are, they isolate these resources from a comprehensive framework and from that framework's role in shaping disciplinary practice. Because these theoretical assets are integral to each student's preparation to be an effective, responsible practitioner, I have developed and taught an upper level rhetorical theory course for STC majors that is grounded in Aristotle's On Rhetoric and in his understanding that effective communication is a systematic tekhne/art.
-
Abstract
This conceptual article presents a critical review of gender-difference and gender-sameness theory and research. The focus is upon gender workplace communication, a topic often debated in the popular and organizational literature. A contextually-based integrated paradigm is proposed which represents a shift from a gender-difference foundation to a more integrated approach that includes the interaction of gender with Standpoint Theory, culture, organizational climate, and structure and task context. The network of shared meanings concept is introduced as having a major impact on gender communication orientation. Research using an example of communication to create a contextual meaning for social support is highlighted. Implications and conclusions for organizations, researchers, and educators are discussed.
July 1999
-
Abstract
Some reading researchers and technical communicators assume the efficacy of readability formulas. Reading researchers use such formulas to equalize the reading difficulty of texts used in experiments. Results of an informal Internet survey indicate that some professional writers and editors use readability formulas that are integrated into word-processing software. This article proposes that readability formulas fail to predict text difficulty. The results of an experiment demonstrate that “text difficulty” is a perception of the reader and therefore cannot be objectively calculated by counting syllables, word length, sentence length, and other text characteristics.