ducin blog®:
kako to rade pravi majstori

Knjiga: Pisanje tehničke dokumentacije

 Ako se bavite razvojem softvera, pisanje dokumentacije je neizostavan deo Vašeg posla. Koliko god pokušavali da zanemarite ovaj zadatak, Vaš softver ne vredi ništa bez dobrog uputstva. Međutim kako naučiti veštinu pisanja?

O programerskim veštinama naći ćete gomilu knjiga. Ali teško da ćete naći knjigu koja Vas uči kako da pišete. Posebno ne onu koja Vas uči da pišete tehnička dokumenta.

Imao sam sreću da naiđem na jednu zaista dobru knjigu u izdanju Kompjuter Biblioteke. Knjiga nosi naziv: "Pisanje tehničke i projektne dokumentacije za inženjere, naučnike i studente", a autor je Barry Rosenberg. Izdanje je iz edicije "Skok u…" i predstavlja odlično utrošenih hiljadu dinara.

Odličan prevod

Ono što je bitnije od činjenice da je sama knjiga dobra, je to da je prevod knjige odličan. Dok nisam počeo da je čitam, bio sam jako skeptičan po ovom pitanju. U drugim slučajevima to možda i ne bi bilo od značaja, ali je ovde prevod jako bitan. Kako dokumenta pišete verovatno na engleskom, knjiga ne bi bila ni od kakve koristi da je bukvalno prevedena. Ili još gore, da je prevodilac pokušao da prilagodi sadržaj našem jeziku.

Izbor onoga što će ostati u originalu, na engleskom, je jako inteligentan. Prevedeni su opšti koncepti i generička priča koja ima smisla i na našem jeziku. Primeri rečenica ostali su na engleskom. Tako na primer, u delu u kome autor pominje pravilan izbor reči ne može da dođe do zabune. Preporuka koje fraze treba izbegavati, jasno se odnosi na engleske reči koje su tako i napisane.

U ostalom kupite knjigu(ili pozajmite od prijatelja), i obavezno je pročitajte, pa ćete razumeti o čemu govorim… Ukratko, najtoplije preporučujem da se nađe na vašoj polici.