2009-12-28

quality documentation

9.6: news.addx/doc's/good examples:
. according to Xah Lee
here are doc's that co.python's should emulate:
. it seems to be the oss`culture,
-- Perl, Python, Unix, Apache etc[in the unix anti-cs spirit] --
that their documentation exhibit
jargon abuse, rambling, author [self-promotion], or hodgepodge
but this doesn't apply to Gnu's Not Unix project.
GNU docs are geeky in comparison to the above commercial docs;
but, the GNU project in general (gnupress.org)
.


10.9: adda/doc files:
. instead of having long comments,
have in addition to head and body files
a doc file that includes docs for that unit
wherein you redo the routine in english (your own words) .


No comments:

Post a Comment