Често се може чути цитирање Катона Старијег – „Ceterum censeo Carthaginem esse delendam“. Искусни инжењери знају шта им је у пракси значила техничка документација о системима на које се њихов рад наслањао. Она помало личи на Картагину, коју једно за свагда треба освојити. Релативно лака доступност информацијама, посебно коришћењем Интернета ствара слику да се понешто везано за документовање пројеката може и прескочити. Полазећи од претпоставке – „Има то на Интернету“ млади инжењери често мисле да и сами не морају баш све да представе окружењу. Нажалост пракса је често отрежњујућа. Јер често на Интернету нема баш онога што нам је потрено. А лако се заборави и понешто од онога што смо сами урадили. Поготову ако нисмо забележили детаље везане за сопствено решење.
Истовремено Интернет је много допринео олакшавању инжењерских послова. Пре свега кроз доступност информација о компонентама и уређајима који се при пројектовању користе. Такође, не треба занемарити ни могућност коришћења готових пројектних решења. Међутим, и у таквим ситацијама техничка документација може да умеша своје прсте. Документација која се у таквим случајевима може наћи на Интернету често је непотпуна. А може изазвати недоумице. Свако ко је користио такве информације на Интернету био је у прилици да се упозна са проблемима њиховог квалитета.
Све ово додатно указује на значај техничке документације за успех инжењерског посла. С једне стране њен утицај на ефикасност пројектантског посла. А са друге стране ефикасност коришћења реализованог уређаја или система. У принципу не може да се утиче на туђу техничку документацију. То може да уради наручилац посла кроз спецификацију захтева за реализацију пројекта. Овде ће се дати оријентациони пример структуре техничке документације која прати реализацију типичног инжењерског пројекта.
Техничка документација - структура
Недостатак конкретног примера техничке документације може заменити и приказ како би она начелно требало да изгледа. Поред уобичајених уводних напомена којима се опис уређаја представља кориснику следе поглавља:
- Технички захтеви – у овом поглављу треба дати спецификацију уређаја или система који се описује. Након тога треба корисника упознати са функционалним захтевима према којима је систем реализован. Такође, треба изнети и нефункционалне захтеве, као што су перформансе, поузданост, скалабилност, итд.
- Пројекат и структура система – пре свега потребно је изложити структуру система. У складу са тим треба приказати неопходне блок дијаграме и дијаграме тога унутар реализованог система. На крају треба дати опис главних компонената система и везе које постоје међу њима.
- Реализација – детаљан приказ реализације система. То подразумева детаљан приказ начина реализације, коришћених алата и технологија. При томе треба дати примере конкретних решења, која су карактеристична за систем.
- Тестирање – начин и план тестирања укључујући и конкретне тестне случајеве. У склопу тога треба дати резултате тестирања, као и коришћене алате за тестирање.
- Одржавање – упутства за одржавање система. Мере сигурности којих се треба придржавати. Поступци за ажурирање и надградњу система.
- Корисничка документација – кориснички приручници, упутства за инсталацију и конфигурисање система.
- Референце – списак коришћене литературе и других ресурса. То подразумева и линкове на додатне изворе информација.
- Прилози – информације које додатно описују систем, као што су листе делова, додатни дијаграми, итд.
Има још понешто
Техничку документацију сам поменуо, јер њу подразумевам као нешто обавезно. Обавезу која проистиче из пословног односа, али и обавезу коју треба да имамо према себи самима. Као референцу на протекли рад, али и средство које може да послужи кад треба урадити нешто слично. Чак и онда када се реализације драстично технолошки разликују.
У претходној секцији је дата општа структура техничке документације, која треба да прати реализацију пројекта. Она се може применити у пуном обиму, али зависно од сложености пројекта могу се изоставити поједини делови. У прошлости је техничка документација обавезно морала да се уради на папиру. То је подразумевало постојање текстуалног описа пројекта, праћеног шематским приказима. Данас се техничка документација може реализовати и у електронском облику. Текстуални опис и шематски приказ пројекта могу се дитрибуирати на некој од спољашњих меморија. Нпр., на CD/DVD или Flash меморији. А може бити расположива и преко WEB страница.
Међутим, искуства стечена током реализације пројеката не морају да буду представљена у облику комплетне техничке документације. Она могу да буду садржана у техничким извештајима (technical report), техничким решењима (technical solutions), техничким описима (technical descriptions), итд. У складу са политиком поверљивости фирме и реализованог пројекта могу да буду интерног и јавног карактера. Такође, могу бити у папирном и електронском облику. Често се реализација важних пројеката прати одговарајућим WEB садржајима. У таквим случајевима јавни технички извештаји могу да се дистрибуирају на овај начин. У многим случајевима реализатори пројеката користе могућност да резултате рада представе и у облику стручних и научних радова.
Резултати рада на пројектима по правилу су власништво наручиоца и реализатора. Због тога треба водити рачуна о последицама јавног представљања тих резултата. Када је власник резултата фирма реализатор, може се сматрати обавезом да свим запосленим у њој они буду доступни. Прави начин за то је прављење одговарајућих интерних извештаја.
Како израдити техничку документацију
Са развојем технике и технологије напредовале су и технике које су коришћене за израду техничке документације. Генерације које су своју професионалну каријеру започињале на прелазу седме и осме деценије то су добро осетиле. Сваки инжењер добро зна да се техничка документације по правилу састоји из два дела: текстуалног и графичког. Текстуални део документације представља опис система на који се документација односи. С друге стране графички део документације садржи скице, шеме и цртеже којима се визуелно описује реализовани систем.
Врсте техничке документације
Начелно техничка документација може бити:
- Пројектна докумнтација – представља скуп докумената који описује све аспекте пројекта. Докзумети обухватају све фазе пројекта од планирања до завршне реализације. Укључујући техничке спецификације, буџете и временске оквире реализације.
- Производна документација – представља скуп инструкција за производњу, монтажу и тестирање производа или система који се реализује. Овај вид документације обухвата и листе материјала и описе производних корака.
За сваки реализовани систем или производ кориснику треба да буду на располагању и друге врсте документације, које обухватају:
- Корисничка упутства – документа која омогућавају крајњем корисникуда правилно користи производе или системе. У њу су укључена упутства за инсталацију, употребу и одржавање.
- Сервисна документација – ради се о документацији намењеној сервисерима, тј. људима који врше одржавање и поправку производа и система.
Поред наведених типова документације специфични системи и производи могу захтевати израду одговарајуће документације.