DDR_Formatting_and_Content_Guidelines.doc

Design Documentation Report

Document Content and Format

SECTION 1

GENERAL FORMAT GUIDELINES

1.1 GENERAL:

a. General. This guidance is intended as general guidance for developing a consistency in format style and contents.

b. Numbering and Lettering. For numbering and lettering of paragraphs, use the following system:

1 FIRST LINE [note use of all caps]

1. SECOND LINE (1.1, 1.2, 1.3…) [First paragraph, use all caps, with small caps ]

a. Third Line. [Underline heading]

(1) Fourth Line. [Underline heading]

(a) Fifth Line. [Underline heading]

i. Lowercase Roman numerals, hyphens, bullets or no

ii. characterization (judgement call on which) shall be used for

iii. lists, etcetera as long as consistency is maintained.

b. Font and Indents. Font is Times New Roman, 12 pt, spacing is exact 12 points and between paragraphs is 12 points. Paragraph is justified (equal margins both sides). Indents shall be 1/4" or 0.3". After the fifth line, don't indent any further but do use lowercase Roman numerals, hyphens, or bullets or no characterization for lists. None are bold, but third line headings, if used, onward are underlined. The first and second lines are always capitalized, with the second line using small caps.

c. Tables and Figures. All tables and figures shall be titled. Titles for tables and figures shall be numbered, center justified, with the title on top for tables and on the bottom for figures. Tables may or may not include borders as appropriate and shall be centered on the page. Avoid splitting tables onto multiple pages. Captions for figures shall be left justified.

d. Pagination. Page numbers shall be at the page bottom, center justified, begin with the section number followed by the page number. For example, "5-2", or "A-5" for page 5 of Appendix A. The table of contents shall be numbered using Roman numerals.

e. Drawings. Drawings shall be in accordance with the District CADD Standards and shall have the engineer and checkers initials in the title block. Drawings may be 11" x 17" fold outs. The use of color is acceptable if it clarifies the drawing intent.

f. Design Computations. Design computations and summaries of analysis results shall be presented in appendices. Design computations shall clearly present assumptions, criteria, and analysis method. All computations shall be initialed by the engineer and checker. Calculations should always include page numbers and should be preceded by a detailed table of contents.

g. Binding. Binding shall be in accordance with ER 1110-2-1150 and EP 310-1-6, Graphic Standards Manual. (ER 1110-2-1150: "Bindings for DDR's shall be of a type that facilitates removal of pages and substitutes of revised pages."). The District preference is for the "Acco" style bindings with a back strip. Slip-pages (or dividers) to separate the different sections of the document are acceptable. Colored slip-pages matching that of the document cover is best. Graphics on the slip-pages reflecting some aspect of the section to be presented are acceptable but not required. Tabbed dividers are not acceptable. EP 310-1-6 addresses the layout requirements of the cover, grid, COE logo, font sizes and location, etcetera.

h. References. References shall be provided at the back of each Section, or as an Appendix, at the discretion of the Technical Manager. References such as literature citations shall be provided at the back of the Section or compiled into a single list of references in the reference Appendix. Engineering references or other references used explicitly as design guidance; EM's, ETL's, Industry Codes, etcetera, shall remain within the Section as part of the paragraph(s) regarding design criteria and guidance, but may be repeated in reference Appendix if used.

i. Miscellaneous. Footnoting is not acceptable. Superscripting and subscripting is acceptable but must be at a reduced font size.

1.2 DESIGN DOCUMENTATION REPORT (DDR). (In Order of Appearance in document and as shown in the Table of Contents):

a. Product Completion Memo (do not list in Table of Contents)

b. Syllabus. The syllabus is an executive summary of the project including a brief background, project description, and construction cost and schedule.

c. Table of Contents. The table of contents shall include:

(1) all major paragraph titles and paragraph numbers (left justified) and page numbers (right justified),

(2) list of appendices (numbered alphabetically),

(3) lists of tables, figures, and plates.

