Forum OpenACS Q&A: Response to Community Documentation Using Wimpy Point

Collapse
Posted by Roberto Mello on
It's awesome to see people interested in improving our documentation!
I sure hope we can continue this effort. Writing the 3.x documentation
was pretty much a lonely job as the community was small, but now that
the community grew (and the ACS Tcl community "moved" to OpenACS) I am
psyched to see this level of interest, not only in documentation, but
the whole system!

My worry on letting the documentation being dynamic is the quality.
It'd be hard for me to keep revisiting the docs if they were
world-writable (e.g. Wiki) and keep track of who and what was changed,
then rollback bad changes. I don't want to do that. If someone is
really interested in contributing a piece for the docs, I don't see
how writing a text file and sending to the person in charge can be
that hard.

There are bugs in docs, just like software, but unlike software (at
least web apps where you can just fix a file) it's harder to patch
because you have to regenerate it, etc.

Now, for quickly building documentation that doesn't yet exist, then
it can be a good thing, as long as someone lays out an outline of
what's to be written (e.g. slides in a Wimpy presentation).

As for current docs, adding a comments feature like PHP's or
postgresql.org/idocs should be pretty easy either using the general
comments module or a slightly modified version of the same.

BUT, if, when a person suggests a modification to the docs, that would
actually cause a ticket with a diff generated on the fly to be
submitted to the SDM, now THAT would be cool. Because then I could
easily track who and what the modification is. What do people think?
If somebody would like to code this up (and it should be fairly
simple), go for it! :)