[pmwiki-users] suggestion for continuously improving PmWiki documentation

[Neil Herber]

I have asked a ton of questions on this list, and received a ton and a half 
of really good answers. Thanks to all!

I was trying to come up with a way of recording the Q+As on my wiki so that 
I could refer to them without trawling through my emails. But then an even 
better idea struck me (well, I think it is a good idea).

What if everyone who posed a question here and got an answer went into 
PmWiki.org and added a concise version of the exchange to the bottom of the 
appropriate documentation page?

What is the appropriate page? The one where you expected to find the answer 
and didn't, or the one that caused you confusion.

What is appropriate to put on such a page? Additional explanations, or 
usage examples, or exceptions to general rules.

I don't think it will help future users of the documentation to put in 
feature requests - they belong in PITS. It might be appropriate to put in 
references to PITS, such as "A user-based authorization feature has been 
requested in PITS:00010".

By having the questioner add the text, we will off-load Patrick, and we 
won't overload any one individual.

Some people may ask "Why not just change the documentation on the page? It 
is a Wiki!". My answer is, on some pages, that makes perfect sense, but on 
pages where I can barely understand what is going on, I am not comfortable 
trying to edit the text. I would much rather add a comment that says " This 
feature confused me, but by adding "xxx" to my config.php, I got it to 
work." Then someone who does understand the feature can incorporate the 
comments into the docs.

Any takers? Is this a bad idea? Is this how it works now, and I just 
haven't figured it out?


Neil

Neil Herber
Corporate info at http://www.eton.ca/
Eton Systems, 15 Pinepoint Drive, Nepean, ON, Canada K2H 6B1
Tel: (613) 829-4668