Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
With regard to this thread about CGI::Prototype, and this thread about 'non-serious' modules, the issue of code QA seems to be coming up quite a bit lately.

While there is a framework in place for testing and peer review of modules, fully testing a module can be a very time consuming undertaking. Once you have

  • Downloaded the module
  • Resolved the dependencies
  • Installed the module
  • Familiarised yourself with the purpose and interfaces
  • Written code to test out the module
  • Reported on any problems

You've put quite a lot of time and effort in.

As an alternative for those who don't have the available time, can I suggest a second tier of testing? It would take minutes only to briefly review the perldoc only of a module, and report back to the author where

  • the docs are unclear
  • the docs are incomplete or sketchy
  • the described syntax is nonintuitive or unfriendly
  • (any other appropriate guidance or suggestions...)

To skim through the docs for an average module on CPAN, without attempting to download, install and run the code, could take perhaps 15 minutes to half an hour. I think many more people could spare that amount of time to review new or amended modules.

At the very least, as well as improving the quality of documentation, it would be a second pair of eyes looking at the design assumptions, which can only be a help.

If anyone agrees, perhaps this would be a good place to discuss what specific elements to look for in a review?

Charles

Update: Several people have raised the concern that this potentially would result in low quality feedback from people who have not used a module and hence may not understand what it is seeking to do. I should stress that this suggestion is intended to widen the range of modules that get some kind of review, rather than add to the volume of feedback on mature & widely used modules.

The following notes would be my suggested starting point:

  • Only perform a POD review on modules that do not have a cpan rating
  • State at the beginning of any feedback that this is a POD review only
  • Only review modules that relate to an area in which you have some knowledge
  • Don't necessarily expect an answer, and do not follow up your communication unless invited to do so
  • Try to give suggestions rather than just criticism

VGhpcyBtZXNzYWdlIGludGVudGlvbmFsbHkgcG9pbnRsZXNz

In reply to Perldocs and peer reviews by g0n

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others romping around the Monastery: (1)
As of 2024-04-19 18:11 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found