Dokumentiranost otvorenog softvera

[Abzeenth]

Na otvaranje ovog topica potaknuo me ovaj članak, iako sam već dosta sličnih pročitala i prije. Vjerujem da ste i vi čuli/čitali slična iskustva, a mene sada zanimaju vaša. Dakle, je li vam se kad dogodilo da ste tražili nešto, trebali nešto popraviti, instalirati, ili vas je samo zanimalo, a odgovarajuća dokumentacija nije postojala, ili je bila nepotpuna, ili čak pogrešna? Ako se skupi dovoljno zanimljivih priča na ovom topicu, napisat ćemo malo veći članak o tome .
Mislim da je dokumentacija vrlo važan aspekt softvera, no ponekad nažalost biva zanemaren, a krajnjim korisnicima je jako potreban...Mislite li da bi za pisanje dokumentacije trebali biti zaduženi sami programeri, ili bi za to trebalo uposliti nekoga tko razumije kod ali i potrebu korisnika za razumljivim, jednostavno pisanim tekstom za upotrebu tog koda? Ili u "svijetu Linuxa" postoje ipak malo drugačija pravila, gdje se već u startu očekuje naprednije poznavanje gradiva, pa je stoga potreba za dokumentacijom nešto slabija? Kakva su vaša iskustva s forumima kao izvorima dokumentacije/korisničke podrške?

Diskutirajte, molim. kava


U slučaju da već postoji jako slična tema ili je ovo pogrešan podforum, ispričavam se moderatoru te molim da istu premjesti.

[shrike]

Evo, tonem u bezdan sramote, ali najveći problem sa dokumentacijom sam imao sa samim sobom. Konkretno, napišem program za nešto što mi treba, ali bez ikakve dokumentacije ili komentara u samom kodu. TO za posljedicu ima da već za par tjedana nemam pojam što sam napravio, što čini korekcije i nadogradnje koda noćnom morom. Sada se moram sam siliti na pisanje bar komentara u kodu.

[glaskoncILLa]

dokumentacija je uvijek problem u it-u, svi vole nesto sastrikati, ali nitko ne voli pisati dokumentaciju.
i onda postoje neki open source projekti iznad kojih kojima nema sefa koji ce te natjerati da tako nesto ucinis, rezultat je jasan.
iako, za vecinu opce, sire ili najcesce koristenih aplikacija postoji dobra do odlicna dokumentacija, veci je problem sto to gotovo nitko nikad ne cita.

[madone]

Dobro, ovo štrikanje za svoje potrebe spada u posebnu kategoriju isto tako dokumentiranje unutar samog koda.
Prava tema je dokumentacija programa koji su prihvaćeni od najvećih distribucija i nalaze se u repou.
Tj opis mogućnosti i kako koristiti sami program.

Standard je da uz svaki program ide man stranica, u kojoj se nalazi osnovni opis programa za šta je namijenjen program i primjeri korištenja.

Isto tako uz GUI programe ide Help.

Dokumentacije je slaba prije svega da bi sami paketi bili što manji, jer distribucije dolaze na cd-ima. To je neko pravilo o kojem bi se dalo diskutirati.
Zato su ljudi izmislili Wiki

Mislite li da bi za pisanje dokumentacije trebali biti zaduženi sami programeri, ili bi za to trebalo uposliti nekoga tko razumije kod ali i potrebu korisnika za razumljivim, jednostavno pisanim tekstom za upotrebu tog koda?

Činjenica je da programeri sve znaju o programu ali ne mogu pokriti sve moguće scenarije upotrebe.
Idealno bi bilo kad bi postojao sistem nadopune dokumentacije.
Recimo, Wiki kao filter gdje se revidira "How to ..." i kasnije taj "How to" bude uključen u popratnu dokumentaciju programa.