NAVY MIL-HDBK-3001-2001 GUIDE TO THE GENERAL STYLE AND FORMAT OF U S NAVY WORK PACKAGE TECHNICAL MANUALS《美国海军工作技术手册一般的风格和形式指南》.pdf

《NAVY MIL-HDBK-3001-2001 GUIDE TO THE GENERAL STYLE AND FORMAT OF U S NAVY WORK PACKAGE TECHNICAL MANUALS《美国海军工作技术手册一般的风格和形式指南》.pdf》由会员分享，可在线阅读，更多相关《NAVY MIL-HDBK-3001-2001 GUIDE TO THE GENERAL STYLE AND FORMAT OF U S NAVY WORK PACKAGE TECHNICAL MANUALS《美国海军工作技术手册一般的风格和形式指南》.pdf（301页珍藏版）》请在麦多课文档分享上搜索。

1、MIL-HDBK-3001(AS)15 May 2001DEPARTMENT OF DEFENSEHANDBOOKGUIDE TO THE GENERAL STYLE AND FORMATOFU.S. NAVY WORK PACKAGETECHNICAL MANUALSThis handbook is for guidance only. Do not cite this document as a requirement.AMSC N/A AREA TMSSDISTRIBUTION STATEMENT A. Approved for public release; distribution

2、is unlimited.NOT MEASUREMENTSENSITIVEProvided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-MIL-HDBK-3001(AS)iiFOREWORD1. This military handbook is approved for use by the Department of the Navy and is available for use by allDepartments and Agencies of the D

3、epartment of Defense (DoD).2. This handbook provides non-regulatory guidance for the preparation of technical manuals that are requiredto operate and maintain the various types of equipment and weapon systems within the Department of theNavy. It is for guidance only and cannot be cited as a requirem

4、ent. If it is, the contractor does not have tocomply.3. This handbook expands and clarifies the requirements contained in MIL-STD-3001-1 through MIL-STD-3001-8, Preparation of Digital Technical Information for Multi-Output Presentation of Technical Manuals,and provides recommended writing style, com

5、prehensibility, format, and graphics requirements used by theU.S. Navy for the preparation of technical manuals to the work package concept.4. Beneficial comments (recommendations, additions, deletions) and any pertinent data which may be of usein improving this document should be addressed to: Comm

6、anding Officer, NAVAIRWARCENACDIV,Systems Requirements Department, ATTN: Code 4.1.11.1, Lakehurst, NJ 08733-5100 by using theStandardization Document Improvement Proposal (DD Form 1426) appearing at the end of this handbook orby letter.Provided by IHSNot for ResaleNo reproduction or networking permi

7、tted without license from IHS-,-MIL-HDBK-3001(AS)CONTENTSPARAGRAPH PAGEiiiFOREWORDii1. SCOPE .11.1 Scope11.2 Applicability.12. APPLICABLE DOCUMENTS .12.1 General .12.2 Government documents 12.2.1 Specifications, standards, and handbooks 12.2.2 Other Government documents and publications 22.3 Non-Gov

8、ernment publications.32.4 Order of precedence .43. DEFINITIONS43.1 Acronyms used in this handbook.43.2 Definitions of selected terms53.2.1 Adjust53.2.2 Alert.53.2.3 Align53.2.4 American National Standards Institute (ANSI)53.2.5 Assembly.53.2.6 Block diagram.53.2.7 Built-in Test Equipment (BITE).63.2

9、.8 Calibrate63.2.9 Callout.63.2.10 CALS (Continuous Acquisition Life-cycle Support) raster.63.2.11 Caution63.2.12 Commercial and Government Entity (CAGE) Code.63.2.13 Comprehensibility.63.2.14 Computer Graphics Metafile (CGM) .63.2.15 Continuous Acquisition Life-cycle Support (CALS).63.2.16 Continuo

10、us tone photographs or drawings.63.2.17 Department of Defense (DoD)63.2.18 Department of Defense Index of Specifications and Standards (DoDISS)63.2.19 Depot-level maintenance.63.2.20 Digital graphics forms 73.2.21 Direct image copy (DIC).73.2.22 Disassemble 73.2.23 Document Type Definition (DTD) .73

11、.2.24 Electronic Display System (EDS).73.2.25 Electronic Technical Manual (ETM)73.2.26 Footer 73.2.27 Formatting Output Specification Instance (FOSI) .73.2.28 Frame-based Interactive Electronic Technical Manual (IETM).73.2.29 Functional diagram .73.2.30 Graphic(s) .7Provided by IHSNot for ResaleNo r

12、eproduction or networking permitted without license from IHS-,-MIL-HDBK-3001(AS)CONTENTSPARAGRAPH PAGEiv3.2.31 Halftones .73.2.32 Header .83.2.33 Horizontal (Landscape) TM format .83.2.34 Hotspot83.2.35 Icon83.2.36 Illustration.83.2.37 Index numbers and letters.83.2.38 Initial Graphics Exchange Spec

