Wiki and docs in cvs

Bill Hacker wbh at conducive.org
Mon Apr 4 14:30:56 PDT 2005


justin at xxxxxxxxxxxxxxxxxx wrote:

The hard parts with writing docs are getting started, keeping the
momentum going,
and having a ready environment to encourage a contribution when time and
mood permit.


That's a general concept.  You could say the same thing about code, but
this week's bugfix-only time isn't hurting anything, for instance.
If we don't have known, planned periods for cleanup, what other quality
checks can we put in?  There's no review process before something's added.
I'm not sure we actually have a formal review process on the Wikified 
docs *at all*,
(pre or post)... and we should.

But reviewing is (generally) a slightly different skillset than the 
writing, and I don't even know if the toolset we are using makes a 
submit/approve process easy or difficult.

Going forward, we need both the mechanism, (probably easy) and the 
assigned role-players.
That may be harder to satisfy if the best (only?) qualified reviewers 
have to stop coding to peruse submissions.

No easy answers here, just a belief that shortage of docs is presently 
more of a problem than syncing what we do have.

Bill






More information about the Docs mailing list