Hello Kurt.
26 Jan 98 02:52, Kurt Kuzba wrote to John Gardeniers:
JG>> Writing the docs is by *far the most unfun part.
KK> Agreed. No matter how much or how little fun you are having,
KK> it is going to be MUCH LESS fun when you are called on to
KK> explain it. Frequent comments and meaningful variable names
KK> can really help a lot in getting the story straight.
One would hope that the programmer has the story straight! ;-)
Though you are correct in that, if all facts are left to memory,
mistakes are bound to happen, even to the best of us.
I find describing the interface, ie; how to use it, how not to
use it, what to expect from it, what not to expect, etc... to
the non-programmer user "on their terms" to be the most cumbersome
PITA. I like to write utilities for local BBS Sysops in exchange
for high access privileges. When I do I always try to have them
write the docs with me acting as editor. The docs get passed back
and forth until we are both satisfied with them. So far it has
worked out quite well.
-Roger
... documentation...the stuff you wipe up coffee with.
--- Msged 4.20 beta 3
(1:273/404@fidonet)
---------------
* Origin: Hodge-Podge Support BBS, Upper Darby, Pennsylvania, USA
|