Cover image for Technical writing basics : a guide to style and form
Title:
Technical writing basics : a guide to style and form
Personal Author:
Edition:
4th ed.
Publication Information:
Upper Saddle River, NJ : Prentice Hall, 2008
Physical Description:
xvi, 217 p. : ill. ; 23 cm.
ISBN:
9780132412551

Available:*

Library
Item Barcode
Call Number
Material Type
Item Category 1
Status
Searching...
30000010197459 PE1475 H64 2008 Open Access Book Book
Searching...
Searching...
30000010197460 PE1475 H64 2008 Open Access Book Book
Searching...

On Order

Summary

Summary

This concise and cumulative guide shows readers the art of technical writing for a variety of contexts and institutions. Using examples from the business and non-corporate world, the book emphasizes transactional writing through practical explanations, real-world examples, and a variety of "role-playing" exercises. Each section builds on the next as readers learn a variety of models of style and format. This edition features a stronger emphasis on electronic communication, integrated coverage of ethics, and more explanation of how to create technical documents that produce concrete results. Begins with the basics of technical writing (from fundamental components of technical communication, to templates of presentation, to construction of letters, memos, announcements and instructions) and then focuses on using these skills to construct short and long reports and a job search portfolio. Goes beyond the large corporate view to survey challenges within a variety of settings-e.g., small businesses, social services, the academy, the corporation. Anyone looking to improve their techincal writing skills.


Author Notes

Dr. Brian Holloway was born in Flushing, New York in 1952 and from an early age was fascinated by the written word, dramatic performance, and the wisdom inherent in world cultures. He holds a Ph.D. from the University of Illinois with a concentration in literature of the Renaissance, including Shakespeare, and has served as editorial consultant and on the editorial board of Shakespeare and Renaissance Association Selected Papers , volumes 22 and 23.

While in charge of Arts and Sciences at Mountain State University, Dr. Holloway headed the development of its graduate individualized study programs and its interdisciplinary general education program, Spectrum, which have enhanced the lives of many in West Virginia and other states as well. He also served as the editorial advisor of five volumes of the school's creative writing publication, Mountain Whispers .

The receipt of grants from the West Virginia Humanities Foundation allowed Dr. Holloway to pursue extensive research into the way that the book Black Elk Speaks was created as a collaboration between writer John Neihardt and Lakota holy man Nicholas Black Elk. This research grew into an elaborate project involving archival materials, field notes, family scrapbook photos, and narratives from the Neihardt family, with whom Dr. Holloway quickly became friends. Presentations at the Neihardt Center led to Dr. Holloway's becoming the editor of the Neihardt Journal for six volumes spanning 1999 to 2004.

Professor of English at Mountain State University in West Virginia, Dr. Holloway is also Dean of Graduate Studies. In that capacity he has taught and guided many students as they explore their academic horizons.

Dr. Holloway is the author of articles, poetry, and presentations. His text Technical Writing Basics , published by Prentice Hall, will soon be in its fourth edition. Proposal Writing Across the Disciplines , also published by Prentice Hall, has readers from the continental United States to the Pacific Rim.

Dr. Holloway's book Interpreting the Legacy: John Neihardt and Black Elk Speaks has been published by the University Press of Colorado. This book combines historical research, analysis of text, and archival scholarship to discuss that famous work and the lives and times of those who produced it. Notable in the book are rare photographs and high-resolution scans of original transcripts, manuscripts, and drawings.

At Mountain State University, Dr. Holloway has received the Alumni Association's Teacher of the Year award as well as the Student Government Association's Outstanding Professional Achievement and Faculty of the Year awards. In the past, he has served as president and as treasurer of the West Virginia Association of College English Teachers.


Excerpts

Excerpts

