ARMY MIL-HDBK-523-2011 GUIDE TO THE GENERAL STYLE AND FORMAT OF S1000D TECHNICAL MANUAL DATA MODULES.pdf

1、 NOT MEASUREMENT SENSITIVE MIL-HDBK-523 31 March 2011 DEPARTMENT OF DEFENSE HANDBOOK GUIDE TO THE GENERAL STYLE AND FORMAT OF S1000D TECHNICAL MANUAL DATA MODULES This handbook is for guidance only. Do not cite this document as a requirement. AMSC N/A AREA TMSS DISTRIBUTION STATEMENT A. Approved for

2、 public release; distribution is unlimited.Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 ii FOREWORD 1. This handbook is approved for use by all Departments and Agencies of the Department of Defense (DOD). 2. This handbook provides gui

3、dance and examples to be used with MIL-STD-3031 for the preparation of technical publications required to support the various types of equipment and weapon systems within the Department of the Army (DA). This handbook is for guidance only. This handbook cannot be cited as a requirement. If it is, th

4、e contractor does not have to comply. 3. This document supplements Army Departmental Manuals, Directives, and Military Standards, and provides basic and fundamental information on Extensible Markup Language (XML) as it applies to MIL-STD-3031. 4. The figures appearing within this handbook are fictit

5、ious and are used only as examples to illustrate format. If any conflict occurs between the text of the document and the figures in this document, the text applies. 5. The use of Courier font changes in this handbook represent XML elements, attributes, values, and examples, (for example, ). 6. Comme

6、nts, suggestions, or questions should be addressed to USAMC Logistics Support Activity, ATTN: AMXLS-AP, Redstone Arsenal, AL 35898-7466 or emailed to logsa.tmssconus.army.mil. Since contact information can change, you may want to verify the currency of this address information using the Acquisition

7、Streamlining and Standardization Information System (ASSIST) database at https:/assist.daps.dla.mil/. Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 CONTENTS Paragraph Page iii 1. SCOPE . 1 1.1 Scope. 1 1.2 Purpose. . 1 2. APPLICABLE DO

8、CUMENTS 2 2.1 General. . 2 2.2 Government documents. . 2 2.2.1 Specifications, standards, and handbooks. . 2 2.2.2 Other Government documents and publications. . 2 2.3 Non-Government publications. . 2 3. DEFINITIONS 4 4. GENERAL GUIDANCE 5 4.1 General. . 5 4.2 Data modules. . 5 4.2.1 Identification

9、and status section. 6 4.2.2 Content section. 15 4.2.3 Common constructs. 15 4.3 Warnings and cautions. . 21 4.4 Publication structure. 21 4.5 Table of Contents 24 4.6 Reuse. 24 4.6.1 Paragraph significant data. . 25 4.6.2 Quantity data. . 26 4.6.3 Reuse of Warnings and cautions. . 26 4.6.4 Technical

10、 information repository data modules. 27 4.6.5 Container data module. 27 4.7 Style sheets. 28 4.8 Graphics. . 29 4.8.1 Information Control Number (ICN). 30 4.8.2 Graphic formats. 31 4.8.3 Graphic types. 31 4.8.4 Engineering drawings. . 31 4.8.5 Diagrams. . 32 4.9 Business rules. 38 4.9.1 General. 38

11、 4.9.2 Constraints. 39 4.9.3 Sources of business rules. 39 4.9.4 Development of business rules. . 39 4.10 Schemas. . 40 4.10.1 Schema association. . 41 4.11 Information management. . 41 4.11.1 Data module lists. . 42 Provided by IHSNot for ResaleNo reproduction or networking permitted without licens

12、e from IHS-,-,-MIL-HDBK-523 CONTENTS Paragraph Page iv 4.12 Content matrices. 44 4.12.1 General. 44 4.12.2 Content selection table columns. . 45 4.12.3 Tailoring the content selection tables. 46 4.12.4 Multiple data modules. . 47 4.12.5 Multiple nested publication modules. 47 4.12.6 Project-specific

