Society of Allied Weight Engineers, Inc

SOCIETY OF ALLIED
WEIGHT ENGINEERS, INC. / RECOMMENDED
PRACTICE
Document No.
SAWE DD RP X-#:YYYYr-ss
Aerospace • Marine • Offshore •
Land Vehicle • Allied Industries
Executive Director
P.O. Box 60024, Terminal Annex
Los Angeles, CA 90060 / Date Issued 3 March 2016
Recommended Practice
Example & Formatting Guide
Revision Letter / B

Prepared by

Standards & 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 Record

The 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. Tellet
A / 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 RP
Table of Content Page – added List of Figures and List of Tables. / A Schuster
B / 3 Mar 2016 / Complete Revision / A. K. Matschinsky

Foreword

This 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, RevisionT.

Questions regarding this document may be made by e-mail to: .

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.

Table of Contents

1 Scope 1

2 Purpose 1

3 Associated Documents 1

4 Definitions, Abbreviations, Acronyms 1

4.1 Definition of Terms 1

4.2 Abbreviations and Acronyms 1

5 General Requirements 2

5.1 File Format 2

5.2 Document Number and File Naming 2

5.3 Typical Sections 3

5.4 Page Layout 4

5.5 Section Numbering 4

5.6 Lists 4

5.7 Section and Text Formatting 4

5.7.1 Third-Level Section Heading Example 6

5.7.1.1 Fourth-Level Section Heading Example 6

5.8 Table of Contents, List of Figures, and List of Tables 6

5.9 Tables, Figures, and Equations 6

5.10 Page Headers & Footers 8

5.11 Page Numbering 8

5.12 Citations 8

5.13 Revisions 8

5.14 Macros 8

5.15 Document Properties 9

6 References 10

Appendix A. Example Appendix Header A-1

A.1 Caption Templates for Appendices A-1

A.2 Page Numbers A-1

A.3 Second-Level Appendix Header Example A-2

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

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

Appendix B. Example Appendix Header B-1

Index INDEX-1

List of Figures

Figure5-1. Example of Caption for Figures 7

Figure6-1. Sample References 10

FigureA-1. Example Figure Caption in Appendix A-1

List of Tables

Table41. Abbreviations and Acronyms 1

Table51. Document Naming Scheme 2

Table5-2. Typical Sections in RP Documents 3

Table5-3. Document Font and Paragraph Styles 5

Table5-4. Table of Contents Paragraph Styles 6

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

Table5-6. Page Numbering 8

Table5-7. Document Properties 9

TableA-1. Example Table Caption in Appendix A-1

v

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

1  Scope

This 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  Purpose

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

3  Associated Documents

This 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. T
SAWE TO-1 / Overview of Mass Properties Engineering for Vehicle Systems, 2010
SAWE 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 Terms

This 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 MSOfficeWord® used to establish margins, fonts, line spacing, and indentations.

4.2  Abbreviations and Acronyms

This section shall only include items used in the document, and shall be listed in alphabetical order. An example listing is included in Table41.

Table41. Abbreviations and Acronyms

Symbol / Description /
in. / inches
kg / kilogram
LBP / Length Between Perpendiculars
LCG / Longitudinal Center of Gravity
mm / millimeters
MS / Microsoft®
GM / Metacentric Height
lb / pounds
RP / Recommended Practice
§ / Section (Paragraph)
SRB / Standards Review Board
TO / Technical Overview
TCG / Transverse Center of Gravity
VCG / Vertical Center of Gravity

5  General Requirements

5.1  File Format

All documents shall be generated using MSOfficeWord®. Document shall be saved in the MSOfficeWord2007 format (.docx).

5.2  Document Number and File Naming

The 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 in2016 email 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 Table51.

Table51. 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 Draft
CD Committee Draft
PD Public Draft
FD Final Draft
None published document
RP (2) / Type of Document (RP = Recommended Practice)
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 industry
Refer to SAWETO-1, “Overview of Mass Properties Engineering for Vehicle Systems”, §6.4
YYYY / Approval date and copyright year
r / 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 Sections

All 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.

Table5-2. Typical Sections in RP Documents

Section / Notes /
Cover 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 Contents
List 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.
Scope / 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 Acronyms
These 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 Layout

All documents shall be based on letter size paper (8½ x 11).

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

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

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

5.5  Section Numbering

Legal-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 Formatting

Paragraph Styles in MSOfficeWord® 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 Table5-3 for a listing of document fonts and paragraph styles defined and used.

Table5-3. Document Font and Paragraph Styles

Section / Font / Line Spacing
(before/after) / Style
Details (1) / Style Name /
Major (First-Level)
Section Headings / Arial, 14pt, bold / 12pt / 6pt / Hanging Indent & Tab 0.3in. / Heading 1
Second-Level
Section Headings / Arial, 12pt, bold, italicized / 12pt / 6pt / Hanging Indent & Tab 0.5in. / Heading 2
Third-Level
Section Headings / Arial, 11pt, bold, underlined / 12pt / 6pt / Hanging Indent & Tab 0.63in. / Heading 3
Fourth-Level
Section Headings
(if needed, but not encouraged) / Arial, 11pt, bold / 12pt / 6pt / Hanging Indent & Tab 0.88in. / Heading 4
Body Text within Sections / Times New Roman, 11pt / 6pt / - / Body Text
Caption Figure / Times New Roman, 11pt, bold / 6pt / 6pt / Center Justified / Captions
Caption Table / Times New Roman, 11pt, bold / 6pt / 6pt / Center Justified / Captions
Appendix Major (First-Level)
Section Headings / Arial, 14pt, bold / 12pt / 6pt / Hanging Indent & Tab 1.25in. / Heading 6
Appendix
Second-Level
Section Headings / Arial, 12pt, bold, italicized / 12pt / 6pt / Hanging Indent & Tab 0.5in. / Heading 7
Appendix
Third-Level
Section Headings / Arial, 11pt, bold, underlined / 12pt / 6pt / Hanging Indent & Tab 0.63in. / Heading 8
Fourth-Level
Section Headings
(if needed, but not encouraged) / Arial, 11pt, bold / 12pt / 6pt / Hanging Indent & Tab 0.88in. / Heading 9
Other Major
Headings
(Change Record, Foreword, Table of Contents, List of Figures, List of Tables, Index) / Arial, 14pt, bold / 12pt / 6pt / Justifications Varies / Headings
Notes:
(1) Line and Page Breaks - Pagination properties, select "Keep with Next"

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 Tables

The 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 Table5-4 for reference and apply to the table of contents, List of Figures, and List of Tables.

Table5-4. Table of Contents Paragraph Styles

Section / Line Spacing
(before/after) / Style Details (1) / Style Name /
Table of Contents Level 1 / 3pt / - / Indent 0in.
Hanging Indent 0.33in.;
Tab 0.33in. / TOC 1
Table of Contents Level 2 / 3pt / - / Indent 0.17in.;
Hanging Indent 0.67in.;
Tab 0.67in. / TOC 2
Table of Contents Level 3 / - /- / Indent 0.33in.;
Hanging Indent 1.0in.;
Tab 1.0in. / TOC 3
Table of Contents Level 4 / - / - / Indent 0.5in.;
Hanging Indent 1.17in.;
Tab 1.17in. / TOC 4
Notes:
(1) All fonts for the table of contents are Times New Roman, 11pt.; right tab at 6in. with dotted leader.

5.9  Tables, Figures, and Equations

All 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.