A reformat of your product’s owner’s manuals can create a great impression for potential customers.
A third-person editorial review of your owner’s manuals can result in a cleaner document, better-informed customers, and reduced service calls.
Improved cross-references, enhanced diagrams, additional notes and explanations, and an outsider’s perspective on the operation of your product — all help bring your product manuals up to a professional standard.
• Real-world products and devices:
– Sample: Camping trailer owner’s manual:
– Sample: Automatic door-closer installation manual:
Figure 3 show a side view of one possible installation, along with the door and frame. See the manual for additional installation options and diagrams.
• Industrial controls and related software:
– Sample: CNC Control Box:
A redesigned CNC sub-component control-box front panel is shown in Figure 4. The new panel includes international key and display icons, a more intuative key placement, and an accompanying operating-logic redesign which provides a simpler and more consistent user experience.
– Sample: Fryer user’s manual:
Figure 5 is a diagram from the fryer’s user’s manual. An all-new operating logic and improved key icons resulted in a superior product design. See State machines for a discussion of the benefits provided by this product-design process.
• Single-source documentation suite — information factoring and re-use:
Documentation integrity and ease of updates are each improved by the proper factoring and automated re-use of common blocks of information. When done at too fine of a level, context is lost, and when done at too coarse of a level, re-usability is lost.