Увод
Приликом писања техничко-пословних докумената поштује се форма – главна карактеристика техничког писања. Елементи форме свих техничко/пословних докумената су:
- матрица или клише (структура) нпр. меморандум за комуникацију унутар фирме, писмо за комуникацију са другим фирмама итд.,
- изглед техничке форме, нпр. меморандум је обично на једној страници и кратко изражава намеру са јасним упутствима за читање и усмеравање одговора,
- конвенција, нпр. где се и на који начин у пословном писму пише датум, адреса, потпис, поздрав,
без обзира да ли су документа у папирној или електронској форми.
Техничко/пословна документа у свим пројектима, па тако и у софтверским пројектима могу се грубо поделити на две групе докумената:
- кратка документа (меморандуми, писма, записници…) и
- дуга документа (технички извештаји, студије случаја, понуде, техничке презентације, професионални чланци…)
Кратка документа
У кратка техничко-пословна документа могу се уврстити меморандуми (писма унутар организације), писма и кратки записници – обично са састанака. Све врсте кратких докумената треба да имају следеће карактеристике:
- морају да имају циљ: аутору мора да буде потпуно јасно шта треба да се постигне писмом. Циљ може да буде предлог идеје, презентација података, давање упутстава, критика нечега и сл. – увек треба да постоји један примаран циљ, уз евентуално неколико секундарних циљева;
- морају бити позитивна: аутору је увек циљ да добије позитиван одговор на своје писмо, тј. да прималац прихвати идеју писма. Да би се то постигло, при писању треба пажљиво бирати речи и користити позитивне фразе;
- морају да користе емпатију: аутор треба себе ставити у положај примаоца – посматрати проблем из његовог угла (нпр. ако пишете писмо да би свог надређеног убедили у нешто, нећете успети само зато што ви мислите да је то добра идеја – морате да опишете предности ваше идеје из његовог угла);
- морају да побољшавају међуљудске односе: аутор треба промишљено да користи речи и фразе за презентовање сопственог мишљења, приликом чега стил писања треба да буде разумљив, разуман, тачан и пријатан (нпр. текст “погрешили сте у обрачуну цене пројекта” треба заменити текстом “требало би да прегледамо табелу са ценама, чини ми се да се негде поткрала грешка”).
Најважнији стандарди преписке су једноставност и јасност, тачност и комплетност и употреба стандардног језика. Употреба нестандардног језика може да класификује аутора као непажљивог, немарног или недовољно стручног.
Меморандум
Меморандум (мемо) је документ за комуникацију унутар организације, не за спољне читаоце. Стога не садржи конвенције (поздрав, адресу и сл.) и најчешће је много мање формалан од писма. У осталим аспектима, веома је сличан писму. Његова основна функција је да информише. Садржи заглавље – датум, пошиљалац, прималац, предмет разматрања, и тело – прегледан садржај лак за разумевање, са логичним редоследом. Меморандум може бити информативни, директивни, састаначки и административни.
Писмо
Систем кореспонденције је интегрални део софтверског пројекта који обезбеђује одговарајућу комуникацију. Кореспонденција се састоји од писама различите намене и кратких докумената. Грубо се може поделити у две групе:
- преписка у вези запошљавања и
- преписка у вези великих техничких пројеката.
При кореспонденцији, потребно је приџавати се следећих начела:
- начело брзине – експедитивности,
- начело тачности, законитости и обазривости,
- начело писања пословним стилом,
- начело чувања пословне тајне,
- начело добре техничке обраде,
- начело чувања пословне преписке.
Писмо не сме да садржи материјалне грешке, језик мора бити чист књижевни језик, уз поштовање и примену правописа. Титуле, имена и адресе морају бити правилно исписане. Писмо садржи следеће елементе:
- заглавље (адреса и име адресанта, горе лево),
- ознаку везе (ако постоји),
- место и датум писања (десно, у формату Место, ДД.ММ.ГГГГ. или Место, ДД. месец ГГГГ.),
- назив и пуну адресу адресанта,
- ознаку предмета (најкраћа формулација целокупне садржине писма),
- фразу ословљавања (Поштовани или Господине + функција или презиме),
- садржину (увод, језгро и закључак са поздравном фразом),
- информацију о броју и врсти прилога,
- потпис, печат, функција, име и презиме лица овлашћеног за потпис.
Преписка у вези запошљавања обухвата: писмо пријаве на посао, кратка биографија (CV), мотивационо писмо, писмо којим се тражи или даје препорука, писмо захваљивања, писмо за прихватање запослења, писмо за одбијање запослења.
Преписка у вези техничких пројеката обухвата коресподенцију у вези: контаката, планирања, документације, управљања временом и задацима, спечавања проблема и решавања проблема.
Дуга документа
Дужа техничка документа се могу поделити у три категорије:
- техничке форме: технички извештаји, понуде, техничке препоруке и
- академске форме: лабораторијски извештаји, студије случајева,
- професионалне форме: чланци, презентације.
Техничке форме
Свака фаза пројекта везана је за један или више докумената, на пример, стабло докумената на једном пројекту може да изгледа овако:
Облик техничке форме зависи од намене документа. Комплетна документација треба да садржи све информације потребне за инсталацију, коришћење, разумевање рада и проналаз евентуалних грешака у раду производа. Техничка документација треба да је тако организована да може ефикасно да се користи. Треба имати на уму да корисник документације нема исто знање као пројектант, те да многе ствари које изгледају очигледне, кориснику могу да буду потпуно непознате. На пример, елементи једно техничког документа могу да буду:
| Елемент | Опис |
|---|---|
| Насловна страна | Назив производа/пројекта, организација, аутори, датум |
| Увод | Циљ, намена, особине |
| Инсталација | Инсталационе и конфигурационе процедуре |
| Употреба | Упутство за употребу |
| Опис | Опис функционисања, алгоритми |
| Грешке | Симптоми, могуће грешке и како их отклонити |
| Референце | Додатни ресурси који се односе на производ |
| Додаци | Спецификације, дијаграми, листинзи и сл. |
Академске и професионалне форме
Резултати научних и техничких истраживања представљају се на конференцијама, стручним скуповима и семинарима или објављивањем у научним или стручним часописима. Циљ представљања оваквих истраживаља је презентација резултата са описаним детаљима и процедурама, на што јаснији начин, тако да читалац може да формира своје закључке.
Прописане форме оваквих докумената доноси организатор скупа, односно, издавач часописа. У већини случајева присутни су следећи елементи:
| Елемент | Опис |
|---|---|
| Наслов | Тема, организација, аутори, датум |
| Апстракт | Кратак опис теме и резултата |
| Увод | Идеја рада, дефиниција проблема, решења |
| Тело | Услови и претпоставке, анализе |
| Закључак | Дискусија резултата |
| Слике и табеле | Листинг слика, дијаграма, табела |
| Референце | Референце на објављене радове по редоследу појављивања |
Уколико је на изради рада радило више аутора, први потписани треба да буде онај који је урадио највећи део посла. Уобичајено је да остали потписани аутори буду колеге које су учествовале на његовој реализацији, без обзира на обим њиховог доприноса. Као последњег аутора треба навести и колегу који је дао идеју и/или смернице за реализацију. Подразумева се да је потребно тражити сагласност о коауторству од свих аутора пре лекторисања и рецензије документа.