Dokumentatsioon

Lihtsa mehhatroonikaseadme koostamisel on vaja projekteerida seadme konstruktsioon ja mehaanika, elektroonika ja sensoorika ning juhtimine ja tarkvara. Projektide lõppemisel tuleks koostada töö aruanne - dokumentatsioon, mis peaks koosnema vähemalt järgmistest sisulistest punktidest:

• Tiitelleht
• Lühikokkuvõte
• Lühikokkuvõte (võõrkeeles)
• Sisukord
  1. Lähteülesanne
  2. Nõuded ja piirangud süsteemile
  3. Süsteemi üldine mudel
     Süsteemi struktuuri ja funktsionaalsuse mudelid plokkdiagrammidena. Lisaks võib koostada kasutusjuhtude diagrammi, liideste diagrammi jms.
  4. Ideelahendused
     Vähemalt kolm erinevat kontseptuaalset lahendust, kuidas antud ülesanne lahendada. Sobivad täiesti skaneeritud käsitsi visandatud skeemid, visandid jms. dokumentatsioon koos kommentaaridega.
  5. Mehaanika
     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. Elektroonika
     Üldine plokkskeem, kus on näidatud kasutatavad moodulid (nn. kontroller, mootori ajur, mootor, kooder jne., ning nendevahelised ühendused). Võimalusel standardne elektroonikaskeem ja trükkplaadi montaažiskeem.
  7. Juhtimine
     Juhtimise algoritm ja algkood. Kui on kasutatud omaloodud funktsioone, siis ka funktsioonide ja parameetrite tabel, katkestuste prioriteetide tabel jms.
  8. Valmislahendus
     Kirjeldus ja pildid
  9. Majanduskalkulatsioonid
     Komponentide nimekiri koos maksumusega, tööaja kalkulatsioonid jms.
  10. Projektijuhtimine
      Projekti ajakava, ressursside jaotus, tööjaotus, meeskonnaliikmete panus, koosolekute protokollid jms.
  11. Kokkuvõte ja järeldused
      Mis oli keeruline, mida teeks edaspidi teisiti, mida projekt andis jne. Kokkuvõttes kirjeldatakse lühidalt tehtud tööd, esinenud probleeme ja lõpptulemuse kirjeldust. 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.
• Viited ja kasutatud materjal
• Lisad

Järgnevalt on esitatud näiteprojekt, mis näitlikustab dokumentatsiooni koostamist ja on abiks oma projekti aruande koostamiseks. Aruanne on raamatu piiratud mahu tõttu paraku lühendatud kujul, kuid püütud on näidata dokumenteerimise erinevaid aspekte.