Technical Writer, odnosno tehnički pisac, ili kao bolji prevod pisac tehničke dokumentacije ili autor tehničke dokumentacije je posao koji, iako ne toliko poznat, zapravo često neizostavan deo procesa proizvodnje i isporuke nekog tehničkog proizvoda na tržište, što uključuje i računarski softver. Autor tehničke dokumentacije je osoba koja je zadužena da tehničke koncepte i procese vezane za korišćenje određenog proizvoda na što jednostavniji i razumljiviji način objasni krajnjim korisnicima, ali i da kreira dokumentaciju namenjenu stručnim licima čiji posao je da određeni proizvod instaliraju, konfigurišu i održavaju. Da uprostimo, autor tehničke dokumentacije (Technical Writer) piše uputstva za korišćenje, konfiguraciju i instaliranje određenog techničkog proizvoda, a čija ciljna publika su kako krajnji korisnici, tako i tehnička lica koja se bave instalacijom, konfiguracijom ili održavanjem tog proizvoda.
Da li postoje još neki tipovi dokumenata za koje je obično zadužen autor tehničke dokumentacije? Odgovor je – da, postoje. Iako je najčešći primarni zadatak pisanje sadržaja koje omogućava i olakšava pravilno korišćenje određenog proizvoda, od osobe koja piše tehničku dokumentaciju se u nekim situacijama očekuje i da se bavi dokumentima iz B2B domena kao štu su odgovori na RF* dokumente, tačnije Request for Proposal ili Request for Information, blog postove koji su u manjoj ili većoj meri tehnički, whitepapers, itd. Ipak, svi ovi dokumenti podrazumevaju drugačiji format, jezik i stil u odnosu na tehničku dokumentaciju.
Šta je to (tehnička) dokumentacija?
Tehnička dokumentacija je uputstvo za korišćenje koje dobijete uz mikrotalasnu, help fajl koji otvorite u Microsoft Wordu, šema za povezivanje protočnog bojlera, ili recimo dokumentacija za API koji vam omogućava da iz svoje aplikacije šaljete automatizovane SMS poruke.
Tehnička dokumentacija podrazumeva sav materijal, najčešće u pisanom obliku, koji za cilj ima da korisnike određenog proizvoda nauči kako da taj proizvod pravilno koriste, instaliraju, konfigurišu ili održavaju. Tehnička dokumenacija je pisana jezikom koji je koncizan, precizan, tačan, izbegava komplikovane fraze i strukture rečenica i koristi generalno poznate termine i izraze umesto stručnog žargona, gde god je moguće.
Postoje različiti tipovi dokumentacije, čija forma zavisi od faktora kao što su:
- Namena. Verovatno najčešći oblik dokumentacije su uputstva koja vode korisnika kroz izvršenje određenog zadatka korak po korak. Ovaj tip dokumentacije je poznat kao procedura ili task. Pored toga, dokumentacija može objašnjavati i određene tehničke koncepte koji su bitni korisnicima, ili služiti kao referenca koja, na primer, navodi sve postojeće parametre i vrednosti za određeno podešavanje.
- Ciljna grupa korisnika. Nivo detalja i tehničkog žargona koji se koristi u dokumentaciji će često zavisiti od toga da li je dokumentacija namenjena krajnjim korisnicima koji ne moraju neophodno imati određeni nivo tehničkog znanja, ili tehničkim korisnicima čiji zadatak će biti da se određenim tehničkim proizvodom bave detaljnije, sa aspekta administratora, naprednog korisnika ili tehničkog lica zaduženog za podešavanje i održavanje.
Da li je svaka dokumentacija “tehnička”?
Termin tehnička dokumentacija (technical documentation) se ustalio kao odrednica za dokumentaciju koja se odnosi na određeni tehnički proizvod, uključujući i dokumentaciju za krajnje korisnike koja najčešće ne uključuje detaljne tehnilčke informacije, niti od korisnika zahteva visok nivo tehničke upućenosti u sam proizvod za koji je napisana. Takva dokumentacija se smatra “tehničkom” iz prostoga razloga što se ona isporučuje uz i ima za cilj da pomogne korisnicima da pravilno koriste određeni tehnički proizvod. Može se još naći i kao korisnička dokumentacija (user documentation ili end-user documentation), što ipak nije dovoljno sveobuhvatan termin jer, kao što je već rečeno iznad, dokumentacija vrlo često uključuje i sadržaj namenjen tehničkim korinicima koji nisu samo krajnji korisnici tog proizvoda.
Ovde moramo napomenuti jednu relativno suptilnu razliku između tehničke dokumentacije koja je namenjena eksploataciji samog proizvoda od tehničke dokumentacije koja najčešće nastaje unutar inženjerskih timova, kao što su dijagrami i nacrti sistema i njihovih komponenata, infrastrukture, dijagrami tokova (flowcharts) i druge vrste izrazito tehničkih dokumenata čija primarna svrha nije korišćenje ili konfiguracija samog proizvoda, već dokumentovanje detalja o samoj strukturi i funkcionisanju proizvoda kako bi se te informacije distribuirale interno među inženjerskim timovima, kako bi se dobila određena bezbednosna ili regulatorna odobrenja ili u druge svrhe čiji cilj nije edukacija eksternih korisnika.
Autor tehničke dokumentacije (Technical Writer) u softverskoj industriji
Technical Writing, odnosno pisanje tehničke dokumentacije, u softverskoj industriji manje-više postoji onoliko koliko i sam softver. Koliko god neverovatno izgledalo iz ove perspektive, u ranim fazama postojanja i razvoja softvera, računari i njihovi ekrani su pružali ograničen prostor za prikazivanje dokumentacije koja bi olakšala korišćenje samog softvera, dok bi navigacija kroz duži sadržaj često bila zamorna, a sam sadržaj segmentiran i nepregledan. Zbog toga su se korisnici često oslanjali na dokumentaciju u fizičkom obliku, koja uopšte nije ni bila na samom računaru.
Sa razvojem hardvera i operativnih sistema, dokumentacija je postala sve dostupnija na istom mestu gde i sam softver – na računarskom ekranu. Bilo u formi tekstualnih readme fajlova, formatiranih dokumenata (mnogi će se setiti RTF formata), Word dokumenata ili kasnije specijalizovanih CHM fajlova na Windowsu, tehnička dokumentacija je postala gotovo u potpunosti digitalna, a sam softver koji je trebalo dokumentovati dovoljno kompleksan da zahteva profesionalce koji imaju dovoljno tehničkih i lingvističkih veština i koji će biti posvećeni isključivo kreiranju sadržaja u svrhu da korišćenje tog softvera učini lakšim i dostupnijim korisnicima.
Danas se softverska dokumentacija distribuira gotovo isključivo u elektronskom formatu i to sve manje u formi pojedinačnih dokumenata, a često u formi namenskih web sajtova za dokumentaciju koji imaju za cilj da što bolje organizuju i strukturiraju sadržaj i omoguće što tačinju i napredniju pretragu, kako bi korisnik što brže i lakše došao do informacija koje su mu potrebne. Dokumentacija je takođe implementirana u sam softver čije korišćenje objašnjava, kroz dodatne opise i objašnjenja (tooltips), ali se uticaj onoga što radi Technical Writer ogleda i kroz celokupan tekst koji se nalazi u korisničkom interfejsu (za koji možete naći nekoliko naziva kao što su UI text, UI copy, Microcopy).
Na kraju, upotreba veštačke inteligencije (AI) i velikih jezičkih modela (LLM) donosi jednu relativno novu dimenziju, gde se korisnikov zahtev za informacijama koje se nalaze u dokumentaciji, kao i način i forma na koje ih korisnik dobija nazad, značajno unapređuju i razlikuju u odnosu na ono na šta smo navikli do sad. Ovakav razvoj će nesumnjivo dovesti do potrebe da se usvoje nove veštine u mnogim profesijama, pa tako i u kreiranju tehničke dokumentacije.
