LEKCIJA 1: Elementi tehničke dokumentacije
Tehnička dokumentacija predstavlja skup dokumenata koji opisuju neki tehnički sistem, uređaj, proces ili projekat.
Tehnička dokumentacija predstavlja osnovni način prikazivanja i opisivanja jednog sistema, uređaja ili procesa. Njena uloga je da omogući jasno razumevanje kako sistem izgleda, kako funkcioniše i na koji način se koristi.
Šta je tehnička dokumentacija?
Tehnička dokumentacija je skup pisanih, grafičkih i elektronskih dokumenata koji služe za:
- opisivanje tehničkog sistema,
- planiranje izrade,
- izvođenje radova,
- održavanje sistema,
- kontrolu kvaliteta,
- evidentiranje promena.
Tehnička dokumentacija može biti izrađena u papirnom ili digitalnom obliku.
Drugim rečima: tehnička dokumentacija je skup grafičkih i tekstualnih prikaza koji opisuju jedan sistem. Ona ne služi samo za prikazivanje, već i za planiranje, izradu, održavanje i unapređenje sistema.
Elementi tehničke dokumentacije
Tehnička dokumentacija sastoji se od više elemenata koji zajedno čine celinu. Jedan od osnovnih elemenata jeste šema. Šema predstavlja grafički prikaz sistema u kojem su prikazani njegovi delovi i veze između njih. Ona je pojednostavljena i ne prikazuje stvarni izgled, već funkcionalne odnose između elemenata. Na primer, šema računarske mreže prikazuje kako su uređaji povezani, ali ne i njihov fizički raspored u prostoru.
Da bi šema bila razumljiva, koriste se simboli. Simboli su standardizovani grafički znakovi koji predstavljaju određene elemente sistema. Njihova upotreba omogućava jednostavnije i preglednije prikazivanje sistema. Bez simbola, svaka šema bi morala da sadrži detaljne crteže, što bi je činilo složenijom i teže čitljivom.
Međutim, sami simboli nisu dovoljni ukoliko nije jasno šta oni predstavljaju. Zato je važan element tehničke dokumentacije legenda.
Legenda je deo dokumentacije koji objašnjava značenje korišćenih simbola. Ona omogućava korisniku da pravilno tumači šemu. Legenda se obično nalazi u posebnom delu dokumenta i organizovana je kao lista simbola sa njihovim opisima.
Pored grafičkog prikaza, tehnička dokumentacija sadrži i tekstualni deo, koji se naziva tehnički opis.. Tehnički opis je tekstualni deo dokumenta koji objašnjava način rada sistema, njegove karakteristike i svrhu. On dopunjuje šemu i pruža dodatne informacije koje se ne mogu jasno prikazati grafički. Na primer, dok šema prikazuje kako su računari povezani u mrežu, tehnički opis može objasniti koja je uloga svakog uređaja i kako se odvija komunikacija između njih.
Još jedan važan element jeste specifikacija. Specifikacija predstavlja detaljnu listu komponenti sistema, zajedno sa njihovim karakteristikama. Ona može sadržati informacije kao što su naziv uređaja, model, tehničke osobine ili količina.
Svi ovi elementi zajedno omogućavaju potpuno razumevanje sistema. Tehnička dokumentacija treba da bude jasna, pregledna i prilagođena korisniku kome je namenjena. Previše detalja može otežati razumevanje, dok nedostatak informacija može dovesti do grešaka u primeni.
U kontekstu nastave i svakodnevnog života, tehnička dokumentacija se može prepoznati u mnogim situacijama. Uputstva za sklapanje nameštaja, šeme električnih instalacija ili planovi mreže u školi – sve su to primeri tehničke dokumentacije.
Tehnička dokumentacija najčešće sadrži:
1. Naslovnu stranu - Na naslovnoj strani se nalaze: naziv projekta, naziv organizacije, ime autora, datum izrade, oznaka dokumenta.
2. Sadržaj - Sadržaj omogućava lakše pronalaženje delova dokumentacije.
3. Tehnički opis - Tehnički opis detaljno objašnjava: namenu sistema, način rada, osnovne karakteristike, korišćene materijale ili tehnologije.
4. Grafički prilozi - Grafički deo može sadržati: skice, dijagrame, šeme, planove, tehničke crteže.
5. Proračuni - Proračuni prikazuju matematičke i tehničke analize koje potvrđuju ispravnost rešenja.
6. Specifikacije - Specifikacije definišu: dimenzije, materijale, komponente, tehničke karakteristike.
7. Uputstva - Uputstva služe za: montažu, korišćenje, održavanje, servisiranje sistema.
Vrste tehničke dokumentacije
U zavisnosti od oblasti rada, tehnička dokumentacija može biti: građevinska, mašinska, elektrotehnička, računarska, softverska, mrežna, ...
U oblasti informacionih tehnologija često se koriste:
- dijagrami toka,
- UML dijagrami,
- baze podataka,
- mrežne šeme,
- dokumentacija programskog koda.
Značaj tehničke dokumentacije
Dobra tehnička dokumentacija: smanjuje mogućnost grešaka, ubrzava realizaciju projekta, olakšava održavanje sistema, omogućava lakšu saradnju između timova, čuva informacije o projektu.
Primer
Prilikom izrade računarske mreže za školu tehnička dokumentacija može sadržati: plan prostorija, raspored računara, mrežnu šemu, spisak opreme, plan povezivanja uređaja, uputstvo za održavanje mreže.
Pitanja za proveru znanja
- Šta je tehnička dokumentacija?
- Koji su osnovni elementi tehničke dokumentacije?
- Čemu služe grafički prilozi?
- Zašto je tehnička dokumentacija važna?
- Navedi primere tehničke dokumentacije u IT oblasti.