Šta je novo?

Dokumentacija ....

Ha

Čuven
Učlanjen(a)
09.07.2000
Poruke
339
Poena
619
Kroz neke od thread-ova je bilo malo provuceno i ono sto ja
smatram izuzetno vaznim, a to je pravljenje propratne dokumentacije za napravljeni program ili uopsteno za softverski proizvod... ISO....DIN ... JUS :) ... moj standard ....necu da budem Rus :)

Posto je tema malo opsirna, bilo bi dobro da se daju bar
grublji opisi ...



P.S. Ko zna i hoce nek' navali :)
 
Vechina danasnji programskih jezika ima (ili ugradjene ili se naknadno dokupljuju) alate koji upravo tome sluze (govorim o programima za rad sa bazama podataka, posto tu imam iskustva) .
Pitanje je da li ti uvek odgovara to sto oni nude, ili mora chovek sam da uradi josh nesto pride. Po pravilu izlazi gomila papira koja ce garant da impresionira onog koji nema bash velike veze sa onim sto se trazi.
 
Dopunio bi ono sto sam napisao u prvom dijelu...

Znacajno bi bilo kad bi se pojasnilo kako izgleda dokumentacija za gotov softwerski proizvod, tj.
1. naziv :)
2. sta radi
3. kako radi
4. i sl
...
oo. i sl. :)

To je svakako znacajnije za ljude koji su pri nekakvim firmama(narocito zapadnim), jer ISO - valjda odredjuje neke norme u vezi izrade doticnog proizvoda, kao i kakva mora biti dokumentacija vezana za isti. Ovo zadnje je i pitanje, jer kad bi svko pravio dokumentaciju kakvu hoce bio bi haos.

Eto da ne duzim ...


pozdrav!
 
Kao sto si i sam u pocetku primetio i za ovu oblast postoje standardi, ne stadard (jednina). Generalno, firma u kojoj radis odredjuje nacin i vrstu dokumentacije u skladu sa politikom developmenta tvog sefa u toj oblasti. Znaci, sa jedne strane se odredjuju atributi pratece dokumentacije projekta (znaci, interno za firmu, cesto kao "poverljivo") i dokumentacija samog programa koja se oslikava u helpu i user manualu.

Ova interna dokumentacija obuhvata sve od idejnog resenja (projektovanje), preko zacrtanih milestonova (i krajnjeg deadlinea - znaci uvezena dokumentacija planiranja iz programa kao sto je MS Project) i analiza troskova, do krajnjih detalja koji pokazuju koliko finalna verzija odstupa od planiranog, gde su problemi i mesta za poboljsanje (na koji nacin) i slicne predispozicije za novu verziju. Ovde se ukljucuju i neki normativi za komentarisanje u samom kodu radi daljeg odrzavanja sw-a.

Dokumentacija koja prati sam proizvod, a namenjena je krajnjem korisniku, a najcesce zavrsava kao hlp ili html fajl. Pod windows platformom ce te verovatno zanimati program RoboHelp, a pod linuxom pogledaj na netu detalje u vezi docBooka i kdoc-a, recimo.

U vecim firmama obicno postoje ljudi koji se bave pisanjem dokumentacije/helpova, ali to se uglavnom odnosi na ovu grupu dokumenata (opis gotovog proizvoda). A ovu internu dokumentaciju obicno ne mozes nikako izbeci - jednostavno moras da opises svoj rad (pogotovo ako ti je dodeljen poseban proizvod za development). U zavisnosti od projekta do projekta, odnos programiranje / dokumentovanje ume cesto da bude i 60:40.

Sto se tice samih standarda, ne verujem da ce te direktno zanimati, posto su vec implementirani u ove alate. Osim ako i sam ne mislis da radis sw koji se bavi generisanjem dokumentacije i slicno :) No, ukoliko ti je bas stalo, evo par linkova:

http://www.w3.org/DOM/
http://developer.kde.org/documentation/kde2arch/tools-kdoc.html
http://www.oss.com/asn1/index.html i, naravno
sajt ANSI-ja.
 
Da bar kazem .....

Zahvaljujem se na linkovima. Nisam jos stigao da ih obidjem.

Pretpostavljao sam u vezi dokumentacije neke stavari, ali je sad u svakom slucaju stvar jasnija :)


pozdrav!
 
Vrh Dno