This is an old revision of the document!
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õte
Lühikokkuvõte (võõrkeeles)
Sisukord
Lähteülesanne
Nõuded ja piirangud süsteemile
Süsteemi üldine mudel
Süsteemi struktuuri ja funktsionaalsuse mudelid plokkdiagrammidena. Lisaks võib koostada kasutusjuhtude diagrammi, liideste diagrammi, jms.
Ideelahendused
Vähemalt kolm erinevat kontseptuaalset lahendust, kuidas antud ülesanne lahendada. Sobivad täiesti skaneeritud käsitsi visandatud skeemid, visandid jms. dokumentatsioon koos kommentaaridega.
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.
Elektroonika
Üldine plokkskeem, kus on näidatud kasutatavad moodulid (nn. kontroller, mootori ajur, mootor, enkooder jne., ning nendevahelised ühendused). Võimalusel standardne elektroonikaskeem ja trükiplaadi kujundus.
Juhtimine
Juhtimise algoritm ja algkood. Kui on kasutatud omaloodud funktsioone, siis ka funktsioonide ja parameetrite tabel, katkestuste prioriteetide tabel jms.
Valmislahendus
Kirjeldus ja pildid
Majanduskalkulatsioonid Komponentide nimekiri koos maksumusega, tööaja kalkulatsioonid jms.
Projektijuhtimine
Projekti ajakava, ressursside jaotus, tööjaotus, meeskonnaliikmete panus, koosolekute protokollid jms.
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 vajalikusest, 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 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).