[Company Name]
[Company Group, Division, Location]
Document Title: Preparation of a Technical Report
Document Number: [Document Number]
Document Filename: [Document Filename]
CONTROLLED COPY/ MASTER COPYSTAMP HERE
OTHER
STAMP HERE
Revision Level / Revision Date / DCO/ECO
Number / Description of Revision / Revision
Author
DRAFT / DD/MM/YY / YY-00000 / Draft / Author Name
1.00 / DD/MM/YY / YY-00000 / Initial Release / Author Name
COMPANY PROPRIETARY AND CONFIDENTIAL
[Company Name] Prepartation of a Technical Report
[Company Group, Division, Location] [Document Number]
Rev x.xx DD/MM/YY
Table of Contents
1.0 Purpose 2
2.0 Scope 2
3.0 Definition Of Terms 2
3.1 Design History File (DHF) 2
3.2 Design Validation 2
3.3 Error Budget 2
3.4 Process Validation 2
3.5 Reliability Test Plan 2
3.6 Risk Analysis 2
3.7 Sensitivity Analysis 2
3.8 Validation 2
3.9 Verification 2
4.0 References 2
5.0 Responsibilities and Requirements 3
6.0 Types of Technical Reports 3
6.1 Design Validation Reports 3
6.2 Design Verification Reports 3
6.3 Error Budget Reports 3
6.4 Other Technical Reports 3
6.5 Product Support Reports 3
6.6 Reliability Test Reports 3
6.7 Risk Analysis Reports 3
6.8 Sensitivity Analysis Reports 3
7.0 Procedure 3
7.1 Purpose of Technical Reports 3
7.2 Technical Report Format and Contents 4
7.2.1 Abstract 4
7.2.2 Background 4
7.2.3 Introduction 4
7.2.4 Purpose 4
7.2.5 Description of Apparatus and Setup 4
7.2.6 Summary of Data and Results 4
7.2.7 Conclusions 4
7.2.8 Suggestions for Further Work 4
7.3 Key Considerations 4
7.4 Preparation of Technical Reports 5
7.5 Review of Technical Reports 5
7.6 Documenting Technical Reports 5
1.0 Purpose
This document defines the contents of and procedures for creating and submitting a Technical Report for release.
2.0 Scope
This procedure applies to all product development programs funded and managed by (Company Name).
3.0 Definition Of Terms
3.1 Design History File (DHF)
A compilation of records that describes the design history of a finished product.
3.2 Design Validation
Establishing by objective evidence that product specifications conform with user needs and intended use(s).
3.3 Error Budget
An allocation (or budget) of allowable error among possible sources of error to achieve compliance with design requirements.
3.4 Process Validation
Establishing by objective evidence that a process consistently produces a result or product meeting its predetermined specifications.
3.5 Reliability Test Plan
The written procedures and protocol to conduct reliability and maintainability testing of the engineering and/or manufacturing prototype. This testing determines technical compliance with reliability and maintainability objectives in the Design Requirements Document. It identifies real and potential deficiencies and specific areas for improvement.
3.6 Risk Analysis
The investigation and assessment of available information to identify hazards (a potential source of harm) and to estimate their risk (the probable rate of occurrence of a hazard and the severity of the harm).
3.7 Sensitivity Analysis
The investigation of components, subsystems, and the product to determine output response per unit change of input.
3.8 Validation
Confirmation by examination and provision of objective evidence that the particular requirements for a specific intended use can be consistently fulfilled.
3.9 Verification
Confirmation by examination and provision of objective evidence that specified requirements have been fulfilled.
4.0 References
Development of Design Output
Design History File
Experimentation Process
Technical Editor Checklist
5.0 Responsibilities and Requirements
[Insert the responsibilities and requirements for any positions that are involved with the preparation of a technical report. Foe example: Manager of Program Management, Technical Report Editors, etc.].
6.0 Types of Technical Reports
6.1 Design Validation Reports
Technical Reports presenting test procedures, results, and assessment of results from design validation activities.
6.2 Design Verification Reports
Technical Reports presenting test procedures, results, and assessment of results from design verification activities.
6.3 Error Budget Reports
Technical Reports detailing allocation of allowable error among possible sources of error to achieve compliance with design requirements.
6.4 Other Technical Reports
Technical Reports presenting test procedures, results, and assessment of results from other research, design, and development activities.
6.5 Product Support Reports
Technical Reports presenting the results and performance data on reliability, maintainability, serviceability, modifications, improvements, deficiencies, safety, customer interfacing, etc. during support of the product in the field.
6.6 Reliability Test Reports
Technical Reports presenting test procedures, results, and assessment of results from reliability and maintainability testing.
6.7 Risk Analysis Reports
Technical Reports presenting the results of an investigation of the product and available information to identify hazards, estimate their likelihood, and determine the severity associated with each hazard.
6.8 Sensitivity Analysis Reports
Technical Reports presenting the results of an investigation of components, subsystems, and the product to determine output response per unit change of input.
7.0 Procedure
7.1 Purpose of Technical Reports
There are two (2) primary purposes of technical reports.
· Disseminate information
· Record results and conclusions for future use
This procedure presents a uniform standard for technical reports. The format may vary slightly depending on the subject matter, but as a minimum, should convey the following information in a clear and succinct fashion.
7.2 Technical Report Format and Contents
Structure the technical report according to the following listed subsections. If the subsection does not apply, then include a statement to indicate the requirement is not applicable in that report. The Technical Editor Checklist extracts the minimum requirements detailed in this procedure for use as a guide when preparing reports for final submission.
7.2.1 Abstract
Present a condensed synopsis of the report including a brief description of the setup of the work, its purpose, the results, and the conclusions. This overview is short, concise, and no more than one page. The abstract is presented on the approved cover sheet for technical reports.
7.2.2 Background
Present a summary of the technical information and preceding work forming the basis for this work and subsequent technical report.
7.2.3 Introduction
Present a detailed statement of the problem that is the subject of the technical report. The statement should proceed logically from the previous background summary.
7.2.4 Purpose
Present a concise statement of the purpose of the work.
7.2.5 Description of Apparatus and Setup
Give a description of the equipment used in the work and the setup design of the experimentation or analysis. Always give a full description of the existing conditions at the time of the work. If the existing conditions are not relevant to the results of the experiment, include a statement as such in the report with a brief explanation as to the reasons for this determination. Refer to procedure Experimentation Process, for details of setting up and conducting experiments.
Provide a drawing and procedure for any experimental apparatus and equipment. Reports must contain drawings for any specially fabricated apparatus and text to describe the apparatus and procedure. If there were no devices or apparatus used in the experiment, include a statement as such in the report. If the devices used are not specified, and substitution of common test equipment or measuring devices will not impact the results, include a statement permitting such action in the report.
7.2.6 Summary of Data and Results
Present a description of the data and results. Attach raw data to the technical report.
7.2.7 Conclusions
Present conclusions from the work in precise, unambiguous terms.
7.2.8 Suggestions for Further Work
Present suggestions for analysis and experimentation to further investigate this problem or related subjects. If no further work is deemed necessary as of the release of the report, include a statement as such in the report.
7.3 Key Considerations
The following are considerations and basic principles to follow in preparing a technical report.
· Ensure the material in the report is understandable and useful to others.
· Avoid the use of platitudes and clichés. Eliminate phrases such as "due to the fact", "generally speaking", "resulting from", "it is obvious that", etc.
· Eschew obfuscation. Write clearly, concisely, and to the point.
· Use drawings to describe an apparatus or in any other situation where clarity can be increased with a diagram.
· For data plots, always give a complete description of the method and conditions for acquiring the data.
· Describe drawings and data in figure captions.
· Use correct grammar.
· Avoid use of the passive voice. Write in the active voice for more impact.
7.4 Preparation of Technical Reports
[Specify who is responsible for completing technical reports. Mark the type of technical report and complete all other sections of the cover sheet to allow for effective data base searches. Attach raw data records to the report and submit it to the appropriate party for review].
7.5 Review of Technical Reports
[Insert the information regarding review of technical reports, include who is responsible for reviewing the reports, and who has final approval in the matter of contents and responsibilities for subject matter].
7.6 Documenting Technical Reports
[Insert (company name) procedure for documenting the technical reports. Include who the report should be submitted to, where and how it will be filed and who is responsible for reviewing and updating].
[Document Filename] COMPANY PROPRIETARY AND CONFIDENTIAL Page 5 of 5