[Novalug] documentation

[Don E. Groves, Jr.]

Yes I fully agree that ALL Programs need to be fully documented both at a
coder level and at a end-user level.

Even personal scripts (ie those little helper scripts/macros) need to be
properly documented or the user will WASTE a lot of time restudying the
"code" just to figure out what they are suppose to be used for and why they
exists and are needed.

Lately I've been studying the code/configuration for a ASUS WL-700ge (a
Multifunctional Wireless Storage Router) and the one thing most lacking is
the documentation.
   (yes most of the source code is aviable, other then certain Broadcom
drivers.)
But a lot of what's there is totally Un-Documented and even though it's
Linux Kernel and unix(like) based it still means far more studying is
required before any improvements/ expansions of usage can even be attempted.

OT (-: only slightly :-) :-)
 Hum "Interpreting LISP by *Gary D*. *Knott* "
 And here I was pointing links out to a published author and suggesting that
a simple Googly would answer a "very" complex request for understanding.
 Maybe I should Google a little more myself.

--- ---- .....

On Fri, Apr 18, 2008 at 7:52 PM, Gary Knott <knott at civilized.com> wrote:

> Thanks, Don, for the link.  I will look at some of those
> files and perhaps I can find the detailed file content
> definitions that I seek.  - I expect you agree however,
> that this nice link does not obviate my remarks about
> the need for documentation both for coders and users
>
> -------------------------------------------------
>

-- 
--
Don E. Groves, Jr.

Tag it's your turn now... ... ....
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://calypso.tux.org/pipermail/novalug/attachments/20080418/ab0776eb/attachment.htm