DOD-STD-1685 Base Document:1978

1 GENERAL, PURPOSE, OBJECTIVE AND APPLICATION
  1.1 General
  1.2 Purpose
  1.3 Objective
  1.4 Application
2 REFERENCED DOCUMENTS
3 DEFINITIONS
  3.1 ASL
  3.2 AWL
  3.3 Callout
  3.4 Clutter
  3.5 Comprehensibility
  3.6 Consolidation
  3.7 Function diagram
  3.8 Illustration
  3.9 Line graph
  3.10 Nomenclature (equipment)
  3.11 Paragraph
  3.12 Pictorial
  3.13 Procedure
  3.14 Readability
  3.15 Relevance
  3.16 Task (user)
  3.17 Technical contents sections of technical manual
  3.18 Text
  3.19 User
4 GENERAL REQUIREMENTS
  4.1 Support of user tasks
  4.2 Organization of the technical manual
  4.3 Consolidation of material
  4.4 Text
       4.4.1 Vocabulary
       4.4.2 Sentence structure and grammar
  4.5 Illustrations and tables
       4.5.1 Dependence on illustrations
       4.5.2 Nearness of illustrations and text
       4.5.3 Relevance of illustrations
       4.5.4 Illustrations per page
       4.5.5 Titles of illustrations and tables
5 DETAILED REQUIREMENTS
  5.1 Procedure and paragraph headings
       5.1.1 Procedure headings
       5.1.2 Paragraph headings
       5.1.3 Information headings
       5.1.4 Headings and relevance
       5.1.5 Heading length
       5.1.6 Headings per page
  5.2 Typography
       5.2.1 Typography in text
       5.2.2 Typography in illustrations
  5.3 Readability
       5.3.1 Average Word Length
       5.3.2 Average Sentence Length
       5.3.3 Maximum sentence and paragraph lengths in
             nonprocedural text
       5.3.4 Step length in procedures
  5.4 Procedures
       5.4.1 Form of procedures
       5.4.2 Introduction to procedures
       5.4.3 Lead-in
       5.4.4 Relevance of procedural text
       5.4.5 Consolidation and references
       5.4.6 Confirming events
       5.4.7 Logic tress and decision tables
  5.5 Nonprocedural text
       5.5.1 Topic sentence
       5.5.2 Separation of procedural and nonprocedural text
  5.6 Illustrations
       5.6.1 Function diagrams
       5.6.2 Wiring and piping diagrams
       5.6.3 Pictorials
       5.6.4 Line graphs
       5.6.5 Tables
FIGURES
1 Breakdown of presentation types covered by this standard
2 Example of dual-level presentation of procedure
3 Evaluation of clutter in a function diagram (schematic)
4 Example of use of pictorials to introduce nomenclature and
  example of locator view
5 Example of good callout placement and locator view
6 Example of clutter due to number callouts
7 General logic of technical manual sampling plan
APPENDIX A
10 GENERAL
   10.1 Application
   10.2 Purpose
20 REFERENCED DOCUMENTS
30 DEFINITIONS
40 GENERAL REQUIREMENTS
   40.1 Preferred verb usage
50 DETAILED REQUIREMENTS
APPENDIX B
10 GENERAL
   10.1 Application
   10.2 Purpose
20 REFERENCED DOCUMENTS
30 DEFINITIONS
   30.1 ASL
   30.2 AWL
   30.3 Ordinary word
   30.4 Sentence
   30.5 Word
40 GENERAL REQUIREMENTS
50 DETAILED REQUIREMENTS
   50.1 Preparation of text
   50.2 Counts
        50.2.1 Words
        50.2.2 Sentences
        50.2.3 Syllables
   50.3 Automatic counting equipment
   50.4 Calculation of ASL and AWL
   50.5 Long sentences
   50.6 Counting techniques
APPENDIX C
10 GENERAL
   10.1 Scope
   10.2 Need
   10.3 Rationale
20 REFERENCED DOCUMENTS
30 DEFINITIONS
   30.1 Manuscript
40 GENERAL REQUIREMENTS
   40.1 Derivation of samples
        40.1.1 Critical scanning
        40.1.2 Systematic sampling
   40.2 Applicable tests
   40.3 Extended local samples
50 DETAILED REQUIREMENTS
   50.1 Critical scanning
        50.1.1 Scanning criteria for procedures
        50.1.2 Scanning criteria for nonprocedural text
        50.1.3 Scanning criteria for illustrations
   50.2 Systematic sampling
        50.2.1 Identifying break pages
        50.2.2 Samples of procedural text
        50.2.3 Samples of nonprocedural text
        50.2.4 Samples of illustrations and tables
   50.3 Extended local samples
        50.3.1 Procedural text
        50.3.2 Nonprocedural text
        50.3.3 Illustrations and tables
   50.4 Special cases of sampling
        50.4.1 Short manuscripts
        50.4.2 Material already sampled
        50.4.3 Shortage of material

Gives style and format requirements to improve presentation of technical manuals.