Attachment 14_FAA-D-2494b.pdf

**i2USte*

-**" O" h

FAA-D-2A94/b March 14, 1934 JaUyhHlbilkl/ FAA-D-2494/1a

/2 /3 /4

DEPARTMENT OF TRANSPORTATION

FEDERAL AVIATION ADMINISTRATION

SPECIFICATION

TECHNICAL INSTRUCTION BOOK MANUSCRIPT: ELECTRONIC, ELECTRICAL,

AND MECHANICAL EQUIPMENT, REQUIREMENTS FOR PREPARATION OF

MANUSCRIPT" AND PRODUCTION OF BOOKS

Attachment J. 13, FAA Order FAA-D-2494/b, is a 134 page document.

Only the cover sheet and index are attached to this SIR/RFP.

If a vendor is required to develop a technical instruction manual, as part of an installation Task Order, a compact disk containing the entire document will accompany the Task Order. This document is only needed where custom built electrical or mechanical equipment is installed as directed by the Government.

All Government Furnished Equipment (GFE) and Commercial-Off the Shelf (COTS) equipment come with either Government produced Technical Instruction manuals or factory operation and maintenance manuals.

Kathleen D Islas Typewritten Text Attachment 14

DTFAAC-15-R-02838

FAA-D-2494/b iii

TABLE OF CONTENTS

Paragraph Title Page

1. Scope 1

1.1 General 1

1.1.1 New equipment 1

1.1.2 Commercial publications 1

1.2 Responsibility 2

1.3 Precedence of requirements 2

2. Applicable documents 2

2.1 FAA documents 2

2.2 Military documents 2

2.3 Other Government publications 3

2.4 American National Standards Institute (ANSI)

publications 3

2.5 Institute of Electrical and Electronics

Engineers (IEEE) 3

3. Requirements A

3.1 General requirements 4

3.1.1 Writing level 4

3.1.2 Grammatical person and mood 5

3.1.3 Use of directive verbs 5

3.1.4 Nomenclature consistency 5

3.1.5 Development of text 6

3.1.6 Warnings, cautions, and notes 6

3.1.7 Tables 7

3.1.7.1 Uses of tables 7

3.1.7.2 Rules for tables 8

3.1.7.3 Table format 8

3.1.7.4 Numbering and titling of tables 8

3.2 Manuscript plan 8

3.2.1 Prospectus 8

3.2.2 Manuscript schedule

3.2.2.1 Manuscript review schedule 9

3.2.2.2 Manuscript validation schedule 9

3.2.3 Verification and validation plan 9

3.3 Manuscripts 11

3.3.1 Draft manuscripts • 11

3.3.1.1 In-process reviews 11

3.3.1.2 Typing and format requirements for draft

copies 11

3.3.1.2.1 Typing equipment 11

3.3.1.2.2 Paragraph numbering 12

3.3.1.2.3 Paragraph headings 12

3.3.1.2.4 Page numbering 12

3.3.1.3 Draft artwork 12

3.3.2 Final manuscript 12

3.3.2.1 Typing and format requirements for

reproducible copy 15

3.3.2.1.1 Machine printouts 15

3.3.2.1.2 • Publication number 15

3.3.2.1.3 Publication date 16

IV

Paragraph Title Page

3.3.2.2 Final artwork 16

3.3.2.2.1 Original used in preparation of

illustrations 16

3.3.2.2.2 Overlays on artwork 16

3.3.2.2.3 Covering of artwork 16

3.3.2.2.4 Troubleshooting support data format

3.3.2.3 Suggested improvements form 16

3.4 Reference designations, symbols, and

abbreviations 20

3.4.1 Reference designations 20

3.4.2 Letter symbols for semiconductor devices . . 20

3.4.3 Letter symbols and mathematical signs . . . 20

3.4.4 Graphic symbols for circuit elements

3.4.5 Mechanical diagram symbols 20

3.4.6 Flow chart symbols 20

3.4.7 Logic diagram symbols 21

3.4.8 Designation for switch gear and industrial

control devices 21

3.4.9 Special symbols 21

3.4.10 Acronyms and other abbreviations 21

3.5 Security classification marking 21

3.6 Arrangement of manuscript contents 21

3.6.1 Front cover 21

3.6.1.1 Front cover content . . 21

3.6.1.2 Cover stock 24

3.6.2 Contractor guarantee 24