To the Student and Teacher To be an effective writer in the workplace, one must know the expectations. Special characteristics govern writing within, to, or for businesses, social-service agencies, health-care providers, and government entities. Often, textbooks surveying the challenges of such writing have stressed one of its several functions. For example, some authors teach entirely from a "technical" perspective, limiting discussion to the mechanics of production. Manuals depicting the proper way to construct tables, pie graphs, and charts are valuable resources; however, they supplement--rather than explain--the process of communication in the workplace. Similarly, a text focusing entirely upon the presentation of data may create an impression that one does not use persuasive techniques when informing an audience. Yet most students know that even the driest report may be made appetizing if its "package"--the format--is enhanced. Communication theorists, in fact, have a difficult time determining where "information" ceases and where "persuasion" begins; the two overlap, rather than comprise the ends of a continuum. A third editorial choice made by writers of texts focuses upon the persuasive aspects of communication in the workplace, as if the modes of presentation mattered most. This text draws from each of these partial perspectives in surveying holistic challenges within business and technical writing. Because this book is intended for students who have taken a freshman composition course but who have not necessarily worked in fields that demand the use of business and technical writing, its examples--real or fictionalized--are practical and basic. Writing letters of application and adjustment, constructing informational and persuasive reports, and encapsulating material so that it can be convincingly communicated are all activities shared by most college students; therefore, this book derives much of its illustration from such models. Throughout the text, then, three goals drive the content: Students should study the requirements of informative writing. Students should learn how the techniques of persuasion operate in writing in the workplace. Students should practice casting informative and persuasive writing into an appropriate format. Because what we practice not only depends on different aspects of business and technical writing but transcends it, I recommend that we call such communication transactional writing. In a transaction, the communicator provides information to the recipient of communication, but the recipient often must give up something as well: a prejudice (against the action proposed), free time ,. (which could be spent eating lunch instead of reading a memo), or a method of doing something (which the information just received happens to contradict). Frequently, one must offer the flattest data in terms calculated to make reading a report seem worthwhile. Getting the other person to read one's material, presenting such material clearly and accurately, and adhering to standards of format acceptable in the field become the goals of transactional writing. Educational Approach The exercises and assignments in this text build in complexity, chapter by chapter, as well as inside such chapters; for example, in Chapter 7 the preliminary report (Figure 7.14) contains material that can be used in the proposal (Figure 7. I 5), and the final report (Figure 7.16) includes imports from the proposal itself. Such an incremental, cumulative approach assists students who use computers in their writing, as saved material that constitutes a previous assignment can be retrieved, modified, and transferred to the new document. Should the final report be collaborative, students can integrate their reports on disk as well. Such a collaborative method might encourage students in similar fields to work together to create unified projects. This approach reaffirms the future value of the work the student has just completed, and is pragmatic-real examples and models demonstrate what should be done. Synopsis of the Table of Contents This text is conceptually divided into three sections. The first unit, the "apprenticeship," covers the basics of transactional writing and encompasses Chapters I through 3. Chapters 4, 5, and 6 expand the scope of technical and business writing, building on the foundation established earlier but introducing more complex assignments. Chapters 7 and 8 put the acquired knowledge to work in creating two polished, multisectioned documents: the formal report and the job portfolio. A short list of references and an appendix on graphics follow. Chapter 1--Introduction The first section in Chapter I, What Is "Business" or "Technical" Writing?, surveys the features of transactional writing, exploring differences between such writing and the academic prose taught in composition classes. It discusses working together in small groups to achieve a writing goal, growing a larger document from a smaller one--or from fragments--and using computers to assist the process of creating a document. Saying What You Mean surveys the basics: grammar and usage. It identifies sentence types and problems, focusing on the impact of phrasing but discussing other mechanical issues as well. A section on diction encourages writing within the context of "world English;' avoiding localisms and expressions that might confuse or antagonize readers. Chapter 2--Organizing Information Chapter 2 discusses how we impose patterns of logical order upon the infinite field of data around us, selecting from this field that which is necessary to support our message.This chapter reviews specific templates that structure logical presentations--many of them called "modes" in writing texts--such as summary, process, analysis, comparison, and persuasion. Chapter 3--Letters, Memos, E-mail, and Related Forms Chapter 3 presents a simple organizing framework of business communication: the message-support-closure framework. It next discusses the features of letters, memos, and transmittal documents, drawing on the writing patterns analyzed in Chapter 2. Chapter 4--Our House to Yours: Using Summaries to Inform Chapter 4 is a respite from all that memo and e-mail writing, but surveys documents similar in form: bulletins, descriptive leaflets and flyers, and public service announcements. This discussion expands the work with summary begun in Chapter 2. Chapter 5--Directions and Instructions: Writing About Process Chapter 5 focuses on process writing: informative and persuasive documents explaining how to do something or how something gets accomplished. The chapter surveys posted directions, instructional pamphlets, and other examples. Chapter 6--Using Analysis: Writing a Report Chapter 6 explores analysis and its ally, comparison. It suggests ways to use the templates introduced in Chapter 2 and develops techniques of ensuring continuity when writing analytically. This section offers tips on constructing projects in groups. Chapter 7--Writing the Formal Report Chapter 7 puts into practice all the skills learned while using this book; the templates studied reappear as parts within a larger concept and assume subordinate roles within that bigger structure.This chapter also covers research techniques, the use of traditional and electronic sources, and writing practices. Reporting on work-in-progress leads to writing the formal proposal; this document can be expanded to construct the final report. Chapter 8--Selling Yourself Chapter 8 extends the art of informing and persuading to one's search for employment. This chapter covers the research involved in job seeking (both in keeping a work-history file and in tracking down leads in the library). It reminds the reader that modern job searches can be greatly facilitated by new CD-ROM tools and the Internet. This chapter then looks at the components of a job seeker's arsenal: resumes, cover letters, vitae, and portfolios. The chapter discusses interviews and follow-up correspondence as well. References This section lists other sources of information about business and technical writing, which will enhance and augment the work begun in this text. Appendix--Enhancing Your Document with Graphics The appendix surveys integrating pictorial material into your document. Excerpted from Technical Writing Basics: A Guide to Style and Form by Brian R. Holloway All rights reserved by the original copyright owners. Excerpts are provided for display purposes only and may not be reproduced, reprinted or distributed without the written permission of the publisher.

