Engineering Report General Guidelines

As further evidence of your evolving technical competency, all of the formal projects you will be assigned are to be submitted as additions to an evolving Word document called your Engineering Report. Since Engineers need to be able to communicate effectively, typically to an audience that is unfamiliar with many of the concepts, use this opportunity to develop your writing skills. Be sure you are familiar with the recommendations of this Technical Writing document. Here's Wikipedia's take on Technical Writing.

By each submission date, you will attach your updated ER.docx to an email to handin using the required Subject Line. Using potentially all of your word processing skills (fonts, styles, page margins and paragraph indents, headers, footers, page numbering, lists, tables, Equation Editor, etc.), your ER will contain,

  1. A cover page with the title (Engineering Report), the course name and code, your name, and the current date.
  2. The body font will be Times New Roman, 11pt.
  3. A Table of Contents, FRESHLY-UPDATED with each new submission.
  4. Project writeups that typically include the following subheadings (Purpose, Reference, Theory, Procedure, Media, and Conclusion). Do NOT place a colon at the end of each subheading.
  5. A right-aligned Parts Table will appear in the Procedure section, with center-center cell alignment and alternate background shading. This style is to be used throughout ALL of your Project summaries.
  6. Project titles in Heading 1 Style
  7. Project subheadings (Purpose, Reference, Procedure, Media, etc.) in Heading 3 Style
  8. All Project titles and subheadings are to remain left-aligned. Paragraph shape is left aligned, ragged right. Do NOT indent the first sentence of each paragraph.
  9. Use Fritzing to provide effective breadboard (half+) and schematic graphics.
  10. Consistency is the key. Photos, graphics, Fritzing breadboards and schematics WILL BE PRESIZED (Preview, Photoshop, Illustrator, Fireworks, Paint, etc.) to 3" wide BEFORE inserting into Word to remain under maximum 1MB limit in Grade 10. If your units of measure for pixel editing is pixels (px) instead of inches ("), define the width as 216 px (3*72 dpi)
  11. Tables, especially with 3 columns or less will ALSO adhere to the 3" width standard. Tables with many column can span the entire page width (6.5") and center-aligned within their own paragraph.
  12. The 3" graphics and tables described above WILL have square text-wrapping and right-aligned (without leakage into the right margin), just as the Fritzing image appears above.
  13. Where two complementary graphics (like the front and back views of a circuit board) are included, they should be sized to 3" wide as described above, but placed within a two-column, captioned, full-width, borderless table, with center and top cell alignment declared. See the example below of Justin Anderson's ER. The two high-quality photos with a 1px border on each are presented in a 2-row, 2-column borderless table. The first row contains a meaningful caption.
  14. Use of the correct symbol (eg. Ω) typically inserted from the Symbol Table, is expected at all times.
  15. ACES will open their own unlisted YouTube channel, take and upload videos of their working circuits and provide a link from the Media section of the Project writeup.

Finally, a commitment to developing your Word skills through your Engineering Report will pay dividends in other courses as the quality of your submissions will improve noticeably.

Analog Oscillator Seven Segment Display