[documentation] Real newbie documentation

Gunnar Langemark gunnar at langemark.com
Sun Jan 8 07:42:32 UTC 2006


Maybe the real problem is the assymmetry of the setup. In a wiki 
everybody can edit. (no I'm not really suggesting a wiki but maybe a 
different set of editing rights) - so the quality of the document will 
(in most cases) improve by the edit. Here we're just stacking up piles 
of editing waiting for an editor to do.

The workflow should be: Someone asks a questions - someone answers and 
makes the edit to the page, so it reflects the new information.

But one note of caution: It is not a good idea to include all possible 
situations in the documentation - especially not in the newbie docs. 
That would just add to the confusion.

Best
Gunnar

Laura Scott wrote:
> I agree with Kieran that the problem is that the comments often have 
> the best info. It would be nice to be able to change the page, but who 
> has that permission? I don't. All I can do is post a comment there on 
> the page. If I have to go post a correction somewhere else, then the 
> next person is not going to see the correction or variant I and others 
> have contributed because they're lost in some forum thread. I believe 
> we want to concentrate and clarify the documentation, not scatter the 
> feedback to it.




More information about the documentation mailing list