The major military specification for technical manuals is MIL-STD-38784. This document describes in detail each factor of a technical guide, like formatting, layout, content material, and several other practices. There are illustrations in the appendix to display you exactly how, for instance, a U.S Army technical manual need to seem. But even with this degree of detail, it has been my knowledge that every obtaining command will have various concepts on how they want their guide to seem.
1 of the other principal standards used for technical manuals comes from the aerospace market. The voluminous ATA one hundred specification describes the correct way to develop documentation for each and every aspect of an aircraft. For there are chapter codes assigned to each element of the airplane " for illustration 24 is Electrical Energy, 23 is Communications, and 49 is Airborne Auxiliary Power.
Most specs will also incorporate a comprehensive explanation of how illustrations must be presented. The militarys 38784 specification information line weights, callouts, and numerous other facets of graphics that want to be proper for military technical manuals.
Software program documentation is somewhat distinct. A single of the greatest requirements for application technical writing was a guide initially published by Digital Products Corporation. The Digital Fashion Guidebook is an superb document to stick to when you are creating user guides for application goods.
Microsoft has created its very own Manual of Type for Technical Publications. This book is an outstanding tool for the technical writer trying to figure out how to describe a variety of aspects of the computer software consumer interface.
When you are doing work in particular industries or with smaller sized buyers, there may not be any clear specification to comply with. I would suggest that you examine the publications of other businesses in the exact same line of organization (suppliers and vendors) to see what their technical manuals look like. Or you can adapt a single of the aforementioned specifications to the process, even though they might be overkill for smaller projects.
Eventually, any technical manual has to meet the specifications of the end consumer. For technical creating companies, it is crucial to grow to be acquainted with the key specifications in the arena in which you intend to secure business. What you will locate is that most of the specifications are just variations on a theme. A lot of of the essential components of a technical guide " table of contents, foreword, introduction, theory of operation, etc. " are common to most technical manuals. Nevertheless the arrangement and formatting of these components will vary based on which specification you are following.
Michael D. Bean has twenty many years of expertise creating technical manuals.. As president of Allard, Integrated, he writes a blog about technical manuals. If you are interested in finding out far more, please check out our website. Thanks.
Orignal From: Specifications That Guide Technical Writers
No comments:
Post a Comment