[ic] Pee-Poor Documentation Rant

Dan Browning interchange-users@icdevgroup.org
Fri Jul 26 01:34:00 2002


At 03:18 PM 7/25/2002 -0400, you wrote:
> > I do know that there are plenty of people who are willing to give me a
> > one-liner asking for pages of work on my part. This is a constant in
> > open source software -- there are a far greater number of people
> > bemoaning the lack of work than people who actually sit down and do it.
> >
>
>No one is expecting a 'point-and-click' solution....
>But some good, step 1, step 2, etc would really help.  ESPECIALLY when it
>comes to permissions, etc.  That was trial and error for us to get working.

In my opinion, you are really close to doing it yourself.  Just look, 
you've got the first four down fine:

  1. Try
  2. Fail
  3. Repeat (until blood caffeine saturation >= 50%)
  4. Succeed

You perhaps just need one more step:

  5. Write the "good, step 1, step 2, etc" documentation.


+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| Dan Browning, Kavod Technologies <db@kavod.com>
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"I am the mother of all things, and all things should wear a sweater."