13、 publications. . 50 4.13 Display devices. 50 4.14 Compact Disk (CD) and Digital Video Disk (DVD) preparation. . 50 4.14.1 Compact Disk/Digital Video Disk (CD/DVD) label data. . 50 4.14.2 Publication Module Code (PMC). . 50 4.14.3 Compact Disk/Digital Video Disk (CD/DVD) set number. 51 4.14.4 Equipme

14、nt Media (EM) number, Initial Distribution Number (IDN), and Publication Identification Number (PIN). 51 4.14.5 Supersession data. 51 4.14.6 Copyright notice. 51 4.14.7 Distribution statement. . 51 4.14.8 Export control notice. . 52 4.14.9 Destruction notice. . 52 4.14.10 Protective markings. 52 4.1

15、4.11 Information not contained on Compact Disk/Digital Video Disk (CD/DVD) face. 52 4.15 Compact Disk/Digital Video Disk (CD/DVD) mailer data. . 52 4.15.1 Outside panel of Compact Disk/Digital Video Disk (CD/DVD) mailer. 52 4.15.2 Inside of mailer (left panel). . 53 4.15.3 Inside of mailer (right pa

16、nel). 53 4.16 Jewel case flyleaf data. . 54 5. DETAILED GUIDANCE . 55 5.1 Data module types. . 55 5.1.1 General. 55 5.1.2 Descriptive information. 56 5.1.3 Procedural information. . 58 5.1.4 Crew/operator information. 63 5.1.5 Fault information. 70 5.1.6 Checklist information. 74 5.1.7 Maintenance p

17、lanning information. . 76 5.1.8 Illustrated parts data information. 87 5.1.9 Publication module. . 92 5.1.10 Process information. 106 5.1.11 Business Rules EXchange (BREX). 108 5.1.12 Technical repository information. 117 5.1.13 Applicability. . 121 5.1.14 Container. . 122 5.2 Information sets. . 12

18、2 5.2.1 General. 122 Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 CONTENTS Paragraph Page v 5.2.2 Front matter. . 123 5.2.3 Rear matter. 126 5.2.4 General information, equipment description and theory of operation. 128 5.2.5 Operator

19、instructions. . 139 5.2.6 Troubleshooting procedures. 151 5.2.7 Maintenance instructions. 159 5.2.8 Parts information. . 201 5.2.9 Supporting information. . 208 5.2.10 Destruction of equipment to prevent enemy use. . 223 5.2.11 Battle Damage Assessment and Repair (BDAR). 225 5.3 Miscellaneous public

20、ation types. 226 5.4 Specialized content. 227 5.4.1 General. 227 5.4.2 National Stock Number (NSN) authoring. . 227 5.4.3 Index flags. . 228 5.4.4 Attribute keepWithNext. 229 5.4.5 Item characteristic. . 230 5.4.6 Preliminary requirements. 230 6. COMPREHENSIBILITY WITH READING GRADE LEVEL 236 6.1 Co

21、mprehensibility. 236 6.2 Sampling plan for inspection. . 236 6.2.1 Derivation of samples. . 236 6.2.2 Applicable tests. . 236 6.2.3 Extended local samples. . 236 6.2.4 Validation of readability. . 237 6.2.5 Critical scanning. . 237 6.2.6 Systematic sampling of Technical Manuals (TMs). 238 6.3 Readin

22、g grade level measures. 239 6.3.1 Counts for narrative text. . 239 6.3.2 Automatic counting equipment. . 240 6.3.3 Manual counting technique. . 240 6.4 Calculation of Reading Grade Level (RGL). 240 6.4.1 Overall Grade Level (OGL). 240 7. NOTES . 242 7.1 Intended use. . 242 7.2 Subject term (key word

23、) listing. . 242 APPENDIX A Information Sets Grouped by Data Module Type 243 A.1 SCOPE . 243 A.2 Information sets by data module type. . 243 Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 CONTENTS Figure Page vi FIGURE 1. Publication br

