Please use this identifier to cite or link to this item:
https://hdl.handle.net/11681/2933Full metadata record
| DC Field | Value | Language |
|---|---|---|
| dc.contributor.author | Information Technology Laboratory (U.S.) | en_US |
| dc.date.accessioned | 2016-03-15T17:00:58Z | en_US |
| dc.date.available | 2016-03-15T17:00:58Z | en_US |
| dc.date.issued | 1993-01 | en_US |
| dc.identifier.govdoc | Instruction Report ITL-93-1 | en_US |
| dc.identifier.uri | http://hdl.handle.net/11681/2933 | en_US |
| dc.description | Instruction Report | en_US |
| dc.description.abstract | This Guide lists certain items that must be included in all WES reports, gives the locations of these and other major elements, and outlines the types of information to be included in some of these elements. The Guide also prescribes ways of handling certain questions concerning format and style that confront most authors. Grammar is discussed only briefly; instead, reference is made to commonly used textbooks for this type of information. References and a bibliography to this Guide are included at the end of the main text. A list showing the preferred spelling of difficult or uncommon words used in WES reports is included as Appendix A. A list of abbreviations commonly used at WES is included as Appendix B. Mathematical symbols and expressions are discussed in Appendix C. Format and physical characteristics of WES reports are described in detail in Appendix D. Appendixes E and F give guidance for the use of copyrighted material and multicolor illustrations, respectively. For the convenience of the user of this Guide, an index is included as Appendix G. | en_US |
| dc.description.tableofcontents | Contents Preface . . . . . I-Introduction ·. Why Waterways Experimen t Station Reports Are Written . . . . . . . . . . . . . . . . . . . . . . . . . . Factors Influenc ing Content and Format of WES Reports Ph ilosophy of Reports . . Wh at the Gu ide Contains Adopt ion of SI Un its . . . 2-Designatio n, Organization, and Content of WES Reports . Designation and Cover of WES Reports Components of Reports . Cover . . . . . . . . . . . Front cover (outside) Front cover (inside) . Back cover (inside) . Back cover (ou tside) Title Page . . Preliminaries . . . . . Order . . . . . . . What they contain Ma in Text . . . . . . . Introduct ion . . . Description of study . Anal ysis . . . . . . . . Conclusions and recom mendation s References to Source Material Il lustrations and Tables Illustration s . Tables . Append ixes Notation Index . . . . • •• Vlll l 2 2 3 3 4 4 5 6 6 II II 12 1 2 14 14 14 18 18 19 19 19 20 21 21 21 21 22 22 Ill Distributi on List . . . . . . . . . . . . . . . . . Report Docu mentation Page, Stand ard Form 298 . 3-Format and Style . . . . . . . . . . . . . Format for Preliminaries and Main Text Page numbering . . . . . . . . Paragraph numbering . . . . . . .. 23 • .. 24 .. 27 • 27 27 . . . . 27 Headings . . . • Illustrations . . . . . . . . . . Tables . . . . . . . . . . . . . . . ... . . . . . . . 28 .. 28 • 3 1 Computer program documentation . . Entries in references and/or bibliog raphy Format for Appendixes Format for Notation . • • 31 33 36 37 Sty le . . . . . . . • 38 Spelling . . . 38 Capitalization Punctuation . • 38 Abbreviations and symbols Nu merals . . . . . . . . . . Mathematical expressions . . . . 39 40 . . . . . • • • • 4 1 4-Report Preparation, Processing, and Distribut ion . .. . 42 Planning . . . . . Prelim inary Draft .. .. 43 • • 43 Author . . . . Techn ical organ ization review VPC processing . . . . . . Author's check of ed it ing . • . . Final Draft . . . . . . . . . • . .. . . . . . . .. 43 43 . . . . . 46 . . 46 46 VPC . . . . . . . . . . Techn ical organ ization Sponsoring office . . . Final approval . . . . . • • 46 46 . . . . 46 47 Final corrections and reproduction Distribution . . . . . Primary . . . . . . . . . • • • 47 . 47 • 47 Secondary . . . . . . . . . . . . • 48 Exceptions . . . . . • . . . • • . . . 48 Miscellaneous Papers and Instruct ion Reports for l im ited dist ribu tion . . . . . . . . . . . . . . . . . . . 48 Contract Reports . . . . . . . . . . . . . . . . . . 48 Reports prepared by WES but prin ted elsewhere . . 49 Reports prepared for record purposes only . . . . . . . • 50 Papers prepared for professional societ ies and/or jou rna ls 50 Theses and dissertation s . . . . . . . . . . . . . . . . . . . . 50 . IV 5-W ri t ing. Edit ing. and Layout Writ ing . . . . . . . . . Approach to writing Duty of writer . . . Choice of words Sen tences . . . . . Paragraph s . . . Editi ng . . . . . . . . 5 1 5 1 . . 5 1 52 . . . . . . . . . . 53 . . . . . . . . 54 . . . . . . . . . . 55 . . . . . . . . 55 Author-edi tor relation . . . . Fu nct ions of VPC editors . . . . Fu nct ions of VPC proof readers Checkl ist for Authors and Editors Layou r . . . . . . . 6-Common Errors . . Voice . . . . . . . Use of Weak Verbs . . Nomenc lature Inconsistency Imprecision in Use of Terms Use of Pronou ns . Collect ive Nou ns . . . . . . . .. . . . . . . 56 57 57 58 60 . . 6 1 . . . . 6 1 62 62 63 . . . 63 64 Tense . . . . . . . . . . . . . . Dangl ing M od ifiers . . . . . . . . . . . . . . . . Restrict ive and N onrestricti ve Phrases and Clauses Correct Use of Notations Involving Powe rs of Ten Use of Text to Amplify , Discuss, and Explai n Tables and Il l ustrations . . . . . . . . . . . . . . . . . . . . . 64 . . . . 64 65 66 67 Referen ces . . . . . . . . . . . . . . . . . . . 69 Bibliography . . . . . . . . 7 1 Append ix A: Word List Append ix B: Abbrev iations Gu ide . • •• A l B l Append ix C: Greek Alphabet, and Mathematical Symbols and Expressions . . . . . . . . . . . . . Greek Alphabet . . . . . . . . . . . . . . . Marhemat ical Symbols and Expressions Append ix D: Copy Preparat ion . . . . . . . . Format . . . . . . . . . . . . . . . . . . . . Titles of Chapters and Other Major Parts . . . . Capt ions . . . . . . . . . . . Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . C l C l C2 . . • D I . . . D I . . . D I . . . . . . D I . . . . D6 v A ppend ix E: Use of Copyrighted Material . . • . • . • • • . • . .. . E l Append ix F: Mu lticolor Printi ng . . . . • • . • . • . • . . • . . • FI Append ix G: Index SF 298 . . . .. . . . . . ... • . • . • • . . . G I List of Figures Figu re I. Distribution statements . . ... . . .. . . 7 Figure 2. Figu re 3. Fig u re 4. Figure 5. Figure 6. Figure 7. Figure 8. Example cover of unclassi fied report . . Example cover of classi fied report . . Ex ample cover of contract or-prepared repo rt Sam ple title page . . . . . . . . . . . . . . Example of lists of figu res and r abies . . Example of a con version factors 1able • . . . Example of a key . . . . . . . . . . • . . . . • 8 9 10 13 15 • • • • • 16 • • • 17 Figure 9. Figure 10. Example of Report Docu mentat ion Page, SF 298 25 Example of a good photograph . . . . . . . . . . . . . . . 29 Figure 1 1. Figure 12. Figure 13. Example of a good l ine drawing . • . . . . . . Ex ample of a well-orga nized table . . . . . . . Ex ample of alternate table format designed for "talking tables" . . . . . . . . . . . . 30 32 32 Figure 14. Example of a notation . . . Figu re 15. Flowcha rt for WES reports Fig ure I6. Instruction s to VPC . . . . 37 • • • • 42 44 Fig u re C I . Display of single-line equ ations C7 Figure C2. Display of stacked right-hand n1cmbers . . C7 Figure C3. Display of stacked left-hand mem be rs . C8 Figure C4 Display of stacked r ight-hand and left-hand members . C9 Figure C5. Display of equat ions wi th bot h mem bers more than hal f a line. but less t han a fu ll line . . . . • . . . . . . C I 0 Figure D I . Sample of single-col umn format con tain ing a figure . D2 Figure 02. Sample of single-column format contai n ing tables of two different widths . . . . . . . . . . . . . . . . D3 Figure 03. Sample of two-colu mn format contai ni ng a figu re and a table each w i thin a single colu mn . . . . . . D4 Figure D4. Sample of a two-colu mn fonnat conta i n ing a table w ider than a sing le colun1n . . . . . . . . . . . . . D5 vi Figure 05. Example of table column heading and subheadings . . 08 Figu re 06. Figu re E I . Example of a lwo-page lable . . . . . . . . . Suggested format of request for perm ission to use copyrighted material . . . . . . . . . . . . . . . . 09 . . . . E2 Figure FI . Example of a just ificati on for mu lticolor pri nting . F3 | en_US |
| dc.format.extent | 127 pages/12.69 MBs | en_US |
| dc.format.medium | PDF/A | en_US |
| dc.language.iso | en_US | en_US |
| dc.publisher | U.S. Army Engineer Waterways Experiment Station | en_US |
| dc.relation | http://acwc.sdp.sirsi.net/client/en_US/search/asset/1024744 | en_US |
| dc.relation.ispartofseries | Instruction Report (Information Technology Laboratory (U.S.)) ; ITL-93-1 | en_US |
| dc.relation.replaces | Instruction Report ITL-86-1, October 1986 | en_US |
| dc.rights | Approved for public release; distribution is unlimited | en_US |
| dc.source | The ERDC Library created this digital resource from scans of the Print Resource | en_US |
| dc.subject | Editorial standards | en_US |
| dc.subject | Editing | en_US |
| dc.subject | Technical writing | en_US |
| dc.title | Guide for preparation of Waterways Experiment Station technical information reports | en_US |
| dc.type | Report | en_US |
| Appears in Collections: | Instruction Report | |
Files in This Item:
| File | Description | Size | Format | |
|---|---|---|---|---|
| IR-ITL-93-1.pdf | Instruction Report ITL-93-1 | 12.69 MB | Adobe PDF |  View/Open |