Technical Documentation and Process

Technical Documentation and Process

by Jerry C. Whitaker, Robert K. Mancini
Released September 2018
Publisher(s): CRC Press
ISBN: 9781351833035

Read it now on the O’Reilly learning platform with a 10-day free trial.

O’Reilly members get unlimited access to books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial

Book description

We live in an age of electronic interconnectivity, with co-workers across the hall and across the ocean, and managing meetings can be a challenge across multiple time zones and cultures. This makes documenting your projects more important than ever. In Technical Documentation and Process, Jerry Whitaker and Bob Mancini provide the background and structure to help you document your projects more effectively.

With more than 60 years of combined experience in successfully documenting complex engineering projects, the authors guide you in developing appropriate process and documentation tools that address the particular needs of your organization.

Features

  • Strategies for documenting a project, product, or facility
  • A sample style guide template—the foundation on which you can build documents of various types
  • A selection of document templates
  • Ideas for managing complex processes and improving competitiveness using systems engineering and concurrent engineering practices
  • Basic writing standards and helpful references
  • Major considerations for disaster planning
  • Discussion of standardization to show how it can help reduce costs
  • Helpful tips to manage remote meetings and other communications
  • First-hand examples from the authors’ own experience

Throughout, the authors offer practical guidelines, suggestions, and lessons that can be applied across a wide variety of project types and organizational structures. Comprehensive yet to the point, this book helps you define the process, document the plan, and manage your projects more confidently.

