Техничко писање
При изради докумената у софтверским пројектима, потребно је придржавати се правила техничког писања. Техничко писање служи за брзу, тачну и једноставну размену информација. За техничко писање није потребан таленат већ вештина и промишљеност. Техничко писање је саставни део посла у софтверском инжењерству и битно је за комуникацију у четири процеса:
- инвестиционо-технички елаборати и њихова оцена,
- размена информација унутар организације,
- комуникација међу организацијама и
- израда техничке документације.
Техничко писање је формално пре него сликовито и иде по стандардним клишеима. Процедуре и ситуације у инжињерској пракси су типичне, па су и одговарајућа техничка писања стандардизоване форме.
- оралне - неформалне (кратке презентације у виду конференцијског или телефонског разговора) и формалне (званичне научне и техничке конференције са питањима и дискусијом),
- писане - техничке информације (прорачуни, извештаји, документација), законски папири (уговори, понуде, записници) и
- графичке - артистичке (избор боје и квалитета папира, графички прелом, коричење), илустрације (графички приказ докумената и техничких резултата).
Техничко писање подразумева следеће елементе:
- инвенција,
- аранжман,
- стил,
- граматика и
- механика.
Инвенција је "размишљајући шта да кажем", што у техничком писању не представља проблем јер је техничко писање формализовано и стандардизовано. Техничком писању није циљ креативност него информативност.
Аранжман је кључна особина техничког писања. Оно мора бити реторичко - материјал аранжиран у логичном поретку, лак за читање и разумевање. Реторички приступ обухвата одговоре на питања:
- Шта је предмет анализе?
- Чему је то слично?
- По чему се разликује од сличних решења?
- Да ли је то део неке веће целине?
- Који су саставни делови?
- Како то функционише?
- Шта је изазвало да се то догоди?
- Шта ће се десити као резултат?
Претходна питања проистичу из стандардне реторичке структуре, која се усавршава од античких времена, да би се добила систематска и логична презентација. Она садржи:
- дефиницију: сви нестандардни појмови и речи морају бити недвосмислено и јасно дефинисани. Не смеју се користити непознате речи.
- опис: предмет разматрања треба сместити у шире оквире техничких дисциплина којима припада - наћи му место у систему.
- компарацију и контраст: понудити разне алтернативе и упоредити их.
- класификацију: ако је разматрани проблем део неког већег пројекта, треба га ставити у релацију са целином.
- поделу: поделити предмет разматрања на логичке целине и описати односе међу логичким целинама.
- процес: опис начина рада са циљем да се он објасни и илуструје.
- узроке и последице: шта су узроци ситуације око предмета разматрања и какве ће бити последице одређених одлука и решења у техничком или економском смислу.
Стандардна реторичка структура се може посматрати као алат за преношење техничких проблема и решења у техничку документацију.
Стил је тешко описати - лакше се описују последице. Стил је композит од инвенције, аранжмана, граматике и механике. Техничком писању не треба стил као елемент препознавања. Довољан је сувопарни формализам, али да писање буде јасно и недвосмислено, тј. функционално.
Граматика је основна унутрашња структура аранжирања речи у језику у циљу једнозначног изражавања. Нарочито је битна структура реченице.
Механика писања се односи на употребу интерпункције, спеловања или језичких скраћеница.
Писац техничког текста ради у тесној вези са другим техничким ствараоцима и морално-правно је одговоран за свој рад. Поред поштовања техничких стандарда, у техничком писању се мора избегавати плагијаторство - треба референцирати коришћене изворе и поштовати закон о интелектуалној својини.