Atnaujinkite slapukų nuostatas

El. knyga: Technical Writing: A Practical Guide for Engineers, Scientists, and Nontechnical Professionals, Second Edition 2nd edition [Taylor & Francis e-book]

(The Pennsylvania State University, Malvern, USA)
  • Formatas: 300 pages, 52 Illustrations, black and white
  • Serija: What Every Engineer Should Know
  • Išleidimo metai: 10-Aug-2018
  • Leidėjas: CRC Press
  • ISBN-13: 9780429467394
Kitos knygos pagal šią temą:
  • Taylor & Francis e-book
  • Kaina: 230,81 €*
  • * this price gives unlimited concurrent access for unlimited time
  • Standartinė kaina: 329,73 €
  • Sutaupote 30%
  • Formatas: 300 pages, 52 Illustrations, black and white
  • Serija: What Every Engineer Should Know
  • Išleidimo metai: 10-Aug-2018
  • Leidėjas: CRC Press
  • ISBN-13: 9780429467394
Kitos knygos pagal šią temą:

Engineers, scientists, and professionals of all types are often required to write reports, summaries, manuals, and guides. While many have had an English language or writing course, it is less likely that they have had instruction in the special requirements of technical writing.

Filling this void, Technical Writing: A Practical Guide for Engineers, Scientists, and Nontechnical Professionals, Second Edition enables readers to write, edit, and publish materials of a technical nature, including books, articles, reports, and electronic media. Written by a renowned engineer and widely published technical author, this guide complements traditional writer’s reference manuals on technical writing through presentation of first-hand examples that help readers understand practical considerations in writing and producing technical content. These examples illustrate how a publication originates as well as various challenges and solutions.

The second edition contains new material in every chapter including new topics, additional examples, insights, tips and tricks, new vignettes and more exercises. Appendices have been added for writing checklists and writing samples. The references and glossary have been updated and expanded. In addition, a focus on writing for the nontechnical persons working in the technology world and the nonnative English speaker has been incorporated. Written in an informal, conversational style, unlike traditional college writing texts, the book also contains many interesting vignettes and personal stories to add interest to otherwise stodgy lessons.

Key Features

•Offers precise, hands-on coverage of technical writing

•Complements traditional writer’s reference manuals

•Includes personal anecdotes and historical stories that serve as real-world examples of technical writing

•Explores the various avenues for publishing your work

•Explains how to write for blogs, social networks, and other e-media

