On Tue, 12 Feb 2008, Jan Dusatko wrote:
>2. Manual vznika jako hruby vytah funkce kodu. Nejpresnejsi informace ti
>poda prave kdyz zdrojaky prolezas. Pokud chces dostatecne presne popsat
>nejaky system, musis ten system vlastne napsat. Takze manual nemusi byt
>nejultimativnejsi informace. Jinak by nevznikalo na netu tolik HowTo.
cau, manual jak ho mozna tady vetsina z nas chape by mel plne popsat
interface, coz je presto to vsechno, co bys _mel_ potrebovat vedet.
Interface muze byt popis API funkce v sekci 2 a 3, nebo volby a co delaji
pro prikaz v sekci 1 apod. Howto je uz neco trochu jinyho, to je spis
dokument k tomu, abych dosahl neceho, aniz bych musel cist (cely) manual.
to ze potrebuju prolezt zdrojaky proste znamena, ze v manualu neco
chybi. Coz byva bezna vec, ale neni to spravny. Jen velmi malo lidi muze
efektivne cist zdrojaky, navic pokud by se to rovnou stavelo na tom, ze
clovek si spis ma precist zdrojaky aby pochopil co system dela, myslim si ze
je velka pravdepodobnost, ze system bude spatne navrzen, protoze casto
nebude mit presne definovany interface k uzivateli.
navic, pokud neni program dobre zdokumentovan, ma vetsi tendenci k
nekompatibilnim zmenam, coz je dalsi velky a bohuzel casty problem.
samozrejme jsou vyjimky potvrzujici pravidlo.
h.
--
Jan Pechanec <jp (at) devnull (dot) cz>
http://www.devnull.cz
--
FreeBSD mailing list (users-l@freebsd.cz)
http://www.freebsd.cz/listserv/listinfo/users-l
