Meeting

Darren Duncan darren at DarrenDuncan.net
Thu Dec 12 14:30:51 CST 2002


On Thu, 12 Dec 2002, abez wrote:
> I find this strategy works well. Write docs for your code before hand. Specify
> how you want it used. Don't spend too much time on it.

This is similar to how I learned structured programming in college.
Essentially write the interface first and/or the user documentation, and
then afterwards implement it.  If you find that you can't adequately
explain how to use the module to someone else, it probably isn't designed
properly.

> Before you release anything in the wild you should provide some docs otherwise
> people won't use it and if people won't use it why release it?

I will take this comment as a general suggestion.

But in case anyone misinterpreted this as referring to the state of my
older released modules, I will briefly clarify...  It is true that about
2/3 of my released modules do not have any or a complete test suite (but
they all come with a test.pl that confirms they compile).  However, every
single one of my modules does have complete user documentation, examples
of using the module, and interface documentation for all the methods, etc;
in other words, complete POD.  Only the lack of complete test.pl is
keeping 2/3 of my older modules from being finished.

Regarding Xtreme Programming, while I have heard about this, I have never
read books on it or knowingly practiced it myself.  Maybe some of my
'structured programming' practices are compatible with XP, but I have
never tried to be an XP programmer.  I can't comment on how good or bad it
is from experience.

-- Darren Duncan




More information about the Victoria-pm mailing list