1st Edition

Technical Documentation and Process

    196 Pages 49 B/W Illustrations
    by CRC Press

    196 Pages
    by CRC Press

    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.

    Overview
    Introduction
    Plan for Success
    Elements of Process
    Putting It All Together

    Documentation Strategies
    Introduction
    Documentation Tools
    Specifications
    Bibliography

    Developing a Style Guide
    Introduction
    General Structure of Documents
    Document Creation and Editing
    Corporate Identity
    Reference Books
    References

    Meetings
    Introduction
    Organization
    Decision-Making
    It’s All about Leadership
    References

    Systems Engineering
    Introduction
    Systems Theory
    Phases of a Typical System Design Project
    Program Management
    Bibliography

    Concurrent Engineering
    Introduction
    Overview
    The Process View of Production
    References

    Disaster Planning and Recovery
    Introduction
    Emergency Management
    Managing Fear
    References

    Standards and Reference Data
    Introduction
    Principal Standards Organizations
    Tabular Data
    References
    Bibliography

    Document Templates

    Index

    Biography

    Jerry C. Whitaker is the vice president of standards development at the Advanced Television Systems Committee (ATSC). He has been involved in various aspects of the electronics industry for more than 30 years, with specialization in communications. His CRC Press books include:

    Robert K. Mancini is president of Mancini Enterprises, LLC, a business consulting, estate planning, and educational services corporation based in California. He has been involved in programming, product management, technical writing, sales/product training, and marketing in the software and aerospace industries for more than 30 years. His authored projects include:
    • Image Focus manuals, marketing, and training materials, NewEra Software
    • DSSI product marketing materials, Allen Systems Group
    • PRO/JCL manuals, marketing, and training materials, Diversified Software
    • DOCU/TEXT manuals, marketing, and training materials, Diversified Software
    • JOB/SCAN manuals, marketing, and training materials, Diversified Software
    • INFO/X manuals, marketing, and training materials, Diversified Software

    "This is a great resource for those starting projects to ensure the details are supported and complete. The insights and direction found in this resource provide time and labor-saving counsel that are well worth consideration and application."
    —Dr. Rick Bee, Biola University, La Mirada, California, USA