Web viewSOCIETY OF ALLIED. WEIGHT ENGINEERS, INC. RECOMMENDED. PRACTICE. Document No. SAWE DD RP X-#:YYYYr-ss. Aerospace • Marine • Offshore • Land Vehicle • Allied

SOCIETY OF ALLIEDWEIGHT ENGINEERS, INC.

R E C O M M E N D E DP R A C T I C E

Document No.SAWE DD RP X-#:YYYYr-ss

Aerospace • Marine • Offshore • Land Vehicle • Allied Industries

Executive DirectorP.O. Box 60024, Terminal Annex

Los Angeles, CA 90060

Date Issued 3 March 2016

Recommended PracticeExample & Formatting Guide

Revision Letter B

Prepared byStandards & Practices Committee

Society of Allied Weight Engineers, Inc.(SAWE, www.sawe.org)

© 2016, Society of Allied Weight Engineers, Inc

SAWE RECOMMENDED PRACTICE

SAWE Recommended Practice - Document No. SAWE DD RP X-#:YYYYr-ss

Change RecordThe revision letters shown here are only for approved revisions of the YYYY calendar year. The change record history for previous revision years should be referenced in the documents from those years.

Rev Date Description Entered by- 26 Aug 2009 Initial Issue D. TelletA 21 Apr 2015 Cover Page – revised to reflect the current by-

line, added “(SAWE, www.sawe.org)” and added cautions at the bottom of the page include copyright, export and other issues.Change Record Page – added notes to the authors of the RPTable of Content Page – added List of Figures and List of Tables.

A Schuster

B 3 Mar 2016 Complete Revision A. K. Matschinsky

iii

http://www.sawe.org/


ForewordThis document, authored by the SAWE Standards Review Board, should be used as a guideline to develop new SAWE Recommended Practices (RP). It should also be considered when revising existing RP’s.

This template replaces the document listed in the SAWE Operations Manual, § 5.2.5, Revision T.

Questions regarding this document may be made by e-mail to: [email protected].

Disclaimer

SAWE Recommended Practices and Standards are copyrighted by the Society of Allied Weight Engineers, (SAWE) Inc., P.O. Box 60024, Terminal Annex, Los Angeles, CA 90060 USA. All rights reserved. All SAWE technical reports, including standards applied and practices recommended, are advisory only. The use of this document by anyone engaged in industry or trade is entirely voluntary. There is no agreement to adhere to any SAWE standard or recommended practice, and no commitment to conform to or be guided by any technical report. Prospective users of the report are responsible for protecting themselves against liability for infringement of patents, import/export controls, etc. If this recommended practice is incorporated into a contract, it shall be binding to the extent specified in the contract.

iv

mailto:[email protected]


Table of Contents1 Scope........................................................................................................................................12 Purpose.....................................................................................................................................13 Associated Documents.............................................................................................................14 Definitions, Abbreviations, Acronyms.....................................................................................1

4.1 Definition of Terms.........................................................................................................14.2 Abbreviations and Acronyms..........................................................................................1

5 General Requirements..............................................................................................................25.1 File Format......................................................................................................................25.2 Document Number and File Naming..............................................................................25.3 Typical Sections..............................................................................................................35.4 Page Layout.....................................................................................................................45.5 Section Numbering..........................................................................................................45.6 Lists.................................................................................................................................45.7 Section and Text Formatting...........................................................................................4

5.7.1 Third-Level Section Heading Example..................................................................65.7.1.1 Fourth-Level Section Heading Example............................................................6

5.8 Table of Contents, List of Figures, and List of Tables....................................................65.9 Tables, Figures, and Equations........................................................................................65.10 Page Headers & Footers..................................................................................................85.11 Page Numbering..............................................................................................................85.12 Citations...........................................................................................................................85.13 Revisions.........................................................................................................................85.14 Macros.............................................................................................................................85.15 Document Properties.......................................................................................................9

6 References..............................................................................................................................10

Appendix A. Example Appendix Header.................................................................................A-1A.1 Caption Templates for Appendices.............................................................................A-1A.2 Page Numbers.............................................................................................................A-1A.3 Second-Level Appendix Header Example..................................................................A-2

