Spring into technical writing : for engineers and scientists /

Saved in:
Bibliographic Details
Author / Creator:Rosenberg, Barry J.
Imprint:Upper Saddle River, NJ : Addison-Wesley, c2005.
Description:xxi, 318 p. : ill. ; 24 cm.
Language:English
Series:Spring into--
Subject:Technical writing.
Technical writing.
Format: Print Book
URL for this record:http://pi.lib.uchicago.edu/1001/cat/bib/5666072
Hidden Bibliographic Details
ISBN:0131498630 (alk. paper)
Notes:Includes bibliographical references (p. 299-300) and index.
committed to retain 20170930 20421213 HathiTrust
Table of Contents:
  • 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
  • Paragraph Length Paragraph Transitions
  • Summary of Sentences
  • 6. Paragraphs and Sections
  • Sentence 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
  • Layout: Controlling Focus
  • Technical Photography
  • Line Art Enhances Technical Photographs
  • Big Picture First, Then Details
  • 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: Spectific 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
  • Preface Example
  • Release Notes
  • Release Notes Example: Carambola Web Server Version 3.7
  • Prefaces
  • Glossaries
  • lossary Example: Tropical Weather Terms
  • Tables of Contents
  • ndexes
  • dexes: Providing Concise Entries
  • dexes: Permuting Terms
  • dexes: Providing Entries for Concepts
  • mmary of Manuals
  • 12. Web Sites
  • Plans Home Page: Specify