Engineering report requirements

Engineering report requirements#

You will deliver an engineering report that documents your project.

Sections#

For the problem, solution and milestones, begin with your text from your proposal and refine it with more technical details.

  1. Problem

  2. Solution

  3. Existing solutions

    Less than one page. I recommend a structured table with:

    • solution & link to the project if available

    • relevance for your project

    • pros

    • cons

  4. Design & implementation

    • Diagrams, e.g., flowcharts

    • Explanations why certain design decisions were made

  5. Test & Demonstration

    • Pictures

    • Video link

  6. Discussion & conclusion

    • Did you solution meet your goals? Include your milestones on a table and show whether you met them or not.

    • What would you change if you had more time or other resources?

    • Lessons learned about programming, industrial automation, collaboration

Other requirements#

  • Student names and matriculation numbers are listed on the title page.

  • Deliver your code in a repository. The link must be on the title page.

  • Do not include large excerpts of code in your report. Prefer visual diagrams instead.

  • Include at least one diagram that visualizes how different parts of your project interplay.

  • See the writing as part of the learning process and write the text yourself. Use the LLM to get feedback on your writing.

  • Declare the use of generative AI