This is an old revision of the document!


Report

In order to engineer a simple mechatronic device it is needed to project the construction and mechanics, electronics and sensors, control system and software for this device. At the end of the project a report should be compiled. It is a documentation that should at least consist following content points:

  • Title page
  • Summary
  • Summary (in foreign language)
  • Table of contents
    1. Terms of reference
    2. System requirements and restrictions
    3. The overall system model
      Structure and functionality of a system as block diagrams. In addition, instructions for use diagram, interface diagram etc. can be composed.
    4. Ideelahendused
      Vähemalt kolm erinevat kontseptuaalset lahendust, kuidas antud ülesanne lahendada. Sobivad täiesti skaneeritud käsitsi visandatud skeemid, visandid jms. documentation with comments.
    5. Mechanics
      Soovitatavalt 3D mudel koos oluliste sõlmede tööjooniste ja valmistamisjuhistega. Kui mingi sõlm nõuab erijuhiseid koostamiseks, siis ka koostejoonis ja juhendid, võimaluse korral animatsioon süsteemi toimimisest.
    6. Electronics
      General block diagram, where all the used modules are showed (the so called controller, motor actuator, motor, encoder etc. and their connections). Võimalusel standardne elektroonikaskeem ja trükkplaadi montaažiskeem.
    7. Control system
      Juhtimise algoritm ja algkood. Kui on kasutatud omaloodud funktsioone, siis ka funktsioonide ja parameetrite tabel, katkestuste prioriteetide tabel jms.
    8. Valmislahendus
      Description and pictures
    9. Majanduskalkulatsioonid
      The list of components with cost, time estimates and the like.
    10. Project management
      The project schedule, resource allocation, division of labor, the crew's contribution, the minutes of meetings and the like.
    11. Summary and conclusions
      What was difficult, what would you do differently, mida projekt andis jne. In the summary a short description of the work done, problems encountered and a description of the outcome are outlined. Samuti on kokkuvõttesse hea lisada oma arvamus projekti vajalikkusest, mida see annab projekti liikmele, mida teeks tulevikus teisiti, mida õpiti ja mida soovitatakse juhendajale ja projekti korraldajatele.
  • References
  • Annexes

The following example project is a measure of how to compile a documentation and a report on the project. Unfortunately, the report is in an abbreviated form due to the limited volume of this book, but it is aimed to show the different aspects of documentation.

en/projects/introduction.1267688219.txt.gz · Last modified: 2020/07/20 09:00 (external edit)
CC Attribution-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0