Table of contents

  1. Cover
  2. Half Title
  3. Title Page
  4. Copyright Page
  5. Table of Contents
  6. Preface
  7. Acknowledgment
  8. About the Authors
  9. 1. Overview
    1. 1.1 Introduction
    2. 1.2 Plan for Success
    3. 1.3 Elements of Process
      1. 1.3.1 Documentation
      2. 1.3.2 Social Media
    4. 1.4 Putting It All Together
  10. 2. Equipment Documentation Strategies
    1. 2.1 Introduction
    2. 2.2 Documentation Tools
      1. 2.2.1 Types of Documentation
        1. 2.2.1.1 Self-Documentation
        2. 2.2.1.2 Database Documentation
        3. 2.2.1.3 Graphics Documentation
      2. 2.2.2 Labeling
      3. 2.2.3 Other Documentation Tasks
        1. 2.2.3.1 Operator/User Documentation
        2. 2.2.3.2 Schematic Documentation
      4. 2.2.4 Symbols
      5. 2.2.5 Cross-Referencing Documentation
    3. 2.3 Specifications
    4. Bibliography
  11. 3. Developing a Style Guide
    1. 3.1 Introduction
      1. 3.1.1 Definition of Documents
    2. 3.2 General Structure of Documents
      1. 3.2.1 Page Layout
      2. 3.2.2 Standard Writing Practices
        1. 3.2.2.1 Conciseness and Precision
        2. 3.2.2.2 Consistency in Sentence Structure
        3. 3.2.2.3 Punctuation
        4. 3.2.2.4 Character Styles
        5. 3.2.2.5 Headings and Titles
        6. 3.2.2.6 Bulleted and Numbered Lists
      3. 3.2.3 Image File Formats
    3. 3.3 Document Creation and Editing
      1. 3.3.1 Permissions
      2. 3.3.2 Citing References
        1. 3.3.2.1 Examples
      3. 3.3.3 Terms
      4. 3.3.4 Copyright, Trademark, and Legal Notices
      5. 3.3.5 Document Numbering
      6. 3.3.6 Maintaining Corporate Image Consistency
    4. 3.4 Corporate Identity
      1. 3.4.1 Logos
      2. 3.4.2 Colors
      3. 3.4.3 Software Interfaces
      4. 3.4.4 Advertising Materials
    5. 3.5 Reference Books
    6. References
  12. 4. Meetings
    1. 4.1 Introduction
    2. 4.2 Organization
      1. 4.2.1 Responsibility of the Chairperson
        1. 4.2.1.1 Minutes of the Meeting
        2. 4.2.1.2 Scheduling Meetings
        3. 4.2.1.3 The Agenda
        4. 4.2.1.4 Quorum
      2. 4.2.2 Challenges of Working Remotely
        1. 4.2.2.1 Time Zones, Daylight Savings, Holidays
        2. 4.2.2.2 Language Barriers
        3. 4.2.2.3 Cultural Differences
        4. 4.2.2.4 Voice Communications
        5. 4.2.2.5 E-mail Communications
        6. 4.2.2.6 Virtual or Remote Meetings
        7. 4.2.2.7 File Sharing/Collaborating
        8. 4.2.2.8 Less Formal Collaboration
      3. 4.2.3 Developing a Scope of Work
      4. 4.2.4 Developing a Work Plan
    3. 4.3 Decision Making
    4. 4.4 It’s All about Leadership
    5. References
  13. 5. Systems Engineering
    1. 5.1 Introduction
    2. 5.2 Systems Theory
      1. 5.2.1 Systems Engineering Process
      2. 5.2.2 Functional Analysis
        1. 5.2.2.1 Synthesis
        2. 5.2.2.2 Modeling
        3. 5.2.2.3 Dynamics
        4. 5.2.2.4 Optimization
      3. 5.2.3 Evaluation and Decision
        1. 5.2.3.1 Trade Studies
      4. 5.2.4 Description of System Elements
    3. 5.3 Phases of a Typical System Design Project
      1. 5.3.1 Electronic System Design
      2. 5.3.2 Detailed Design
      3. 5.3.3 Budget Requirements Analysis
      4. 5.3.4 Feasibility Study and Technology Assessment
        1. 5.3.4.1 Planning and Control of Scheduling and Resources
        2. 5.3.4.2 Project Tracking and Control
    4. 5.4 Program Management
      1. 5.4.1 Executive Manager
      2. 5.4.2 Project Manager
      3. 5.4.3 Systems Engineer
      4. 5.4.4 Other Project Team Members
    5. Bibliography
  14. 6. Concurrent Engineering
    1. 6.1 Introduction
    2. 6.2 Overview
      1. 6.2.1 The Team Process
    3. 6.3 The Process View of Production
      1. 6.3.1 Quality Function Deployment (QFD)
      2. 6.3.2 Design of Experiments (DOE)
      3. 6.3.3 Robust Design
    4. References
    5. Bibliography
  15. 7. Disaster Planning and Recovery
    1. 7.1 Introduction
      1. 7.1.1 Developing a Disaster Plan
    2. 7.2 Emergency Management
      1. 7.2.1 The Planning Process
      2. 7.2.2 Managing Risk
      3. 7.2.3 Risk Assessment and Business Resumption Planning
      4. 7.2.4 Workplace Safety
      5. 7.2.5 Outside Plant Communications Links
        1. 7.2.5.1 Outside Plant Wire
        2. 7.2.5.2 Microwave Links
        3. 7.2.5.3 Fiber Optic Links
        4. 7.2.5.4 Satellite
      6. 7.2.6 Emergency Power and Batteries
      7. 7.2.7 Air Handling Systems
      8. 7.2.8 Water Hazards
      9. 7.2.9 Alternate Sites
      10. 7.2.10 Security
      11. 7.2.11 Staff Expectations, 9-1-1, and Emergencies
    3. 7.3 Managing Fear
    4. References
    5. Bibliography
  16. 8. Standards and Reference Data
    1. 8.1 Introduction
      1. 8.1.1 The Standards Development Organization
      2. 8.1.2 Professional Society Engineering Committees
      3. 8.1.3 The History of Modern Standards
    2. 8.2 Principal Standards Organizations
      1. 8.2.1 International Organization for Standardization (ISO)
      2. 8.2.2 International Electrotechnical Commission (IEC)
      3. 8.2.3 International Telecommunication Union (ITU)
      4. 8.2.4 American National Standards Institute (ANSI)
    3. 8.3 Tabular Data
    4. References
    5. Bibliography
  17. 9. Document Templates
    1. 9.1 Introduction
    2. 9.2 Final Thoughts
  18. Index

Product information

  • Title: Technical Documentation and Process
  • Author(s): Jerry C. Whitaker, Robert K. Mancini
  • Release date: September 2018
  • Publisher(s): CRC Press
  • ISBN: 9781351833035