Sae aerospace technical report style manual

Pdf File 1,262.91 KByte,

Downloaded from

SAE AEROSPACE TECHNICAL REPORT STYLE MANUAL

AUGUST 2007

Downloaded from

Downloaded from

SAE AEROSPACE TECHNICAL REPORT STYLE MANUAL This SAE Aerospace Technical Report Style Manual was prepared specifically for sponsors of SAE Aerospace Technical Reports (excluding Aerospace Material Specifications (AMS)). It contains all pertinent editorial and technical requirements for the preparation of SAE Aerospace Technical Reports, Aerospace Standards, Aerospace Recommended Practices, Aerospace Information Reports, and Aerospace Resource Documents (in inch-pound units/SI units versions). Editorial and technical requirements for the preparation of SAE AMS specifications can be found in the Manual for the Preparation of Aerospace Material Specifications. This Style Manual documents SAE's editorial policies and procedures. Rapidly changing technology has greatly increased the need for consistency and standardization in standards production. The purpose of the Style Manual is to improve consistency in SAE Aerospace Technical Reports and, thereby, enhance utilization of new technology. It is designed to formalize existing procedures and practices and from these, create a thorough SAE Aerospace Technical Report production policy that will enable SAE to meet the needs of present and future technology.

Revised August 2007

Downloaded from

SAE AEROSPACE TECHNICAL REPORT STYLE MANUAL

TABLE OF CONTENTS

1.

SCOPE ................................................................................................................................................................... 4

1.1 Purpose................................................................................................................................................................... 4

2.

REFERENCES....................................................................................................................................................... 4

2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.2 2.3

Applicable Documents............................................................................................................................................ 4 SAE Publications .................................................................................................................................................... 4 ANSI Publications................................................................................................................................................... 4 ASME Publications ................................................................................................................................................. 4 IEEE Publications ................................................................................................................................................... 4 U.S. Government Publications............................................................................................................................... 5 Applicable References ........................................................................................................................................... 5 Definitions ............................................................................................................................................................... 5

3.

EDITORIAL REQUIREMENTS.............................................................................................................................. 6

3.1 Abbreviations and Symbols.................................................................................................................................... 7 3.2 Appendices ............................................................................................................................................................. 7 3.3 CAUTION Within Text ............................................................................................................................................ 8 3.4 Cross-References .................................................................................................................................................. 8 3.5 Date (Issued/Revised)............................................................................................................................................ 9 3.6 Decimal Values....................................................................................................................................................... 9 3.7 Equations ................................................................................................................................................................ 9 3.8 Equivalency Statement........................................................................................................................................... 9 3.9 Figures .................................................................................................................................................................... 9 3.9.1 Numbering Figures................................................................................................................................................. 9 3.10 Footnotes ..............................................................................................................................................................10 3.11 Foreword...............................................................................................................................................................10 3.12 Headings...............................................................................................................................................................10 3.12.1 Front or Back Matter.............................................................................................................................................10 3.12.2 Section Headings .................................................................................................................................................11 3.12.3 Primary Paragraph Headings...............................................................................................................................11 3.12.4 Secondary and All Subsequent Headings...........................................................................................................11 3.13 Key Words ............................................................................................................................................................11 3.14 Listings..................................................................................................................................................................11 3.15 NOTE Within Text.................................................................................................................................................12 3.16 Notes Section .......................................................................................................................................................12 3.17 Numbers ...............................................................................................................................................................12 3.18 Prepared By Statement ........................................................................................................................................13 3.19 Proprietary Names................................................................................................................................................13 3.20 Punctuation...........................................................................................................................................................13 3.20.1 Apostrophe ...........................................................................................................................................................13 3.20.2 Comma .................................................................................................................................................................13 3.20.3 Hyphen .................................................................................................................................................................14 3.20.4 Parentheses..........................................................................................................................................................14 3.20.5 Quotation Marks ...................................................................................................................................................14 3.21 Ranges..................................................................................................................................................................14 3.22 Rationale...............................................................................................................................................................15 3.23 References or Applicable Documents Section....................................................................................................15 3.24 Registered Trademarks........................................................................................................................................20 3.25 Revision Indicators ...............................................................................................................................................21 3.26 Sectional Arrangement.........................................................................................................................................21 3.27 Table of Contents .................................................................................................................................................22

2

Downloaded from

SAE AEROSPACE TECHNICAL REPORT STYLE MANUAL

3.28 Tables ...................................................................................................................................................................22 3.29 Tolerances ............................................................................................................................................................23

4.

TECHNICAL REQUIREMENTS ..........................................................................................................................23