3.6.3 List of modifications to specifications . . . 24

3.6.4 List of effective pages 24

3.6.5 Content assurance page 24

3.6.6 Table of contents 26

3.6.7 List of illustrations 26

3.6.8 List of tables 26

3.6.9 Family tree chart 26

3.6.10 Section 1 of instruction book, general

information and requirements 23

3.6.10.1 Introduction 23

3.6.10.2 Equipment description 23

3.6.10.3 Relationship of units 28

3.6.10.4 Equipment specification data . 28

3.6.10.4.1 Nameplate data 30

3.6.10.4.2 Functional characteristics 30

3.6.10.4.3 External power requirements 30

3.6.10.4.4 Rated output 30

3.6.10.4.5 Environmental characteristics 30

3.6.10.5 Equipment and accessories supplied 30

3.6.10.6 Equipment required but not supplied 30

Paragraph Title Page

3.6.11 Section 2 of instruction book, technical

description 31

3.6.11.1 Simplified theory of operation

3.6.11.2 Detailed theory of operation 31

3.6.11.2.1 Equivalent circuits 32

3.6.11.2.2 Timing diagrams 32

3.6.11.2.3 Logic circuits 32

3.6.11.2.4 Mechanical functions 36

3.6.12 Section 3 of instruction book, operation . . . 36

3.6.12.1 Controls and indicators 36

3.6.12.2 Turn-on-and checkout . 36

3.6.12.3 Remote monitoring and control 36

3.6.12.4 Equipment shutdown 36

3.6.13 Section 4 of instruction book, standards and

tolerances 39

3.6.13.1 Parameter 39

3.6.13.2 Procedure paragraph reference 39

3.6.13.3 Standard 39

3.6.13.4 Initial tolerance limit

3.6.13.5 Operating tolerance limit . . . 39

3.6.13.6 Interconnecting cables and circuits 39

3.6.13.7 Remote monitor and alarms 39

3.6.14 Section 5 of instruction book, periodic

maintenance 41

3.6.14.1 Tabular presentation 41

3.6.14.2 Performance checks

3.6.14.3 Other onsite maintenance 41

3.6.14.4 Offsite maintenance 41

3.6.15 Section 6 of instruction book, maintenance

procedures 43

3.6.15.1 Content 43

3.6.15.2 Format 43

3.6.15.3 Performance check procedures 43

3.6.15.4 Other maintenance procedures 43

3.6.15.5 Special maintenance procedures 43

3.6.16 Section 7 of instruction book, corrective

maintenance 44

3.6.16.1 Onsite corrective maintenance 44

3.6.16.2 Offsite repair 44

3.6.16.3 Test equipment 44

3.6.16.4 Overhaul, maintenance, and repair standards . 44

3.6.16.5 Packing instructions 45

3.6.17 Section 8 of instruction book, parts list . . 46

3.6.17.1 Parts list format 46

3.6.17.2 Use of latest JAN/MIL designations

3.6.17.3 Design change incorporation 48

3.6.17.4 Electrical parts 48

FAA~D-2494/b vi

Paragraph

3.6.17.5 3.6.17.6 3.6.17.7 3.6.17.8 3.6.17.9 3.6.17.10 3.6.17.11 3.6.17.12 3,6.18

3.6.18.1 3,6.18.2 3.6.18.3 3.6.18.4 3.6.18.5 3.6.18.6 3.6.18.7 3.6.18.8 3.6.19

3.6.19.1 3.6.19.2 3.6.19.2.1 3.6.19.2.2 3.6.19.2.3 3.6.19-2.4 3.6.19.2.5 3.6.19.2.6 3.6.19.2.7 3.6.19.3 3.6.19.3.1 3.6.19.3.2 3.6.19.3.3 3.6.20

3.6.20.1 3.6.20.1.1 3.6.20.1.2 3.6.20.1.3 3.6.20.2 3.6.20.3 3.6.20.4 3.6.20.5 3.6.20.6 3.6.20.7 3.6.20.7.1 3.6.20.7.2 3.6.20.8 3.6.20.9 3.6.20.10 3.6.20.11 3.6.20.12 3.6.20.13 3.6.20.14

Title Page