Table of Contents

Forewordp. v
Prefacep. vii
Acknowledgmentsp. xi
Chapter 1 Introductionp. 1
What Is "Business" or "Technical" Writing?p. 1
Transactional Writingp. 1
Transactional Versus Academic Writingp. 3
Working Togetherp. 3
Growing a Documentp. 3
Using Computersp. 4
Saying What You Mean: A Grammar Refresherp. 5
Grammar and Usage Assist Credibilityp. 6
Sentence Types in Technical Writingp. 9
Sentence Problemsp. 10
Other Mechanical Difficultiesp. 11
Dangling Modifiersp. 11
Parallelismp. 12
Diction and International Concernsp. 13
Assignmentsp. 16
Chapter 2 Organizing Informationp. 21
Introductionp. 21
Patterns of Orderp. 22
Types of Orderp. 22
Essentials of Logical Orderp. 23
Specific Templatesp. 23
Summaryp. 24
Processp. 26
Analysisp. 27
Comparisonp. 30
Persuasionp. 33
Ethics in Persuasionp. 36
Assignmentsp. 37
Chapter 3 Letters, Memos, E-mail, and Related Formsp. 39
Introductionp. 39
Letters: The Basicsp. 40
Full Block Formp. 41
Semi-Block Formp. 43
Simplified Formp. 44
Memos: The Basicsp. 47
Varieties of Letters and Memosp. 49
Neutral Lettersp. 50
Good News Lettersp. 51
Bad News Lettersp. 53
Good News, Bad News, and Neutral Memosp. 55
E-mail and Related Formsp. 57
E-mailp. 57
Fax Cover Sheetsp. 58
Other Transmittalsp. 58
Assignmentsp. 58
Chapter 4 Our House to Yours: Using Summaries to Informp. 63
Introductionp. 53
Announcements and Bulletinsp. 63
Leaflets and Flyersp. 67
Analyses of Documentsp. 69
Consumer Circuitp. 69
The New AT&T Billp. 69
Finesse Finishing Papersp. 76
State Farm 1995 Annual Reportp. 76
Assignmentsp. 76
Chapter 5 Directions and Instructions: Writing About Processp. 79
Process Explains "How"p. 79
Process Writing Concernsp. 80
Audiencep. 80
Vocabularyp. 82
Patternp. 82
Transitionp. 82
Exemplificationp. 86
Parallelismp. 86
Formatp. 86
Graphicsp. 86
Inventionp. 88
Developing Ideasp. 88
Invention Specificsp. 89
Visualization Techniquesp. 89
"Tasking" Techniquesp. 89
General Patterns for Process Writingp. 93
International Communicationsp. 94
Assignmentp. 94
Chapter 6 Using Analysis: Writing a Reportp. 99
Subject Headingsp. 99
Divisionp. 99
Classificationp. 102
Definitionp. 103
Use of Narrativep. 103
Types of Reportsp. 104
Short Reportsp. 105
Semi-Formal Reportsp. 106
Proposalsp. 110
Analysis of Proposalp. 110
Analysis of Text Prospectusp. 112
Discussion of Grant Proposalp. 116
Discussion of Student Proposalp. 120
Assignmentsp. 121
Chapter 7 Writing the Formal Reportp. 123
Features of the Formal Reportp. 123
Overviewp. 123
Bindingp. 123
Booklet Formatp. 125
Cover Sheetp. 125
Transmittal Letter or Memop. 126
Table of Contentsp. 127
Table of Illustrationsp. 128
Abstract, or Executive Summaryp. 128
Introductionp. 130
Support Sectionp. 131
Closing Sectionp. 132
Back Matterp. 132
Understanding the Role of the Persuasive Patternp. 133
Developing Long Reports from Shorter Onesp. 134
Methods of Researchp. 135
Strategyp. 135
Types of Research Materials-Retrospective and Currentp. 135
Primary and Secondary Materialsp. 141
Handling Sourcesp. 141
Overviewp. 141
Documentation Systems-Citation and Reference Listp. 142
What Should Get Cited?p. 142
Integrating Referencesp. 142
Gallery of Documentsp. 143
Assignmentsp. 174
Chapter 8 Selling Yourselfp. 177
Introductionp. 177
Keeping a Work-History Filep. 177
The Modern Job Searchp. 178
Resumesp. 181
Chronological Resumesp. 182
Functional Resumesp. 182
Mixed Resumesp. 182
Parts of Resumesp. 187
Cover Lettersp. 189
Vitae and Portfoliosp. 193
Interviewsp. 193
Follow-up Correspondencep. 197
Assignmentsp. 198
Referencesp. 201
Introductionp. 201
Valedictionp. 202
Appendix Enhancing Your Document with Graphicsp. 203
Indexp. 213