1 / 11

Common Engineering Documents

Common Engineering Documents. Inspection or trip reports Research, laboratory, and field reports Specifications Proposals Progress reports Instructions Recommendation and feasibility reports. Document Considerations. Don’t obsess over the names of reports.

tulia
Download Presentation

Common Engineering Documents

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Common Engineering Documents • Inspection or trip reports • Research, laboratory, and field reports • Specifications • Proposals • Progress reports • Instructions • Recommendation and feasibility • reports

  2. Document Considerations • Don’t obsess over the names of reports. • Find out your company’s requirements. • Think creatively about content and organization. • Address the needs of your audience. • Be careful with discussion of technical background. • Carefully craft with the report introduction. • Packaging: memo, letter, formal report. • Media: print, web site, social media website.

  3. Inspection and Trip Reports • Also known as site reports, accident reports, investigative reports. • Introduction • Background • Factual discussion • Actions taken • Interpretive, evaluative, or advisory discussion

  4. Research, Laboratory, and Field Reports • Introduction • Background • Literature review • Theory, method, procedure, and equipment • Observations, data, findings, and results • Conclusions • Implications and further research • Information sources

  5. Proposals • Types: solicited, unsolicited; external, internal • Components: • Introduction • Background: need, opportunity • Proposed project • Description of the project • Benefits, feasibility • Method, approach • Qualifications (proposer’s) • Schedule • Costs • Conclusion

  6. Progress Reports • Introduction • Project description • Progress summary • Time periods • Project tasks • Combinations • Problems encountered • Changes in requirements • Overall project assessment • Conclusion

  7. Instructions (Operating Procedures) • Content, style and format issues: • Task orientation • Writing style (imperatives, 2nd-person • Headings • Bulleted and numbered lists • Notices (note, caution, warning, danger) • Highlighting (bold, italics, color, other fonts) • Illustrations

  8. Special Notices • One system: • Note • Attention • Caution • Danger • Another system: • Note • Caution • Warning • Danger

  9. Recommendation & Related Reports • Recommendation reports • Evaluation reports • Feasibility reports • Proposals (often viewed as this category of report)

  10. Recommendation Report: Structure • Introduction • Background: problem, opportunity • Requirements • Technical background • Description of the options • Point-by-point comparisons • Summary table • Conclusions • Recommendation • Information sources

  11. Title • bullet

More Related