A.3.1 Third-Level Appendix Header Example............................................................A-2A.3.1.1 Fourth-Level Appendix Header Example......................................................A-2

Appendix B. Example Appendix Header.................................................................................B-1

Index....................................................................................................................................INDEX-1

v


List of FiguresFigure 5-1. Example of Caption for Figures....................................................................................7Figure 6-1. Sample References......................................................................................................10Figure A-1. Example Figure Caption in Appendix.....................................................................A-1

List of TablesTable 4-1. Abbreviations and Acronyms.........................................................................................1Table 5-1. Document Naming Scheme............................................................................................2Table 5-2. Typical Sections in RP Documents................................................................................3Table 5-3. Document Font and Paragraph Styles............................................................................5Table 5-4. Table of Contents Paragraph Styles...............................................................................6Table 5-5. Example of Caption for Tables and Justification of Table Entries................................7Table 5-6. Page Numbering.............................................................................................................8Table 5-7. Document Properties......................................................................................................9Table A-1. Example Table Caption in Appendix........................................................................A-1

vi


1 ScopeThis document applies to all SAWE Recommended Practices. New documents shall comply with the requirements stated here. Older documents shall be converted to this formatting, to the extent possible as noted herein.

2 PurposeThis document is provided as both a template for new documents, and to give instruction to users regarding the document's required formatting.

3 Associated DocumentsThis recommended practice shall be used in conjunction with the following publication. When the following specifications are superseded by an approved revision, the revision shall apply.

SAWE Operations Manual, Rev. TSAWE TO-1 Overview of Mass Properties Engineering for Vehicle Systems,

2010SAWE TO-2 SAWE Procedures as an Accredited Standards Developer with

the American National Standards Institute, Rev. B

4 Definitions, Abbreviations, Acronyms

4.1 Definition of TermsThis section shall only include items used in the document, and shall be listed in alphabetical order. An example is included below.

The terms used in this recommended practice are defined as follows.

Recommended Practice

A document that communicates proven industry practices.

Styles / Paragraph Styles

A feature of MS Office Word® used to establish margins, fonts, line spacing, and indentations.

4.2 Abbreviations and AcronymsThis section shall only include items used in the document, and shall be listed in alphabetical order. An example listing is included in Table 4-1.

Table 4-1. Abbreviations and Acronyms

Symbol Descriptionin. incheskg kilogramLBP Length Between PerpendicularsLCG Longitudinal Center of Gravity

1


Symbol Descriptionmm millimetersMS Microsoft®

GM Metacentric Heightlb poundsRP Recommended Practice§ Section (Paragraph)SRB Standards Review BoardTO Technical OverviewTCG Transverse Center of GravityVCG Vertical Center of Gravity

5 General Requirements

5.1 File FormatAll documents shall be generated using MS Office Word®. Document shall be saved in the MS Office Word 2007 format (.docx).

5.2 Document Number and File NamingThe numbering scheme for Recommended Practice documents is summarized below. For complete details of document and file naming, refer to SAWE TO-2 § 3.14 (pending release in 2016 - e-mail [email protected] for details). Official document numbers shall be assigned by the Standards and Practices committee.

Document names shall be in the format of:

SAWE_DD_RP_X-#:YYYYr-ss

where _ (underscore) indicates a space, and the remaining components are defined in Table 5-2.

Table 5-2. Document Naming Scheme

Doc. Name Code Description

SAWE (2) Name of the organization that published the document (SAWE)DD (1) Draft Document Code; not used in the final approved and copyrighted version

of the document

WD Working DraftCD Committee DraftPD Public DraftFD Final DraftNone published document

RP (2) Type of Document (RP = Recommended Practice)

2

mailto:[email protected]


Doc. Name Code Description

X Applicable Industry Code

A Aerospace - military, commercial and general aircraft, missiles, spacecraft

C Cross Industry – either technical or management that can be used by any industry

G Ground – military and commercial vehicles such as cars, tanks, trucks, tractors,

M Marine – naval ships, merchant ships, workboats, pleasure craft, submersibles

O Offshore – Oil & Gas, aquaculture, energy harvesting, etc