24、eakdown. 6 FIGURE 2. Data module identification and status section. . 7 FIGURE 3. Example of identification and status display. . 8 FIGURE 4. Functional Group Code (FGC)-to-Standard Numbering System (SNS) conversion. 10 FIGURE 5. Sample output of data module address. 12 FIGURE 6. Reason for update m

25、arkup. . 14 FIGURE 7. Sample output of data module status. . 15 FIGURE 8. Sample output of change marking. . 16 FIGURE 9. Sample output of simple and unordered random lists. . 18 FIGURE 10. Sample output of a definition list. 19 FIGURE 11. Sample output of a table. 20 FIGURE 12. Common information m

26、arkup. . 21 FIGURE 13. Alert examples. . 21 FIGURE 14. Familiar publication divisions. . 22 FIGURE 15. Example of body content structure. 23 FIGURE 16. Example of a chapter structure. 24 FIGURE 17. Designator symbol markup. 25 FIGURE 18. Sample output of paragraph significant data. . 26 FIGURE 19. S

27、ample output of a reused (page-based) warning. 27 FIGURE 20. Information Control Number (ICN) based on a Commercial and Government Entity (CAGE) code. . 30 FIGURE 21. Information Control Number (ICN) based on a model identification code. 31 FIGURE 22. Example of highway and point-to-point methods fo

28、r signal flow. . 35 FIGURE 23. Example of oval connectors to continue signals. . 36 FIGURE 24. Example of signal returns and breakoff symbols to continue signals single sheet diagram. 37 FIGURE 25. Example of boat symbols, block technique, pyramid method to continue signals-multisheet diagram. . 38

29、FIGURE 26. Publication process. 43 FIGURE 27. Content selection. . 43 FIGURE 28. Information sets. . 44 FIGURE 29. Content selection table example. 45 FIGURE 30. Partial sustainment maintenance manual content selection table. 47 FIGURE 31. Nested publication modules. 49 FIGURE 32. Example of CD mail

30、er outside front, spine, and back. . 54 FIGURE 33. Paragraphs cannot follow subparagraphs. 57 FIGURE 34. Sample output of theory of operation. 58 FIGURE 35. Preparation for storage or shipment markup. . 59 FIGURE 36. Sample output of preparation for storage or shipment. 62 FIGURE 37. Crew drill step

31、 markup. 64 FIGURE 38. Sample output of crewDrillStep. 69 FIGURE 39. Sample output of fault isolation. 74 Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 CONTENTS Figure Page vii FIGURE 40. Preventive Maintenance Checks and Services (PMC

32、S) markup. . 75 FIGURE 41. Sample Preventive Maintenance Checks and Services (PMCS) output. 76 FIGURE 42. Maintenance allocation overview. 77 FIGURE 43. Tools list overview. 78 FIGURE 44. Remarks list overview. . 78 FIGURE 45. Maintenance Allocation Chart (MAC) markup. . 79 FIGURE 46. Sample output

33、for Maintenance Allocation Chart (MAC). 86 FIGURE 47. Illustrated Parts Data (IPD) quick view. . 88 FIGURE 48. Item sequence number optional children. . 89 FIGURE 49. Generic part data markup. 90 FIGURE 50. Illustrated Parts Data (IPD) markup. 91 FIGURE 51. Sample output of a parts list. 92 FIGURE 5

34、2. Publication module identification and status section. 94 FIGURE 53. Main (parent) publication module code. 95 FIGURE 54. Nested publication module code. . 96 FIGURE 55. Multiple equipment identifiers. 97 FIGURE 56. Publication module entry examples. . 98 FIGURE 57. Parent publication module ident

35、ification and status section markup. 99 FIGURE 58. Parent publication module content markup. . 100 FIGURE 59. Sample output of a publication module cover page. 106 FIGURE 60. How a layered Business Rules EXchange (BREX) works. 109 FIGURE 61. Standard Numbering System (SNS) example. . 111 FIGURE 62.

