[ic] Pee-Poor Documentation Rant

Dan Browning interchange-users@interchange.redhat.com
Mon Jan 14 12:55:00 2002


> Another rant about the woeful documentation:::
[...]
> -= Jim =-

I don't know what happened to my trigger button, but I flipped the
safety on this time, so it shouldn't go off accidentally again.  

Above all, can't we enjoy a mailing list that had these qualities?
"Love, joy, peace, patience, kindness, goodness, faithfulness,
gentleness and self-control".  Flame wars would lose their spark if we
tried it.

Jim:

1. [fortune] tag - it could probably use some more advertising.
2. A better alternative to ranting is recommending a change.  "Add Note"
is a good way, or even posting a patch.
3. As others have pointed out, the [file] tag says "Inserts the contents
of the named file".  Kind of like when the dictionary says "see ...",
you are supposed to turn to that page.
4. The Tutorial covers [include] very well.

Nothing anyone says will spontaneously make other people do
lots of tedious work for free.  Now that the mind-control option is out
of the way, here are the left-over options:

1. Be Annoying: "Uhhh, it sucks dude"
2. Be Helpful: Specifically explain what sucks about it (i.e. bug
report)
3. Be Cool: Fix it yourself (Kudos to Ed L. for writing ic_ecommerce)
4. Be Rich: Pay some one else to fix it
5. Be Quiet: Same as #1 except it is less annoying

Everyone can be Helpful, some are Cool, some are Rich, but the rest of
us should be Quiet.

Jim, I find that you continue to be #1, and you'll get yourself into a
lot of >/dev/null's that way.

+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| Dan Browning, Sr. Tech Consultant
| Kavod Technologies, 1498 SE Tech Center Pl Ste 170
| Vancouver, WA 98683  <dan.browning@kavod.com>
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Langsam's Laws:
	(1) Everything depends.
	(2) Nothing is always.
	(3) Everything is sometimes.