What Every Engineer Should Know: Series Statement xv
Preface xvii
Acknowledgments xix
1 The Nature of Technical Writing 1(12)
1.1 Introduction
1(1)
1.2 Who Writes Technical Documentation?
2(1)
1.3 Taxonomy of Technical Writing
3(1)
1.4 Technical Reporting
4(1)
1.5 Business Communications
5(1)
1.6 Scientific Writing
6(4)
1.6.1 Books
7(1)
1.6.2 Journals
7(1)
1.6.3 Magazines
8(1)
1.6.4 Conference Proceedings
8(1)
1.6.5 Newsletters
9(1)
1.6.6 Websites and Blogs
9(1)
1.6.7 Vignette: Nontechnical Writing
9(1)
1.6.8 Vignette: Technical Writing Sample
9(1)
1.7 Exercises
10(1)
Endnotes
11(1)
References
11(2)
2 Technical Writing Basics 13(34)
2.1 Introduction
13(1)
2.2 Structuring Your Writing
13(3)
2.3 Positioning Your Writing
16(1)
2.3.1 Know Your Audience
16(1)
2.3.2 Are You Talking to Me?
16(1)
2.4 Choosing the Right Words
17(8)
2.4.1 Conciseness
17(3)
2.4.2 Precision and Hedging
20(3)
2.4.3 Universal and Existential Quantification
23(1)
2.4.4 Negatives
24(1)
2.4.5 Vignette: Brake Retarder Prohibitions
25(1)
2.5 Avoiding Traps
25(8)
2.5.1 Cliches
26(1)
2.5.2 Anthropomorphic Writing
26(1)
2.5.3 Malapropisms
27(1)
2.5.4 Erroneous Heterographs
27(2)
2.5.5 Opinion versus Fact
29(1)
2.5.6 Acronyms, Domain-Specific Terms, and Jargon
29(2)
2.5.7 The Laziness of "Very"
31(1)
2.5.8 Other Pitfalls
32(1)
2.6 Making Your Technical Writing More Interesting
33(3)
2.6.1 Humor
33(1)
2.6.2 Vignette: The Joy of Spam
34(1)
2.6.3 Allegory
35(1)
2.7 The 5 Cs of Technical Writing
36(5)
2.7.1 Qualities of Good Writing
36(1)
2.7.2 Correctness
37(1)
2.7.3 Clarity
38(1)
2.7.4 Completeness
38(1)
2.7.5 Consistency
39(1)
2.7.6 Changeability
39(1)
2.7.7 An Example
39(2)
2.8 Referencing
41(2)
2.8.1 Choose the Right References
41(1)
2.8.2 Web References
42(1)
2.8.3 Reference Styles
42(1)
2.9 Exercises
43(1)
Endnotes
44(1)
References
45(2)
3 The Writing Process 47(28)
3.1 Introduction
47(1)
3.2 The Traditional Writing Process
48(10)
3.2.1 Brainstorming
49(1)
3.2.2 Drafting
50(1)
3.2.3 Revising
50(1)
3.2.4 Editing
51(3)
3.2.5 Publishing
54(1)
3.2.6 Vignette: A Paper on Software Control on Oil Rigs
54(4)
3.3 Environment
58(1)
3.4 Dealing with Writer's Block
58(1)
3.5 Meeting Deadlines
59(1)
3.6 Writing Tools
59(1)
3.7 Permissions and Plagiarism
60(8)
3.7.1 Permissions
60(2)
3.7.2 Plagiarism
62(1)
3.7.3 Self-Plagiarism
63(1)
3.7.4 Detection Tools
64(1)
3.7.5 Paper Generators
64(3)
3.7.6 Vignette: Determining Authorship-The Federalist Papers
67(1)
3.8 Making Your Writing Understandable to All
68(3)
3.8.1 Hofstede's Metrics
68(2)
3.8.2 British versus American English
70(1)
3.9 Exercises
71(1)
Endnotes
72(1)
References
72(3)
4 Scientific Writing 75(26)
4.1 Introduction
75(1)
4.2 Technical Reports
76(1)
4.3 Tutorials
77(2)
4.4 Opinion
79(2)
4.5 Research Papers
81(10)
4.5.1 Survey of the Field
81(3)
4.5.2 Based on Survey Data
84(3)
4.5.3 Based on Experimentation
87(4)
4.6 Reviews of Books, Papers, and Reports
91(6)
4.6.1 Reviews
91(1)
4.6.2 Journal and Conference Paper Reviews
91(2)
4.6.3 Book Reviews
93(2)
4.6.4 Blind Reviews
95(2)
4.6.5 Vignette: Scientific Proposal
97(1)
4.7 Exercises
97(1)
Endnotes
98(1)
References
99(2)
5 Business Communications 101(34)
5.1 Introduction
101(1)
5.2 Resumes
101(14)
5.2.1 Name
102(1)
5.2.2 Contact Information
103(1)
5.2.3 Summary
103(1)
5.2.4 Statement of Objective
104(1)
5.2.5 Experience
104(1)
5.2.6 Education and Training
104(1)
5.2.7 Licenses and Certifications
105(1)
5.2.8 Consulting
105(1)
5.2.9 Hardware and Software
105(1)
5.2.10 Foreign Languages
106(1)
5.2.11 Security Clearance
107(1)
5.2.12 Military and Other Service
107(1)
5.2.13 Awards and Honors
107(1)
5.2.14 Publications
108(1)
5.2.15 Affiliations
108(1)
5.2.16 Interests
108(1)
5.2.17 References
109(1)
5.2.18 Order Matters
109(1)
5.2.19 Things to Avoid on a Resume
110(1)
5.2.20 Honesty Is the Best Policy
111(1)
5.2.21 Examples
111(4)
5.3 Transmittal Letters
115(1)
5.4 Writing Letters of Reference
115(5)
5.4.1 Letter of Reference for a Subordinate
116(1)
5.4.2 Letter of Reference for a Casual Acquaintance
117(1)
5.4.3 Generic Letter of Reference
118(1)
5.4.4 Form-Based Letter of Reference
119(1)
5.5 Memos
120(1)
5.6 Meetings, Agendas, and Minutes
121(4)
5.6.1 Meeting Invitations
121(2)
5.6.2 Agendas
123(1)
5.6.3 Meeting Minutes
123(2)
5.7 Customer Relations Writing
125(2)
5.7.1 Vignette: A Customer Inquiry Letter
125(1)
5.7.2 Vignette: Response to a Customer Inquiry Letter
126(1)
5.8 Press Releases
127(2)
5.9 Presentations
129(4)
5.9.1 Vignette: A Presentation on Cyberpandemics
129(4)
5.10 Marketing and Sales Materials
133(1)
5.11 Exercises
133(1)
Endnotes
134(1)
References
134(1)
6 Technical Reporting 135(28)
6.1 Introduction
135(1)
6.2 Technical Procedures
136(7)
6.2.1 Vignette: PC Repair Book
136(2)
6.2.2 Vignette: Building an Aquarium
138(2)
6.2.3 Vignette: Operational Instructions for Krav Maga
140(2)
6.2.4 Vignette: Recipe for Fennell Pasta
142(1)
6.3 Proposals
143(7)
6.3.1 Vignette: Grant Proposal
144(3)
6.3.2 Vignette: Proposal for Consulting Services
147(3)
6.4 Panel Sessions
150(1)
6.5 Strategic Plans and Planning
151(6)
6.5.1 Executive Summary
152(1)
6.5.2 The Mission Statement
153(1)
6.5.3 SWOT Analysis
154(1)
6.5.4 Competitive Market Analysis
155(1)
6.5.5 Goals, Objectives, and Strategies
155(2)
6.5.6 Budget
157(1)
6.6 Problem Reports
157(1)
6.7 User Manuals
158(2)
6.7.1 Vignette: Disaster from a User Manual
160(1)
6.8 Exercises
160(1)
Endnotes
161(1)
References
161(2)
7 Using Graphical Elements 163(28)
7.1 Breaking up the Monotony
163(1)
7.2 Modeling Ideas with Graphics
163(7)
7.2.1 A Picture Is Worth 1437.4 Words
164(1)
7.2.2 Modeling Behavior
165(3)
7.2.3 The Evolution of an Idea
168(2)
7.3 Selecting the Best Model for a Schedule
170(2)
7.4 Dealing with Figures
172(3)
7.4.1 Callouts, Captioning, and Placement
172(2)
7.4.2 Permissions for Figures
174(1)
7.5 Dealing with Tables
175(2)
7.6 Dealing with Equations
177(6)
7.6.1 Using Microsoft Equation Editor
179(1)
7.6.2 Using MathType
179(1)
7.6.3 Using LaTeX
179(2)
7.6.4 Vignette: Typesetting Books
181(2)
7.7 Dealing with Dynamic Content
183(4)
7.7.1 Vignette: The Minard Map
185(2)
7.8 Exercises
187(1)
Endnotes
188(1)
References
188(3)
8 Publishing Your Work 191(22)
8.1 Introduction
191(1)
8.1.1 What Kinds of Work Can Be Published?
191(1)
8.1.2 Why Publish Your Work?
191(1)
8.2 Making a Living as a Writer
192(6)
8.2.1 Freelance Writing
193(1)
8.2.2 Writing Technical Books
193(1)
8.2.3 Getting Rich Writing Books
194(2)
8.2.4 Why Are Technical Books So Expensive?
196(1)
8.2.5 Vignette: A Writing Failure
197(1)
8.3 The Review Process
198(3)
8.3.1 Administrative Rejection
198(1)
8.3.2 Review Flow
199(1)
8.3.3 Review of Books
200(1)
8.4 Handling Rejection
201(4)
8.4.1 Rejection Letters
201(1)
8.4.2 Responding to Rejection Letters
202(1)
8.4.3 Succeeding at Publishing
203(1)
8.4.4 Vignette: Experiences with Reviews
204(1)
8.5 Open Access Publishing
205(2)
8.5.1 The Traditional Publishing Model
205(1)
8.5.2 The Open-Access Publishing Model
205(2)
8.5.3 Vignette: Experience with Open Access Publishing
207(1)
8.6 Self-Publishing
207(2)
8.6.1 Vanity Presses
207(1)
8.6.2 Online Publishing
208(1)
8.6.3 Vignette: Bootleg Books
209(1)
8.7 Exercises
209(1)
Endnotes
210(1)
References
211(2)
9 Writing for E-Media 213(18)
9.1 Introduction
213(1)
9.2 E-Mail Can Be Dangerous
214(4)
9.2.1 Rules for E-mails
215(1)
9.2.2 The Signature Line
215(2)
9.2.3 Use of Emoticons
217(1)
9.3 E-Newsletters
218(3)
9.3.1 Vignette: A Newsletter for CIO Institute
219(2)
9.4 Blogging
221(1)
9.5 Social Networks
222(1)
9.6 E-Magazines
223(1)
9.7 E-Readers
224(2)
9.7.1 Common Features
224(1)
9.7.2 Distribution Model
225(1)
9.8 Online Courses
226(2)
9.8.1 Massively Open Online Course (MOOC)
227(1)
9.8.2 Vignette: Experiences with MOOCs
227(1)
9.9 Exercises
228(1)
Endnotes
229(1)
References
229(2)
10 Writing with Collaborators 231(18)
10.1 Introduction
231(1)
10.2 Writing in Different Voices
232(3)
10.2.1 Using Metrics to Detect Nonhomogeneous Writing
233(1)
10.2.2 Dealing with Different Voices
234(1)
10.2.3 Paul Erdos: The Ultimate Coauthor
234(1)
10.3 Very Large Collaborative Writing Projects
235(2)
10.3.1 Vignette: Building a Dictionary
235(1)
10.3.2 Vignette: Building an Encyclopedia
236(1)
10.4 Behavior of Groups
237(4)
10.4.1 Tuckman's Model
238(1)
10.4.2 Forming
239(1)
10.4.3 Storming
239(1)
10.4.4 Norming
239(1)
10.4.5 Performing
240(1)
10.4.6 Mourning
240(1)
10.4.7 Vignette: Determining Author Order
240(1)
10.5 Other Paradigms for Team Building
241(2)
10.5.1 Group Writing and Improvisational Comedy
241(1)
10.5.2 Team Technical Writing as Scriptwriting
242(1)
10.6 Antipatterns in Organizations
243(3)
10.6.1 Divergent Goals
244(1)
10.6.2 Process Clash
245(1)
10.6.3 Vignette: Experiences Co-Writing Books and Papers
245(1)
10.7 Exercises
246(1)
Endnotes
247(1)
References
247(2)
Appendix A 249(2)
Appendix B: Templates 251(10)
Glossary 261(6)
Index 267
Dr. Phil Laplante is Professor of Software and Systems Engineering at The Pennsylvania State University. He received his B.S., M.Eng., and Ph.D. from Stevens Institute of Technology and an MBA from the University of Colorado. He is a Fellow of the IEEE and SPIE and has won international awards for his teaching, research and service. Since 2010 he has led the effort to develop a national licensing exam for software engineers.

He has worked in avionics, CAD, and software testing systems and he has published more than 33 books and 250 scholarly papers. He is a licensed professional engineer in the Commonwealth of Pennsylvania. He is also a frequent technology advisor to senior executives, investors, entrepreneurs and attorneys and actively serves on corporate technology advisory boards.

His research interests are in software testing, requirements engineering and software quality and management. Prior to his appointment at Penn State he was a software development professional, technology executive, college president and entrepreneur.