Pisanje tehničke dokumentacije

[Siniša Ranđić]

Tehnička dokumentacija je jedan od bitnih faktora za realizaciju inženjerskih projekata. Nažalost tokom studija, ovoj problematici se ne posvećuje puno pažnje, što kasnije u praksi predstavlja jedan od najvećih problema. Jednostavno inženjeri se tek u praksi sreću sa značajem tehničke dokumentacije, a onda sledi i problem njenog pisanja.

Imajući u vidu ovaj problem tokom letnjeg semestra tekuće školske godine biće održan jednodnevni seminar sa tematikom IZRADE TEHNIČKE DOKUMENTACIJE.

Do tada evo nekoliko linkova pomoću kojih se može doći do zanimljivih uputstava kako pisati tehničku dokumentaciju.

• http://www.rpbourret.com/kgallag/index.htm - Na ovoj WEB adresi mogu naći uputstva i praktični primeri kako se piše softverska dokumentacija. Ovaj tekst je dodatno interesantan, jer je namenjen Nemcima koji trena dokumentaciju da pišu na engleskom jeziku. Treba obratiti pažnju da se u velikom broju zemalja tehnički izveštaji, pored na lokalnom jeziku, pišu i na engleskom jeziku što predstavlja dodatni problem. Međutim, ovakav pristup može da bude veoma značajan sa aspekta savremenih zahteva za mobilnošću radne snage.
• http://www.tekom.de/upload/alg/INTECOM_Guidelines.pdf - I u ovom tekstu se mogu naći uputstva za pisanje dokumentacije na engloskom jeziku.
  
• http://ezinearticles.com/?Technical-Writing-How-to-Write-a-Technical-Document-Consistently-and-Maximize-User-Trust?&id=1818095 - Ovaj tekste se bavi problemom pisanja tehničke dokumentacije sa aspekta konzistentnosti.
• http://ezinearticles.com/?expert=Ugur_Akinci - Na ovoj WEB stranici mogu se naći linkovi na čitav niz tekstova koji tretiraju problematiku pisanja taehničke dokumentacije.

[Siniša Ranđić]

Ovu tematiku sam dodirnuo pre sedam godina. Istina tu i tamo o ovome sam pisao i u okviru drugih tema na Forumu. Da je ovo stalno aktuelna tema potvrdila je i protekla školska godina tokom koje sam pored respektabilnog broja diplomskih radova sa studentima radio i projekte u okviru predmeta Projektovanje digitalnih sistema i Upravljački računarski sistemi. Jedan od najznačajnih problema sa kojim sam se pri tome susreo bila je upravo dokumentovanje realizovanog posla. Zbog toga je pri predstojećem revidiranju nastavnih planova neophodno naći prostor i način da se studenti obuče za ovaj posao. Činjenica je da su naši studenti više okrenuti softverskom delu računarstva gde je u okviru tehnologije razvoja programa već ugrašen aspekt dokumentovanja realizovanog softvera evidentno je da se naši studenti ni na tom planu ne snalaze baš najbolje. Tj. ne koriste mogućnosti koje alati za razvoj softvera pružaju u pogledu izrade softverske dokumentacije.