d. Pertinent Data. A tabular summary of essential data on project construction cost, physical features, project purpose, and controlling elevations.

e. Prior and Planned Design Memorandums/Design Documentation Reports.

f. Acronyms and Abbreviations.

1.3. BODY OF THE DDR. The body of the document shall contain the following where applicable:

a. Purpose/Introduction. Typically "Section 1" of the document.

(1) Scope and Purpose. Short statement concerning the purpose and scope of work.

(2) Authorization. A statement concerning the authority for the work.

(2) Project Description. A short description of the project features being studied.

(4) Changes Since the Feasibility Report (or last Design Memorandum, etc.). Describe any differences in the features now being presented with the authorized plan and/or the plan in the feasibility report, and why these changes do not require a post-authorization change.

(5) Agency Coordination. A description of agency coordination and correspondence that has transpired during this study, and reference to the associated appendix. Copies of the correspondence shall be provided in the appendices.

(6) Metric Measurement. As required. If the project is developed using metric units of measure, a discussion shall be provided how the features are presented. This may include whether soft or hard conversions are provided, if new features are metric and existing features are inch-pound, if dual dimensioning is or is not used and why, etcetera. A table of metric conversions shall be provided in the appendices.

(7) Project Specific References. List of engineering studies, geotechnical exploration, hydraulic model studies, and other reports and documents developed specifically as a part of the preparation of this DDR. Not to be confused with the general references provided in the Appendices.

b. Background. As required. Typically "Section 2" of the document, if incorporated. May be a section on the general history and background which forms a historical perspective supporting the preparation of the project developed in the DDR.

c. Engineering Studies, Investigations and Design (as applicable). Sections that follow those listed above. They shall include results of investigations, analyses, and calculations. Each technical specialty shall include all criteria, load conditions, analysis methods, and assumptions, as required. These sections shall include but not be limited to the following:

(1) Biological Design/Considerations/Criteria

(2) Hydrology

(3) Hydraulic Design

(4) Structural Design

(5) Architectural Design

(6) Mechanical Design

(7) Electrical Design

(8) Civil and Landscape Design

(9) Geotechnical Design and Explorations

(10) Environmental and Cultural Resources

(11) Construction (Including Schedule)

(12) Operations and Maintenance

(13) Cost Estimates

(14) Economic Analysis

(15) Conclusions

(16) Recommendations

d. Appendices.

(1) Appendix A - List of Revisions. The process revising the DDR requires some form of tracking the revisions. The "List of Revisions" shall be the tool for documenting revisions to the DDR after it has been approved. Each revision, such as "Design Revisions Developed During Plans and Specifications" and the corresponding "Technical Review Documentation" are examples of potential revisions. Revisions documented in the List of Revisions shall include the title of the revision, date of the revision, and page numbers of the revision. The latest list of revisions shall be inserted into the appendix without removing previous lists, or shall be a list containing all previous revisions as well as the current revisions. Endorsements are not revisions and are to be inserted at the beginning of the DDR.

(2) Appendix B - References. See paragraph 1.1.h.

(3) Appendix C - Technical Review Documentation

(4) Appendix D - Agency Coordination

(5) Appendix E - Relocation Documentation Report for Navigation (If Applicable).

(6) Appendix F - Value Engineering Studies (If Applicable).

(7) Appendix G - Cost Estimate. Detailed backup in support of the cost estimate presented in the report.

(8) Appendix H - Table of Metric Conversions (As required).

(9) Appendix I and beyond - Whatever Else is Needed (i.e. Calculations, Biological Testing Program, Hydraulic Modeling, Value Engineering and Alternative Studies, Etcetera).

(10) Appendix X - (placeholder) Design Revisions Developed During Plans and Specifications.

(17) Appendix XX - (placeholder) Design Revisions Developed During Construction.

e. Plates.

1-2 C:\My Documents\Specs, Drawings and Guidance\GUIDANCE\Document Content and Format (DDR).doc

03/28/17, 3:27 PM