# Indicates the document numbered prepared by the industryRefer to SAWE TO-1, “Overview of Mass Properties Engineering for Vehicle Systems”, § 6.4

YYYY Approval date and copyright yearr Revision letter

Not utilized for baseline issues, then letters a, b, c, d, etc. for each approved revision for the YYYY calendar year of approval

ss (1) Version of the draft revision of the document, in two-digit numerical format (e.g., 01, 02, 03)Typically used by SAWE internal committees

Notes:(1) Not used for final approved, published, and copyright version of the document(2) Fixed values for all Recommended Practice documents

5.3 Typical SectionsAll Recommended Practice documents shall include the following sections, as noted in the table below. Grandfathered documents may be excluded from these requirements due to contractual issues of section numbering.

Table 5-3. Typical Sections in RP Documents

Section NotesCover Sheet Details on the cover sheet will be defined and set by the

SRB and shall not be revised by the user.Change Record Include only brief descriptions of substantive changes

to the document.Foreword (optional) An abstract summarizing the contents and usage of the

document; may also be used to recognize authors or sponsors, or to provide notes or clarifications.

Table of ContentsList of Figures (as needed)List of Tables (as needed)

Automated tables of content, figures, and tables shall be used. A maximum of four heading levels may be used.

3


Section NotesScope This section shall be used to state to whom, when, and

where the document applies.Purpose This section shall be used to state the purpose of the

document.Associated Documents List of all reference materials, cited or not.Definitions, Abbreviations, Acronyms

This section includes two subsections:- Definition of Terms- Abbreviations and AcronymsThese sections shall only include items used in the document, and shall be listed in alphabetical order.

[Document Sections]References List of works cited within the RP.Appendices (as needed)Index (optional) An index at the end of the RP should only be used to

improve the usability of the RP.

5.4 Page LayoutAll documents shall be based on letter size paper (8½ x 11).

Margins shall be 1.25 in. on the sides, and 1 in. on the top and bottom.

Headers and footers shall be 0.5 in. from the top and bottom edges of each page, respectively.

Margins for front matter (all pages before Section 1) shall be 1.5 in. on the sides. Margins for the cover sheet shall be 0.5 in. top and bottom, and 1 in. for the remaining pages of the front matter.

5.5 Section NumberingLegal-style formatting shall be used to number all document sections. No more than four levels of sections shall be used. Grandfathered documents may be excluded from these requirements due to contractual issues.

5.6 Lists Lists may be ordered (alpha-numeric) or unordered (bulleted). Only one ordered list can be used per subsection to avoid confusing cross-references. Lists may be in outline form.

5.7 Section and Text FormattingParagraph Styles in MS Office Word® are used in the formatting of this document to provide uniformity and to allow for ease in generating the Table of Contents and Lists of Figures and Tables. Utilization of styles is a more robust method of applying sequential numbering throughout the document. See Table 5-4 for a listing of document fonts and paragraph styles defined and used.

4


Table 5-4. Document Font and Paragraph Styles

Section Font Line Spacing(before/after)

StyleDetails (1) Style Name

Major (First-Level) Section Headings

Arial, 14 pt, bold 12 pt / 6 pt Hanging Indent & Tab

0.3 in.

Heading 1

Second-Level Section Headings

Arial, 12 pt, bold, italicized

12 pt / 6 pt Hanging Indent & Tab

0.5 in.

Heading 2

Third-Level Section Headings

Arial, 11 pt, bold, underlined


0.63 in.

Heading 3

Fourth-Level Section Headings (if needed, but not encouraged)


0.88 in.

Heading 4

Body Text within Sections

Times New Roman, 11 pt

6 pt / - Body Text

Caption Figure Times New Roman, 11 pt, bold

6 pt / 6 pt Center Justified

Captions

Caption Table Times New Roman, 11 pt, bold

6 pt / 6 pt Center Justified

Captions

Appendix Major (First-Level) Section Headings


1.25 in.

Heading 6

AppendixSecond-Level Section Headings

Arial, 12 pt, bold, italicized


0.5 in.

Heading 7

AppendixThird-Level Section Headings

Arial, 11 pt, bold, underlined


0.63 in.

Heading 8

Fourth-Level Section Headings (if needed, but not encouraged)