Mechanical data 52 Transformer size data . 52 Lubrication data 52 Indicating fuse holder 53 Indicator lights t3 Tube sockets t3 Listing of plug-in modules or printed wiring circuits 53 List of manufacturers 53 Section 9 of instruction book, installation, integration, and checkout 54 Site information 54 Installation drawings 55 Unpacking and repacking 55 Input requirement summary 55 Installation procedures 55 Inspection 55 Initial startup and preliminary testing ... 56 Installation verification test 56 Section 10 of instruction book, computer software 57 Program hierarchy 57 Program descriptions 57 Program purpose 57 Program capacity 57 Interface 57 Program input data 58 Program output data Database descriptions 53 Program documentation 58 Listings 53 Program listings 58 Cross-reference listings 59 Load maps 59 Section 11 of instruction book, troubleshooting support data 60 Method of presentation 60 Contractor's commercial publications Standard (8-1/2 by 11-inch) binding 60 Separate oversize (11- by 17-inch) binding . 60 Legibility 61 Numbering and titling , 61 Size of illustrations Block diagrams 63 Major function diagram 63 Schematic diagrams 63 Diagrams for analog equipment 65 Diagrams for functional entities 65 Functional circuits 65 Nomenclature and reference designations ... 66 Discrete circuit element data 66 Identification of adjustments and controls . 66 Test points . * 66 Photographs 66 Continuous-tone illustrations 67 vii

Paragraph Ti tie Page

3.6.20.15 Printed circuit board illustrations

3.6.20.16 Callouts 67

3.6.20.17 Leader lines 69

3.6.20.18 Power distribution diagram 69

3.6.20.19 ' Wiring diagrams

3.6.20.20 Cabling diagrams 69

3.6.20.21 Mechanical drawings 69

3.6.20.22 Piping diagram 69

4. Quality assurance provisions 70

4.1 Responsibility for inspection 70

4.1.1 Contractor inspection , 70

4.1.2 Inspection of artwork 70

4.1.3 Proofreading 70

4.1.4 Completeness and continuity 70

4.1.5 Assembly instructions 70

4.2 Quality program requirements 71

4.2.1 Personnel 71

4.2.2 Coordination '71

4.3 Validation 71

4.4 Validation of changes 72

4.5 Verification • 72

4.6 Government inspection ..." 72

5. Preparation for delivery '72

5.1 Packaging of reproducible (camera-ready) copy 72

5.2 Packaging of original artwork 72

5.3 Printing instructions 72

5.3.1 Page size 72

5.3.2 Paper stock 73

5.3.3 Negatives 73

5.3.4 Printing 73

5.3.5 Drilling 73

5.4 Binding 7?

5.5 Review and acceptance of printed books . . . 74

5.6 Packaging of books for delivery 74

Summary of Definitions 103 Acronyms and Abbreviations 105 v m

LIST OF FIGURES

Title Page

Figure 1 Figure 2 Figure 3 Figure 4

Figure 5

Figure 6

Figure 7 Figure 8 Figure 9 Figure Figure 11 Figure 12 Figure Figure Figure Figure Figure Figure Figure Figure 20 Figure 21 Figure 22 Figure 23 Figure 24 Figure 25

Figure 26 Figure 27

Figure 28 Figure 29 Figure 30 Figure 30 Figure 31 Figure 32 Figure 33

Manuscript schedule 10 Right-hand page format 13 Left-hand page format 14 Identification, marking, and cover for artwork 17 Typical front cover, troubleshooting support data volume 18 Suggested improvements to equipment instruction book 19 Typical front cover 23 Content assurance page Family tree chart 27 Relationship of units 29 Functional flow diagram 7^ Signal flow diagram 77 Logic circuit diagram 33 Integrated circuit logic diagrams 34 Integrated circuit data center 79 Machine logic diagram 35 Intermediate logic diagram . 81 Controls and indicators presentation ... 37 Sample turn-on and checkout tabular format 33 Example of standards and tolerances table . 40 Signal flow diagram 42 Parts list format 47 Oversize sheet dimensions 62 Foldout page dimensions 64 Sample block diagram of chassis with plug-in units 35 Sample chassis schematic diagram b?

Sample schematic breakdown to component level showing IF amplifier 89 Printed circuit board 91 Use of leader lines for callouts 68 Power distribution diagram (sheet 1 of 2} . 93 Power distribution diagram (sheet 2 of 2) . •>> Sample wiring diagram 07 Mechanical schematic h^ Piping diagram 10' Appendix 1 - Commercial Instruction Books Index

& 33