36、Technical information repository (controls and indicators) markup. . 119 FIGURE 63. Sample output of the controls and indicators technical information repository. 120 FIGURE 64. Sample output of population via implicit referencing. . 121 FIGURE 65. Assembly of Interactive Electronic Technical Public

37、ation (IETP) introductory screens. 126 FIGURE 66. Sample output of the authentication block. 128 FIGURE 67. Generic fault isolation procedure flow. 157 FIGURE 68. Sample output of generic fault isolation procedure. . 159 FIGURE 69. Sample output of checking unpacked equipment. 201 FIGURE 70. Sample

38、output of Components Of End Item (COEI), method A. 215 FIGURE 71. Basic Issue Items (BII) (Method A) markup example. 217 FIGURE 72. Sample output of Basic Issue Items (BII), method A. 222 FIGURE 73. National Stock Number (NSN) breakdown. . 228 FIGURE 74. Example output of index flag. 229 FIGURE 75.

39、Sample output of preliminary requirements. 235 Provided by IHSNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 CONTENTS Table Page viii TABLE I. Data module code breakdown. . 9 TABLE II. Common constructs. 15 TABLE III. Generated symbols. 28 TABLE IV. S

40、chema and Extensible Markup Language (XML) references. . 40 TABLE V. Data module types supporting Army requirements. . 55 TABLE VI. Data module types not required for use in Army technical publications. 56 TABLE VII. Additional data module types and schema fragments. . 56 TABLE VIII. Standard Number

41、ing System (SNS) rules and data module code attributes. 110 TABLE IX. Front matter, content requirements. . 123 TABLE X. Rear matter, content requirements. . 126 TABLE XI. General information, equipment description and theory of operation, content requirements. . 129 TABLE XII. Operator instructions

42、, content requirements. 139 TABLE XIII. Troubleshooting procedures, content requirements. . 152 TABLE XIV. Maintenance instructions, content requirements. 160 TABLE XV. Parts information, content requirements. . 202 TABLE XVI. Catalog Sequence Number (CSN). . 205 TABLE XVII. Supporting information,

43、content requirement. 208 TABLE XVIII. Destruction information, content requirements. . 223 TABLE XIX. Battle Damage and Repair (BDAR) information, content requirements. . 225 TABLE XX. Determining basic number of samples . 238 TABLE XXI. Sample computations to demonstrate use of formulas. 240 Table

44、A-I. Data module complexity. . 243 Table A-II. Procedural information sets. . 243 Table A-III. Descriptive information sets. . 245 Table A-IV. Fault information sets. . 247 Table A-V. Crew information sets. 247 Table A-VI. Technical repository, process, checklist, Illustrated Parts Data (IPD), howev

45、er, other content-specific internal references are also allowed. These other reference types include, but are not limited to: functional items (element ), circuit breakers (element ), controls or indicators (element ), zones, (element ), access points (element ), footnotes (element ). Provided by IH

46、SNot for ResaleNo reproduction or networking permitted without license from IHS-,-,-MIL-HDBK-523 17 Referencing is accomplished by the use of the attribute id and attribute internalRefId. The attribute id is located on the target, for example a step or figure, and the attribute internalRefId refers

47、to that target identification. Refer to S1000D for additional information on referencing. 4.2.3.2.1 Identification attribute values. When determining a value format for the attribute id, the use of a logical prefix is recommended. A prefix pattern for attribute values is necessary in order to ensure

48、 and maintain consistency throughout the publication. This can assist an author in locating the correct object to be referenced. Common practice, in accordance with S1000D, is the use of a value prefix followed by a hyphen and four digits (for example, “stp-0001“). This is instrumental in providing

49、a unique identifier. Value prefixes should provide enough information for the user to instantly identify a figure, table, paragraph, step, and so on. Several examples are suggested in S1000D, including, but not limited to: “fig,“ “tab,“ “par,“ and “stp.“ 4.2.3.2.2 Attribute referredFragment. The attribute referredFragment may be used when it is necessary to ref