2.2 How to implement a Documentation program

1. Ensure that your event reporting system is capturing events where documentation is a contributing factor; code these events so that focused interventions are developed and tracked.
   
   
2. When implementing technology upgrades or changes to the document system, preserve standardization and best practices; take the opportunity to address current problems.
   
   
3. When addressing standardization issues across mixed fleets, use industry working group to achieve standardization (e.g., structure, terminology, logic) within and across manufacturers.
   
   
4. For technical documentation developed by the maintenance organization, develop guidelines and standards for documentation development. The guidelines/standards should include the following:
   
   
   1. Use a standard format and page layout.
      
      
   2. Use one action per statement.
      
      
   3. Write DANGER, WARNING, and CAUTION statements using current international (American National Standards Institute/International Standards Organization) standards.
      
      
   4. Avoid using acronyms and abbreviations.
      
      
   5. Ensure that where an arrow is pointing to a figure or graphic it is immediately obvious.
      
      
   6. Use A Guide for the Preparation of Aircraft Maintenance Documentation in the International Aerospace Maintenance Language ( Simplified English).
      
      
   7. Verify the documentation by having a second person check for technical accuracy.
      
      
   8. Validate the documentation by having a sample of users check for usability.
      
      
5. Provide a process for immediate and longer-term improvements to technical documents based on user feedback.
   
   
6. Ensure prompt acknowledgement to submissions for document change.
   
   
7. Respond to the document improvement suggestion in a timely manner.
   
   
8. Develop measures to track specific documentation problems and corrective actions.
   
   
9. Be sure the document delivery system is functional and well maintained.
   
   
10. Use advice from documentation research and industry best practices.