13、ification (IGES)83.2.39 Inspect .83.2.40 Institute of Electrical and Electronics Engineers (IEEE)83.2.41 Interactive Electronic Technical Manual (IETM).83.2.42 Landscape mode83.2.43 Legend.83.2.44 Logic text 83.2.45 Logistics Management Information (LMI).93.2.46 Logistics Support Analysis (LSA) .93.

14、2.47 Lubricant .93.2.48 Maintenance level .93.2.49 Maintenance step 93.2.50 Marginal copy.93.2.51 National Stock Number (NSN).93.2.52 Next Higher Assembly (NHA) .93.2.53 Nomenclature93.2.54 Note.93.2.55 Orphan 93.2.56 Overhaul93.2.57 Part number (P/N).93.2.58 Phantom 93.2.59 Pictorial.103.2.60 Pre-s

15、creening.103.2.61 Preventive maintenance (scheduled maintenance)103.2.62 Readability103.2.63 Reference designator.103.2.64 Remove/install 103.2.65 Repair103.2.66 Repair part 103.2.67 Replace103.2.68 Requiring activity103.2.69 Revision 103.2.70 Schematic diagram103.2.71 Scrollable 113.2.72 Sentence 1

16、13.2.73 Service.113.2.74 Source, maintenance, and recoverability (SMmost often a CRT or a liquid-crystal device.3.2.25 Electronic Technical Manual (ETM). For the purpose of this handbook, an ETM is a technicalmanual normally prepared from a linear SGML document file and not a hierarchically-based da

17、tabase as anIETM. The ETM is also displayed on an EDS as a scrollable, linear structured document and may employa combination of an automated intelligent index, prompted dialog boxes, and content-driven logical“NEXT“ functions.3.2.26 Footer. One or more lines of text that appear at the bottom of eac

18、h page (also called feet and runningfeet).3.2.27 Formatting Output Specification Instance (FOSI). The FOSI interprets the style and formattingrequirements of the Output Specification (OS). The FOSI can include font, leading, hyphenationcharacteristics, etc.3.2.28 Frame-based Interactive Electronic T

19、echnical Manual (IETM). An IETM which has been designed tobe displayed frame by frame.3.2.29 Functional diagram. A type of illustration in which symbols are connected by lines to showrelationships among the symbols. The symbols may be rectangles or other shapes, standard electronicsymbols representi

20、ng components or functions, or pictorials representing equipment or components. Where appropriate, voltage readings are shown. The lines may represent procedures or processes, such assignal or logic flow, and physical items, such as wires. Functional diagram includes schematics, wiringand piping dia

21、grams, logic diagrams, flow charts, and block diagrams.3.2.30 Graphic(s). Any type of presentation or representation which gives a clear visual impression.3.2.31 Halftones. Halftones are the tonal values of gray and black created by lines or dots. A halftone is aconversion of a continuous tone print

22、.Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-MIL-HDBK-3001(AS)83.2.32 Header. One or more lines of standard text that appear at the top of each page (also called heads andrunning heads).3.2.33 Horizontal (Landscape) TM format. Positioning of techni

23、cal manual content so that the pagehorizontal (width) dimensions are greater than vertical (height) dimensions.3.2.34 Hotspot. An area of the display which acts as a hidden button. Touching the hotspot selectsdesignated information for display.3.2.35 Icon. Pictorial representation; visual image to g

24、ive immediate recognition of a hazard or to provideessential information.3.2.36 Illustration. A general term meaning graphic presentations of all types. Illustrations includepictorials, functional diagrams, and line graphs. This term is used instead of such terms as figure, graphic,drawing, diagram,

25、 and artwork.3.2.37 Index numbers and letters. A number or letter (on a figure or an illustration) usually attached to a lineor an arrow which points to an object on the illustration. This number or letter corresponds to the samenumber or letter in a legend or text that defines or identifies the obj

26、ect in the illustration.3.2.38 Initial Graphics Exchange Specification (IGES). A standard digital form for vector graphicspreparation. Defined by MIL-PRF-28000.3.2.39 Inspect. To determine the serviceability of an item by comparing its physical, mechanical, and/orelectrical characteristics with esta

27、blished standards through examination (e.g., by sight, sound, or feel).3.2.40 Institute of Electrical and Electronics Engineers (IEEE). Membership organization that includesengineers, scientists and students in electronics and allied fields. Founded in 1963, it has over 300,000members and is involve

28、d with setting standards for computers and communications.3.2.41 Interactive Electronic Technical Manual (IETM). An IETM is a technical manual, prepared(authored) by a contractor and delivered to the Government or prepared by a Government activity, in digitalform on a suitable medium, by means of an

29、 automated authoring system; designed for electronic screendisplay to an end user; and possessing the following three characteristics: (1) The format and style of thepresented information are optimized for screen presentation to assure maximum comprehension; that is, theinformation presented is fram

30、e-oriented, not page-oriented; (2) The elements of technical informationconstituting the IETM are so interrelated that a users access to the information he/she requires is facilitatedto the greatest extent possible, and is achievable by a variety of paths; (3) The computer-controlled IETMelectronic

31、display system (EDS) can function interactively (as a result of user request and informationinput) in providing procedural guidance, navigational directions, and supplemental information; and also inproviding assistance in carrying out logistic support functions supplemental to maintenance.3.2.42 La

32、ndscape mode. To print an image sideways on the page so that the longest edge of the formcorresponds to the horizontal axis.3.2.43 Legend. A tabular listing and explanation of the numbers or symbols on a figure or an illustration.3.2.44 Logic text. Text that is composed of procedures and actions bra

33、nching to a series of questions,Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-MIL-HDBK-3001(AS)9resulting in a “yes“ or “no“ answer, leading to determination and resolution of a problem.3.2.45 Logistics Management Information (LMI). The selective app

34、lication of scientific and engineeringefforts undertaken during the acquisition process, as part of the systems engineering process, to assist inacquiring the required support; and providing the required support during the operational phase atminimum cost. Replaces Logistics Support Analysis (LSA).3

35、.2.46 Logistics Support Analysis (LSA). The selective application of scientific and engineering effortsundertaken during the acquisition process, as part of the systems engineering process, to assist in acquiringthe required support; and providing the required support during the operational phase at

36、 minimum cost.3.2.47 Lubricant. Any solid, fluid, or semifluid material that performs a lubricating or related specialtyfunction. Such materials include lubricating oils, greases, hydraulic fluids, damping fluids, dielectriccoolants, anti-seize compounds, corrosion preventatives, and bonded or unbon

37、ded solid films.3.2.48 Maintenance level. The separation of maintenance activities or functions in the U.S. Navy accordingto the required skills and available facilities.3.2.49 Maintenance step. A single maintenance action, such as setting a switch to the OFF position. Usually, a step has one action

38、, but in certain cases, there may be a series of identical actions, such asremoving seven bolts.3.2.50 Marginal copy. Copy (generally headers and footers) placed outside that portion of the page used foreither text, full page tabular data, or full page illustrations, but within the printing area dim

39、ensions of thepage.3.2.51 National Stock Number (NSN). A 13-digit number assigned to a repair part to be used forrequisitioning purposes.3.2.52 Next Higher Assembly (NHA). Assembly or subassembly of which subject component(s) orsubassembly are a subpart.3.2.53 Nomenclature. The approved name or alph

40、anumeric identifier assigned to an item, equipment, orcomponent in agreement with an organized designation system.3.2.54 Note. A statement or some other notification that adds, emphasizes, or clarifies essential informationof special importance or interest.3.2.55 Orphan. Last line of a paragraph pus

41、hed to a new page, stranded alone (orphaned) at the top of thepage without the rest of its paragraph.3.2.56 Overhaul. That maintenance effort (service/action) prescribed to restore an item to a completelyserviceable/operational condition as required by maintenance standards in appropriate technicalp

42、ublications.3.2.57 Part number (P/N). A primary number used to identify an item used by the manufacturer (individual,company, firm, corporation, or Government activity) that controls the design, characteristics, andproduction of the item by means of engineering drawings, specifications, and inspecti

43、on requirements.3.2.58 Phantom. Portraying an item (i.e., part, equipment, etc.) on an illustration with broken lines ratherProvided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-MIL-HDBK-3001(AS)10than solid lines to de-emphasize the item.3.2.59 Pictorial. A

44、 type of illustration showing the physical appearance of equipment or component parts. This term is used instead of such general terms as illustration, drawing, and diagram.3.2.60 Pre-screening. A process in which a clear material with a dot pattern or crossing opaque lines is usedthrough which an i

45、mage is photographed in making a halftone.3.2.61 Preventive maintenance (scheduled maintenance). The performance of scheduled inspections andmaintenance functions necessary to keep the equipment in serviceable condition and ready for its primarymission.3.2.62 Readability. Text comprehensibility meas

46、ured by such variables as number of syllables, words, andsentences.3.2.63 Reference designator. Letters or numbers, or both, used to identify and locate discreet units, portionsthereof, and basic parts of a specific equipment, assembly, or subassembly.3.2.64 Remove/install. To remove and install the

47、 same item when required to perform service or othermaintenance functions. Install may be the act of emplacing, seating, or fixing into position a spare, repairpart, or module (component or assembly) in a manner to allow the proper functioning of an equipment orsystem. 3.2.65 Repair. The application

48、 of maintenance services (inspect, test, service, adjust, align, calibrate, and/orreplace), including fault location/troubleshooting, removal/installation, and disassembly/assemblyprocedures, and maintenance actions to identify troubles and restore serviceability to an item by correctingspecific dam

49、age, fault, malfunction, or failure in a part, subassembly, module (component or assembly),end item, or system. Repair is authorized by the LSA/LMI and the assigned maintenance level is shown asthe fourth position code of the SM GFE; i.e.; 32,008; 19-inch; +25oF; left-hand.Thus a sentence like “The left-hand MLG door shouldnt open more than 25o.“ consists of 9 words.3.2.90 Work packages (WPs). Presentation of information functionally divided into