Author: Barry J. Rosenberg (Autor)
Title: Spring Into Technical Writing for Engineers and Scientists
Description: , Addison-Wesley Longman, Amsterdam, 2005. 352, 17,8 x 2,3 x 23,5 cm, Softcover. Zustand: 2. This book is a "must-read" for anyone engaged in the art of technical writing --- even for an old pro like me. Like any good book on writing, Technical Writing begins with a discussion of writing itself. Rosenberg makes it clear that you need to write for a particular audience---and with a particular message. He discusses the difference between writing documentation, writing technical marketing literature, and writing speeches or presentations. Clear and comprehensive chapters introduce and then drill-down on many of the topics that throw off many would-be writers. Rosenberg discusses common issues such as word consistency, verbs, pronouns, "fluffy phrases," and words that are commonly confused (like "affect" and "effect," or "its" and "it's"). Next he conquers sentences, paragraphs, transitions, and the construction of a good document. But my favorite part of this book is the middle, where Rosenberg shows the reader how to use all of those clever typographical techniques that have emerged over the past 20 years. Rosenberg shows how to use bulleted lists. He shows when to use bullets, and when to use numbers. He shows how to make tables that are both beautiful to look at and that clearly convey information to the reader. Callouts, sidebars, and even tinted boxesit's all here. The level of drill-down is truly impressive. Clearly, this book was born from years of experience in both writing and editing. For example, the chapter on graphics beings with a photo of a stream, with a caption that says"this picture is totally off topic, but you looked at it before you read the opening paragraph, simply because it's a picture." The chapter then discusses time series (3 examples), techniques for providing extra details in graphs, before-and-after photos, the advantages of callouts vs. embedded text (and when to use each), screenshots (and the advantage of annotating them), the issue of color blindness, ways to enhance photographs with line art, and appropriate use of white space. The final three chapters of the book describe the process of editing and producing documents. This is great material both for editors who are looking for new ideas, and for writers like me who have the luxury of being edited by pros. That's because all writers can benefit from being edited, and the editor that is always there, the editor that will always know what you want to say, the editor who will never quit, is you, the writer. This book is great for engineers who have suddenly been saddled with the task of writing documentation for their inventions. But it's also great for people who love to write and are looking for new ideas. Indeed, before I start on my next book, I'm going to re-read Rosenberg's Technical Writing.The fastest way for professionals to master technical writing! You're a technical professional, perhaps a programmer, engineer, or scientist. You are not a professional writer, but writing is part of your job (specs, manuals, proposals, lab reports, technical presentations, Web content, data sheets, and so on). Welcome. This book is for you. It's all you need to clearly communicate technical ideas to any audience--technical or nontechnical--and motivate them to act. Barry J. Rosenberg organizes every facet of effective technical writing into more than 175 short, concise, fast-paced tutorials. You'll find loads of examples (what to do and what not to do) plus start-to-finish instructions for writing exactly the kinds of documents you need to create. Need specific solutions? This book's bite-size, visual, high-efficiency format delivers them instantly. Dig in, get started, and get results!* Make all your documents and presentations clearer, more concise, and more compelling *Understand your audience, and target your content appropriately *Learn how to write for an international audience *Use active voice to communicate with confidence and authority *Produce effective lists, tables, and graphics *Create useful examples *Write effective manuals and release notes *Implement solid technical Web sites *Develop winning research, business, and book proposals *Create and present compelling PowerPoint presentations *Write e-mails that don't ignite flame wars *Learn how to integrate documentation development into best engineering practices Downloadable examples are available on the Web. Buchrückseite The fastest way for professionals to master technical writing! You’re a technical professional, perhaps a programmer, engineer, or scientist. You are not a professional writer, but writing is part of your job (specs, manuals, proposals, lab reports, technical presentations, Web content, data sheets, and so on). Welcome. This book is for you. It’s all you need to clearly communicate technical ideas to any audience—technical or nontechnical—and motivate them to act. Barry J. Rosenberg organizes every facet of effective technical writing into more than 175 short, concise, fast-paced tutorials. You’ll find loads of examples (what to do and what not to do) plus start-to-finish instructions for writing exactly the kinds of documents you need to create. Need specific solutions? This book’s bite-size, visual, high-efficiency format delivers them instantly. Dig in, get started, and get results! Make all your documents and presentations clearer, more concise, and more compelling Understand your audience, and target your content appropriately Learn how to write for an international audience Use active voice to communicate with confidence and authority Produce effective lists, tables, and graphics Create useful examples Write effective manuals and release notes Implement solid technical Web sites Develop winning research, business, and book proposals Create and present compelling PowerPoint presentations Write e-mails that don’t ignite flame wars Learn how to integrate documentation development into best engineering practices Downloadable examples are available on the Web Author: Barry Rosenberg is the author of more than sixty corporate technical manuals, primarily on programming. An experienced instructor, Barry has taught everything from high school physics to weeklong corporate seminars on data structures. Most recently, he spent four semesters at MIT, where he taught advanced technical writing. Barry currently works as the documentation manager at 170 Systems. Verlagsort Boston Sprache englisch Masse 176 x 230 mm Geisteswissenschaften ? Sprach- / Literaturwissenschaft ? Literaturwissenschaft Technik ISBN-10 0-13-149863-0 / 0131498630 ISBN-13 978-0-13-149863-1 / 9780131498631 Content: Preface. I. PLANNING TO WRITE. 1. The Quest. Technical Writing Theorems Technical Writing Can Be Creative Tell 'Em The Value of Technical Communication to You Comparing Technical Writing to Engineering and Science 2. Audience. General Education Level Experience and Expertise Breadth of Audience Native Language Native Culture Audience Motivation Medium and the Message Becoming the Audience Summary of Audience 3. Documentation Plans. Document Specifications (Doc Specs) Doc Specs: Sample Documentation Project Plans Documentation Project Plan: Sample Summary of Documentation Specifications II. WRITING: GENERAL PRINCIPLES. 4. Words. Jargon Consistency Verbs Adjectives and Adverbs Pronouns: He, She, and They Pronouns: You Pronouns: It and They Fluffy Phrases Commonly Confused Words Summary of Words 5. Sentences. Active Voice and Passive Voice Active Voice Is Better When Is Passive Voice Okay? Short = Sweet Causes of Long Sentences One Sentence = One Thought Parenthetical Clauses Summary of Sentences 6. Paragraphs and Sections. Sentence Transitions Paragraph Length Paragraph Transitions Sections Summary of Paragraphs and Sections 7. Lists. Bulleted Lists Elements in Bulleted Lists The Length of Each Element Numbered Lists Directions Introductions to Lists Parallel Lists Summary of Lists 8. Tables. Column Headers Units of Measure Arrangement of Columns and Rows Parallelism in Tables Amount of Text in Cells Rules Shading Captions Summary of Tables 9. Graphics Graphics Time Series Extra Detail in Online Graphics Before and After Callouts versus Embedded Text Graphics That Orient Readers Screenshots Color Blindness Block Diagrams Text That Supplements Figures Technical Photography Line Art Enhances Technical Photographs Big Picture First, Then Details Layout: Controlling Focus Layout: Keeping Eyes on the Page Layout: White Space Summary of Graphics 10. Professional Secrets. Explanations of Formula-Based Rules Examples Examples by Metaphor Examples for Programming Documentation Question-and-Answer Format Question-and-Answer Format Example In Other Words Tone Pace Footnotes and Other Digressions Beyond the Obvious Precision Descriptions The Hardest Part of Writing Summary of Professional Secrets III. WRITING: SPECIFIC KINDS OF DOCUMENTS. 11. Manuals. Manual Style: Cookbooks Cookbook Example: Installing the Carambola Server Manual Style: Tutorials Tutorial Example: Getting Started with HTML Manual Style: Guides Guide Example: Creating HTML Headers Manual Style: Reference Manuals Reference Example: The pr1me Utility Manual Style: Nonverbal Manuals Online Help: Overview Online Help: Best Practices Online Help Examples Release Notes Release Notes Example: Carambola Web Server Version 3.7 Prefaces Preface Example Glossaries Glossary Example: Tropical Weather Terms Tables of Contents Indexes Indexes: Providing Concise Entries Indexes: Permuting Terms Indexes: Providing Entries for Concepts Summary of Manuals 12. Web Sites. Plans Home Page: Specify Purpose and Audience Home Pages: Engage the Reader's Imagination Home Pages: Set the Tone Page Templates Navigators and Search Boxes Hyperlinks in Body Text Secondary Pages Text in Web Sites PDF versus HTML Frequently Asked Questions (FAQs) Summary of Web Sites 13. Proposals. The Proposal before the Proposal Adherence to the Proposal Template Proposal Element: Cover Letters Proposal Element: Biographies Proposal Element: Abstracts Proposal Element: Contingency Plans Proposals for Revolutionary Ideas Research Proposals Research Proposals: Significance Statements Research Proposals: Objectives and Hypotheses Research Proposals: Design and Methods Book Proposals Book Proposal: Example Marketing Section Business Plans Summary of Proposals 14. Internal Planning Documents. Business Proposals Business Proposal: Example High-Level Technical Specs High-Level Technical Spec Example Low-Level Technical Specs Low-Level Technical Spec Example Summary of Internal Planning Documents 15. Lab Reports. Abstract Introduction Materials Experimental Procedure Results Discussion Conclusion References Summary of Lab Reports 16. PowerPoint Presentations. Organizing a Presentation: The Big Picture The Number of Slides The Opening Moments of a Presentation Introductory Slides: The Traditional Approach Introductory Slides: An Alternate Approach Body Slides: Pace and Variety Mechanics: Fonts and Backgrounds Body Slides: Effective Lists Audience: The Theory of Relativity Graphics The Complexity of a Graphic Question-and-Answer Sessions Different Kinds of Learners PowerPoint Speech: The Basics PowerPoint Speech: Lessons from the Pros PowerPoint Speech: Overcoming Fear Summary of PowerPoint Presentations 17. E-Mail. The Essence of the E-Mail Problem Before Hitting the Send Button... After the First Miscommunication... Summary of E-Mail IV. EDITING AND PRODUCING DOCUMENTS. 18. Editing and the Documentation Process. Editing: What Is It Really? Technical Editing a Peer's Work Technical Editing a Superior's Work Copyediting a Colleague's Document Copyediting Your Own Document Media for Technical Editing Bug-Tracking Systems A Process for Editing Beta Tests for Documentation Summary of Editing and the Documentation Process 19. Fonts and Typography. Serif and Sans-Serif Fonts Fixed-Width versus Variable-Width Fonts Serif and Sans-Serif in Hard Copy Serif and Sans-Serif in Soft Copy Font Height Italics and Boldface Consistency and Convention True-Type versus PostScript Fonts Summary of Fonts and Typography 20. Punctuation. Commas Dashes and Hyphens Semicolons Periods Colons Quotation Marks Glossary. Bibliography. Index. ISBN: 978-0131498631 ISBN: 131498630. Gewicht/weight: 552 gr.

Keywords: Geisteswissenschaften Sprachwissenschaft Literaturwissenschaft Technik ISBN-10 0-13-149863-0 / 0131498630 ISBN-13 978-0-13-149863-1 / 9780131498631 Content: Preface. I. PLANNING TO WRITE. 1. The Quest. Technical Writing Theorems Technical Writing Can