4.1 Abbreviations and Symbols..................................................................................................................................23 4.2 Artwork..................................................................................................................................................................23 4.3 Copyrighted Material ............................................................................................................................................23 4.4 Decimal Dimensioning..........................................................................................................................................23 4.5 Decimal Values.....................................................................................................................................................24 4.6 Dimensioning and Tolerancing Drawings............................................................................................................24 4.7 Figures ..................................................................................................................................................................24 4.8 General Considerations for SAE Aerospace Technical Reports ........................................................................24 4.8.1 Minimum Requirements .......................................................................................................................................24 4.8.2 Notice on All SAE Aerospace Technical Reports................................................................................................24 4.8.3 Patents and Copyrights ........................................................................................................................................25 4.8.4 Source of Supply ..................................................................................................................................................25 4.8.5 Test Materials .......................................................................................................................................................25 4.9 Mathematical Expressions ...................................................................................................................................25 4.10 Metrication ............................................................................................................................................................25 4.11 Numbering of SAE Aerospace Technical Reports ..............................................................................................25 4.11.1 Integrity of SAE Aerospace Technical Report Numbers .....................................................................................25 4.11.2 Prefixes .................................................................................................................................................................25 4.11.3 Revision Letters....................................................................................................................................................25 4.12 References to Other Documents .........................................................................................................................26 4.13 Registered Trademarks........................................................................................................................................26 4.14 Revisions to Existing SAE Aerospace Technical Reports ..................................................................................26 4.15 Shall or Should, Use of.........................................................................................................................................26 4.16 Titles of SAE Aerospace Technical Reports .......................................................................................................26 4.17 Procurement Specification QML/QPL Requirement ...........................................................................................27

5.

TYPING REQUIREMENTS..................................................................................................................................27

5.1 General Requirements .........................................................................................................................................27

6.

SAE AEROSPACE PARTS OR DESIGN STANDARD FORMATS...................................................................28

6.1 6.2 6.3 6.4 6.5 6.5.1 6.5.2 6.5.3 6.5.4 6.5.5 6.5.6

Parts Drawing Paper - First Page ........................................................................................................................28 Parts Drawing Paper - Second and Subsequent Pages.....................................................................................28 Editorial Requirements .........................................................................................................................................28 Typing Requirements ...........................................................................................................................................31 Technical Requirements ......................................................................................................................................31 Presentation.......................................................................................................................................................... 31 Graphical Representation ....................................................................................................................................33 Tabular Data .........................................................................................................................................................34 Part Number .........................................................................................................................................................37 Notes..................................................................................................................................................................... 38 Additional Requirements for G-3 Aerospace Parts or Design Standards Only..................................................42

7.

SAE AEROSPACE SUPPLEMENT.....................................................................................................................42

7.1 Supplement Balloting ...........................................................................................................................................42 7.2 Supplement Designations ....................................................................................................................................43 7.3 Instructions and Entry Format ..............................................................................................................................43

3

Downloaded from

SAE AEROSPACE TECHNICAL REPORT STYLE MANUAL

1. SCOPE

Section 1 will be designated as the SCOPE, which should briefly describe only the applicability of the document. The SCOPE should not be a summary of the contents of the document and should not be confused with the FOREWORD, RATIONALE, etc. All documents MUST have a SCOPE.

1.1 Purpose

This paragraph is always numbered 1.1. It describes the purpose of your document.

2. REFERENCES

Section 2 shall be designated REFERENCES. All pertinent and/or reference documents shall be listed here. These documents shall be grouped by publisher and information shall be provided on where to obtain the documents. SAE documents always go first, then the rest go in alphabetical order.

2.1 Applicable Documents

The following publications form a part of this document to the extent specified herein. The latest issue of SAE publications shall apply. The applicable issue of other publications shall be the issue in effect on the date of the purchase order. In the event of conflict between the text of this document and references cited herein, the text of this document takes precedence. Nothing in this document, however, supersedes applicable laws and regulations unless a specific exemption has been obtained.

2.1.1 SAE Publications

Available from SAE International, 400 Commonwealth Drive, Warrendale, PA 15096-0001, Tel: 877-606-7323 (inside USA and Canada) or 724-776-4970 (outside USA),

AS1290

Graphic Symbols for Aircraft Hydraulic and Pneumatic Systems

ARP1987

Titles SAE G-3 Committee Document Selection of

TSB 003

Rules for SAE Use of SI (Metric) Units

SAE Technical Standards Board Governance Policy

2.1.2 ANSI Publications

Available from American National Standards Institute, 25 West 43rd Street, New York, NY 10036-8002, Tel: 212642-4900,

ANSI/IEEE Std 260.1

American National Standard Letter Symbols for Units of Measurement

ANSI/IEEE Std 260.3

American National Standard Mathematical Signs and Symbols for Use in Physical

Sciences and Technology

ISO and Federal Specifications

2.1.3 ASME Publications

Available from American Society of Mechanical Engineers, 22 Law Drive, P.O. Box 2900, Fairfield, NJ 07007-2900, Tel: 973-882-1170,

ASME Y14.38

Abbreviations and Acronyms

2.1.4 IEEE Publications

Available from Institute of Electrical and Electronics Engineers, 445 Hoes Lane, Piscataway, NJ 08854-1331, Tel: 732-981-0060,

4

Download Pdf File