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 templateOCothe 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 authorsOCO 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.
The book covers a wide range of technical information, and a good bit of it focuses on the technical details of mechanical and logical processes. So, although the book does cover elements of technical documentation, the reader should be aware that the specifics of documentation is only about 50% of the book (maybe even less). It's not a bad book by any means, but I think the author could probably shift some focus away from the nuts and bolts of engineering processes and focus more on understanding the logic of technical documentation (with numerous examples) so that folks can see and understand why technical writing requires meticulous attention to details.