Re: user documentation

On 5/26/07, Joe Pham <[email protected]> wrote:

> Yes, certainly!  Each help page is essentially an html file.  If
> you're somewhat familiar with html, you're ready to go.
> -Joe Pham

I'm good to go on HTML.

The stuff I wanted to tweak is:

o) document the "shift key" trick on the "image preview"
page; currently, this is documented only on the FAQ
(at least, as far as I can tell)

o) add some specifics about vx8700:
a) I used "music kit" that said vx8500 and vx8600 on
box; software and cable worked fine
b) I used drivers from music kit and no other software
c) cable is not straight through, has a "brick" in the
middle
____

Has any consideration been given to documenting
using a wiki? This would have the advantage that
it would be easy to edit and update by interested
parties. Of course, access would have to be controlled
to limit vandalism.

Having the help file local is certainly nice, but I'd
prefer a more accurate and up-to-date document
on the web. After all, BitPim is pretty darn easy
to use. There continues to be a need for
documentation of various fine points, which does
not seem to require the immediacy of local
documentation.

I have occasionally made edits to Wikipedia
(along with about a million of my closest friends);
I think some users would be willing to update
with their first-hand experience if it was easy.

There certainly are some disadvantages, so
it's not a slam dunk. But maybe it would encourage
others to write documentation so that developers
who don't want to don't have to.

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/