0.88 in.

Heading 9

Other Major Headings(Change Record, Foreword, Table of Contents, List of Figures, List of Tables, Index)

Arial, 14 pt, bold 12 pt / 6 pt Justifications Varies

Headings

Notes:(1) Line and Page Breaks - Pagination properties, select "Keep with Next"

5


5.7.1 Third-Level Section Heading Example

5.7.1.1 Fourth-Level Section Heading Example

5.8 Table of Contents, List of Figures, and List of TablesThe Table of Contents for the main body of the document collects all headers using the styles "Heading 1" through "Heading 4". The Table of Contents for the appendices of document collects all headers using the styles "Heading 6" through "Heading 9".

The List of Figures collects all captions using the style "Caption Figure". The List of Tables collects all captions using the style "Caption Table".

These tables and lists will be automatically generated, and will include four levels of headings. The formatting of the text in these tables and lists are included in Table 5-5 for reference and apply to the table of contents, List of Figures, and List of Tables.

Table 5-5. Table of Contents Paragraph Styles

Section Line Spacing(before/after) Style Details (1) Style Name

Table of Contents Level 1

3 pt / - Indent 0 in.Hanging Indent 0.33 in.;

Tab 0.33 in.

TOC 1


3 pt / - Indent 0.17 in.; Hanging Indent 0.67 in.;

Tab 0.67 in.

TOC 2


- /- Indent 0.33 in.;Hanging Indent 1.0 in.;

Tab 1.0 in.

TOC 3


- / - Indent 0.5 in.;Hanging Indent 1.17 in.;

Tab 1.17 in.

TOC 4

Notes:(1) All fonts for the table of contents are Times New Roman, 11 pt.; right tab at 6 in.

with dotted leader.

5.9 Tables, Figures, and EquationsAll tables, figures, and equations shall be numbered sequentially, prefixed by the major section number or letter. All tables and figures shall include captions. Do not use the MS Word Captions feature, as it does not allow for separate numeration in the appendices; example captions are included in the following section, and should be used as a template. Grandfathered documents may be excluded from numbering requirements that would renumber the items, due to contractual issues.

Table captions shall appear above each table; the text shall be center justified, and bold font. The "Caption Table" style shall be used for all table captions. The header row of tables spanning

6


multiple pages shall be repeated at the top of each page. Notes included on tables shall be numbered. An example of a table with its caption are shown in Table 5-6.

All numerical table entries representing quantities shall be right justified, as this is critical in checking the magnitude of values. Table entries representing states, choices, reference numbers, etc., shall be centered justified. Line justification of other table entries, including table headings, are at the author's discretion.

Table 5-6. Example of Caption for Tables and Justification of Table Entries

Item (1) Weight (lb) CriticalityItem A 1.54 NoItem B 6.57 MaybeItem C 125.36 YesItem D -0.55 NoNotes:(1) This is an example of a table note.

Figure captions shall appear below each figure; the text shall be center justified and bold font. The "Caption Figure" style shall be used for these captions. Figures should be centered justified on the page, as appropriate. An example of a figure with caption follows.

Figure 5-1. Example of Caption for Figures

Equation numbers shall be shown to the right of each equation. An example of an equation and numbering are shown below.

e iπ+1=0 (5-1)

7


5.10 Page Headers & FootersThe SAWE header shall be shown on every page of the document, to include all pages of appendices. The document number is shown on the page header; the document number should be set on the second page of the front matter (page ii), and all subsequent MS Word section headers should be linked to it using the MS Word "Link to Previous" option.

A footer including the page number shall be shown on every page of the document, including the appendices, but excluding the cover page. Page numbers shall be in-line with footer text, and not inserted as a floating text box.

5.11 Page NumberingThe page numbering format for all Recommended Practice documents is described in the table below.

Table 5-7. Page Numbering

Section Starting Page Number FormatFront Matter (Cover Sheet, Change Record, Foreword, Table of Contents, Lists of Figures and Tables)

beginning with the cover sheet Lower-Case Roman Numerals (e.g., i, ii, iii)

Main Body beginning with Section 1 Arabic Numerals (e.g., 1, 2, 3)Appendices restarting at the beginning of

