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ähemal järgmistest sisulistest punktidest:

Tiitelleht
Lühikokkuvõtte
Lühikokkuvõte (võõrkeeles)
Sisukord

1. Lähteülesanne
2. Nõuded ja piirangud süsteemile
3. Süsteemi üldine mudel (plokk diagrammidena)
4. Ideelahendused
   Vähemalt kolm erinevad kontseptuaalset lahendust, kuidas antud ülesanne lahendada. Sobivad täiest skaneeritud käsitsi visandatud skeemid, visandid, jms. dokumentatsioon koos kommentaaridega.
5. Mehaanika
   Soovitavalt 3D mudel koos oluliste sõlmede jooniste ja valmistamisjuhistega. Võimaluse korral animatsioon süsteemi toimimisest.
6. Elektroonika
   Üldine plokkskeem, kus on näidatud kasutatavad moodulid (nn. kontroller, mootori ajur, mootor, enkooder, jn., ning nende vahelised ühendused). Võimalusel standardne elektroonika skeem.
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.
    

Viited ja kasutatud materjal
Lisad

Järgnevalt on toodud kolm erinevat näiteprojekti, mis illustreerivad dokumentatsiooni koostamist ja on abiks oma projekti aruande koostamiseks. Tähele tuleks panna, et kõik kolm näidet kajastavad siiski ainult erinevaid aspekte ja ei ole täielikud kõigis punktides. Sõltuvalt seadmest võib dokumentatsioon sisaldada palju mehaanika jooniseid, tarkvara koodi jms. Terviklikku näidet ei ole paraku raamatu piiratud mahu tõttu võimalik tuua.

Näited on püütud valida piisavalt erinevad, et oleks võimalik näidata dokumenteerimise erinevaid aspekte. Kuigi dokumentatsiooni teatud osa on alati ühesugune (lähteülesanne, ideede genereerimine, lõppsõna, …) võib lahenduse raskuskese tihti üsna erinev olla (näiteks kolmandas näites on mehaanika osa minimaalne).