Technical documentation is a generic term for the classes of information created to describe (in technical language ) the use, functionality or architecture of a product, system or service.
7-450: A Quick Reference Handbook ( QRH ) is an aircraft technical document – quick-access manual for aircraft pilots that contains all the procedures applicable for non-normal and emergency conditions in an easy-to-use format. In addition, performance data corrections are also provided for specific conditions. A QRH is kept in the cockpit and can be consulted whenever the flight crew experiences in-flight problems. The first QRHs in
14-839: Is the Cabin Altitude Warning or Rapid Depressurization checklist. Technical documentation Classes of technical documentation may include: Historically, most classes of technical documentation lacked universal conformity (standards) for format, content and structure. Standards are being developed to redress this through bodies such as the International Organization for Standardization (ISO), which has published standards relating to rules for preparation of user guides, manuals, product specifications, etc. for technical product documentation. These standards are covered by ICS 01.110. Technical product documentation not covered by ICS 01.110 are listed in
21-558: The Quick Reference Handbook. When designed and used correctly to address issues such as turbine engine failures or on-board fires, a QRH can prevent aviation accidents and incidents . QRH have to include time-critical information and frequently used information for the flight crew. One example of a checklist in a QRH is the Engine Failure/Fire – Severe Damage or Separation checklist. Another example
28-515: The 20th century were made out of paper, but in the 21st century, many pilots have switched to so-called electronic flight bags , which have the advantage of electronic search functions, but require electricity to work. Some modern aircraft such as the Airbus A330 have computerised some of the checklists, but other checklists cannot be properly programmed, because some problems cannot be correctly identified or diagnosed by aircraft computers; thus,
35-604: The Quick Reference Handbook remains an essential in-flight tool for the crew. QRH includes various checklists for dealing with abnormal and emergency situations, based on the equipment and furnishings on the airplane . The aircraft manufacturer -designated checklists are always included in a QRH, and often the airline company or operator will include its own procedures. Therefore, there is no single universal QRH and they may differ widely in contents, but in practice, individual versions of it are referred to as
42-493: The subsection below. A technical documentation is also required for medical devices following EU medical device regulation . Annex II, Technical documentation, and Annex III, Technical documentation on post-market surveillance, of the regulation describe the content of a technical documentation for a medical device . This includes e.g. information on the device specification, labelling and instructions, design and manufacture, safety and performance requirements, risk management, and
49-459: The validatain and verfification of the device, including the clinical evaluation; and also information from postmarketing surveillance . Some documentation systems are concerned with the overall types or forms of documentation that constitute a documentation set, as well as (or rather than) how the documentation is produced, published or formatted. For example, the Diátaxis framework (which
#869130