each appendixArabic Numerals w/ Prefix of Appendix Letter (e.g., A-1, A-2, A-3, B-1)

Index beginning with the first page of the appendix

Arabic Numerals w/ Prefix of "INDEX" (e.g., INDEX-1, INDEX-2)

5.12 CitationsCitations in the text shall be numbered in brackets (e.g., “… as proved by Jones [1].”) and listed in the References section at the end of the document (see § 6 herein).

5.13 RevisionsIn addition to noting changes in the Change Record table at the beginning of the document, all substantive changes to each revision shall be identified by a solid black vertical line on the left border of the text.

5.14 MacrosMacros shall not be used in the recommended practice document itself. Macros may be used in referenced MS Excel worksheets.

8


5.15 Document PropertiesAll Document Properties shall be purged, with the exception of the document properties noted in the table below. These values are set in this template and shall not be revised except by the SRB to tailor information specific to individual RP’s.

Table 5-8. Document Properties

Property ValueTitle (1)(2) [leave blank]Subject (1) Recommended PracticeAuthor (1) [Enter the name of the Consensus Body]

e.g., RP G-1 Consensus BodyManager [Enter the name of the Industry Committee sponsoring

the document]e.g., Ground Vehicles Industry Committee

Company Society of Allied Weight Engineers, Inc.Key Words (1) [Use a few key words at developer’s discretion]Comments Copyrighted by the

Society of Allied Weight Engineers (SAWE), Inc.P.O. Box 60024, Terminal AnnexLos Angeles, CA 90060www.SAWE.org

Notes:(1) Values may carry over in PDF conversion.(2) Titles are excluded from document properties due to length and inability

to format text and apply line breaks.

9


6 ReferencesAll cited references in the document shall be listed in numerical sequence and include only those references cited within the document text. (Refer to § 5.12 for citation instructions.)

An author's name shall be cited in the same form in which it appears on the title page of a book or article. If a book or article has two authors, only the first named author should be reversed as shown in the example reference [4] below. (e.g., Jones, A. B., John Doe and W.T. Door)

The name of the book or journal shall be italicized. Underlining is an acceptable substitute for Italics in the reference list. Titles of articles shall be included in quotation marks.

See Figure 6-2 below for examples of the correct style for listing references.

[1] Anonymous, Style Manual, Revised Edition. Washington, D.C., US Government Printing Office, 1945.

[2] Boyle, Richard, "USS X-1 Power Plant, 1956-57”, Naval Engineers Journal, Vol. 84 No. 2 (1972) pp. 42-50.

[3] Dudley, Darle W., Practical Gear Design, New York, NY, McGraw-Hill Book Company, Inc., 1954.

[4] Jordan, Richard D. and Marion J. Edwards, Aids to Technical Writing, Bulletin No. 21, Vol. 47, No. 24. Minneapolis, Minn., University of Minnesota Experimental Station, 1944.

[5] NAVSEA Technical Manual 0905-475-2010 Naval Distillate Fuel Conservation Program Handbook, Washington, D.C., Dept. of the Navy, February 1971.

[6] Shoemaker, W.B., Jr., "Nanosecond R-F Pulses for Waveguide Fault-finding," Thesis for M.S. degree in Electrical Engineering, US Naval Postgraduate School, Monterey, CA, September 1968.

Figure 6-2. Sample References

10


Appendix A. Example Appendix HeaderEach appendix shall include, as a minimum, a first-level heading as shown above. Appendix headers utilize styles "Heading 6" through "Heading 9".

A.1 Caption Templates for AppendicesAs appendix headers utilize different styles from the main body of the document, a separate set of captions must be used to refer to the numbering in the appendix headers. Examples of these are included below for use as templates.

e iπ+1=0 (A-2)

Table A-9. Example Table Caption in Appendix

Figure A-3. Example Figure Caption in Appendix

A.2 Page NumbersSection breaks should be used between each appendix and the page numbering sequence restarted.

1


A.3 Second-Level Appendix Header Example

A.3.1 Third-Level Appendix Header Example

A.3.1.1 Fourth-Level Appendix Header Example

2


Appendix B. Example Appendix Header

1


Index

INDEX-1