Project Skills: Reporting

Engineering work is valuable only when it is clearly and accurately communicated.
In the Booming Bass project, your reports demonstrate how well you understand the underlying theory, how you apply it in design and measurement, and how you collaborate as an engineering team.
Good reporting is therefore not only about writing. It is about structured thinking, clear reasoning, and professional presentation.

Purpose of Reporting¶

Reporting serves three main goals:

1. Documentation – to record what you designed, tested, and learned.

2. Communication – to make your work understandable to others (tutors, peers, examiners).

3. Reflection – to show that you understand why things work (or don’t), and what you would do differently next time.

Your reports should allow any engineer familiar with the course to reproduce your results using only your documentation.

Report Types¶

Throughout the project, you will submit several written reports:

Each report contributes to your overall project grade. Intermediate reports receive feedback that helps you improve for the final submission.

Report Structure¶

All reports follow the same general structure.

1. Title Page

   • Project title, report type, team name, and submission date.

   • Names and student numbers of all contributors.

   • Tutor’s name and group number.

2. Summary (Abstract)

   • 100–200 words summarizing the main results, methods, and conclusions.

3. Introduction

   • Describe the context and objectives of the report.

   • Relate your subsystem to the complete Booming Bass project.

   • Explain the main design requirements.

4. Theory and Design

   • Present the relevant theory, design equations, and assumptions.

   • Include schematic diagrams, simulations, and component choices.

   • Reference all equations and figures properly.

5. Implementation and Measurements

   • Describe the practical setup, measurement procedure, and equipment used.

   • Include representative oscilloscope screenshots, data tables, and graphs.

   • Discuss experimental accuracy and deviations from simulation.

6. Discussion

   • Interpret your results and compare them to theoretical expectations.

   • Explain discrepancies and possible causes.

   • Reflect on design trade-offs and what could be improved.

7. Conclusion

   • Summarize the key findings in 3–5 concise bullet points.

   • Relate them to the learning goals of the project.

8. References

   • List all sources in IEEE style (consistently throughout) IEEE Style.

   • Cite books, datasheets, and lecture notes when applicable Citations.

9. Appendices (optional)

   • Include raw data, extended derivations, or detailed LTspice simulations.

   • Do not place essential information only in the appendix.

Writing Style and Layout¶

Follow the writing principles outlined in
📘 Writing for Readers with Little Time by R. Elling, H. Elling, and R. Grit.

Key recommendations:

• Write clearly and concisely, avoid unnecessary jargon.

• Use short paragraphs and informative headings.

• Explain your reasoning, not just your results.

• Ensure that every figure and table has a caption and is referenced in the text.

• Define all symbols and abbreviations.

• Maintain consistent units (SI).

• Use an appropriate font size (10–12 pt) and ensure legibility in printed form.

• Check grammar and spelling before submission.

For formatting:

• Use either Word or LaTeX (Overleaf) with a clean, professional layout. We strongly recommend to start using LaTeX now as you will definitely use it throughout your studies.

• All pages should be numbered.

• Figures and tables must be placed near their first mention in the text.

Plagiarism and Academic Integrity¶

TU Delft maintains a strict zero-tolerance policy on plagiarism.
Copying text, figures, or ideas from any source without proper citation will result in disciplinary action and may lead to a failing grade or exclusion from the course.

You may reuse materials from the lecture notes or datasheets only with correct attribution.
Every report is automatically screened for plagiarism via Turnitin upon submission to Brightspace.

Always:

• Cite your sources properly.

• Write in your own words.

• Reference any figure, schematic, or equation that you did not create yourself.

When in doubt, cite. It is always better to provide too much credit than too little.

Figures, Data, and Bibliography¶

• Include circuit diagrams created in LTspice or a professional drawing tool (not hand-drawn).

• Screenshots must be legible. Axis labels, scales, and signals must be readable.

• Tables should have clear column headers and units.

• The bibliography should include at least:

  • Component datasheets

  • Relevant textbooks

  • Lecture notes or slides

  • External sources used for design justification

Feedback and Revision¶

Each intermediate report will receive formative feedback from your tutor.
Use this feedback actively:

• Revise weak sections before the final report.

• Apply consistent formatting and structure across all reports.

• Reflect tutor comments in your final presentation and oral exam preparation.

Summary¶

Good engineering reports are not just a formality, they are proof of understanding. By documenting your process, explaining your reasoning, and presenting your findings clearly, you show that you can think and communicate like an engineer. Practicing these skills now will prepare you for professional work, where written reports are often the most visible and important part of your performance.