|Perl Monk, Perl Meditation|
Re: Perldocs and peer reviewsby Ardemus (Beadle)
|on Feb 02, 2005 at 18:26 UTC||Need Help??|
My comment here is a good example of people's concerns. I read the comments and I have an opinion. However, I have never written a POD or a module.
A full knowledge of a subject often changes my opinion of it. Take the American Electoral Colledge. Once I read about the history and reasoning behind the system, I reversed my opinions on it's validity. I think that far too many people strongly believe their uneducated opinions.
That said, I support the *idea* of documentation review. I suggest that documentation should make the module's purpose clear. The idea that using the module will clarify the documentation seems backwards. On the other hand, the mechanical details may be best learned hands on, with the docs as a guide.
Perhaps a simple questionaire would be appropriate / helpful. Asking questions like:
This could be aggregated into a format that is easy for authors to review.
In any case, just brainstorming.
Ardemus - "This, right now, is our lives."