You are previewing Technical Writing in the Corporate World Understanding, Developing, and Editing Technical Documents.
O'Reilly logo
Technical Writing in the Corporate World Understanding, Developing, and Editing Technical Documents

Book Description

This clearly written book was developed for those who want to learn the basics of effective technical writing. Special attention is paid to how to plan, organize, develop, and edit technical documents for the best results.

Coverage includes—

  • To present general principles of excellence in technical writing

  • To discuss procedures for specific types of writing

  • To explain correctness in technical writing

Table of Contents

  1. Learning Objectives For:
  2. Acknowledgments
  3. Understanding Technical Writing
    1. Understanding Technical Writing
      1. What is Technical Writing?
    2. Surveying Your Attitudes towards Writing
      1. Authors’ Comments: Your Attitudes Toward Writing
    3. Knowing Your Audience
      1. Six Techniques for Success
      2. Case Study #1: Analyzing an Audience
      3. Exercise: Evaluating Effective Technical Writing
    4. Understanding the Writing Process
      1. Invention
      2. Arrangement
      3. Style
      4. Exercise: Thinking about Your Writing Process
    5. The Five C’s of Report Writing
      1. C Number #1: Conciseness
      2. C Number #2: Completeness
      3. C Number #3: Concreteness
      4. C Number #4: Correctness
      5. C Number #5: Coherence
  4. Developing the Technical Document
    1. Developing the Technical Document
    2. Correspondence
      1. 2.1.1 The Memo
      2. 2.1.2 The Cover Letter
      3. 2.1.3 The Resume
    3. Reports
      1. 2.2.1 The Trip Report
      2. 2.2.2 The Activities Report
    4. Proposals
      1. 2.3.1 The Brief Proposal
      2. 2.3.2 The Extended Proposal
      3. Case Study #2: Thinking Argumentativey
      4. Authors’ Analysis of Case Study #2
    5. Procedures
      1. Document 8: The Procedural Document
    6. Long Documents
      1. Document 9: Letter of Transmittal
      2. Document 10: Title Page
      3. Document 11: Abstract
      4. Document 12: The Table of Contents
      5. Document 13: List of Figures
      6. Exercise: Collecting Model Technical Documents
  5. Editing the Technical Document
    1. Editing the Technical Document
    2. Organization
    3. Style
    4. Correctness
      1. Exercise: Identifying the Seven Deadly Errors of Technical Writing
      2. 3.3.1 Pronoun Reference Agreement Problems
      3. 3.3.2 Subject-Verb Agreement Problems
      4. 3.3.3 Vague Pronoun Reference
      5. 3.3.4 Dangling Modifiers
      6. 3.3.5 Overuse of Passive Voice
      7. 3.3.6 Inappropriate Comma Use
      8. 3.3.7 Inappropriate Semicolon Use
    5. A Note on Editing
  6. Conclusion: The Importance of Technical Writing
    1. Conclusion: The Importance of Technical Writing
  7. Appendices
    1. Building A Community of Technical Editors
    2. Word Processing for the Technical Writer
    3. Technical Writing and English as a Second Language
    4. For Further Reading
      1. Professional Societies:
      2. Bibliographical Guides:
      3. Readers
      4. Handbook
      5. Word Processing:
      6. Technology Studies: