Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) 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:

  1. What is the primary purpose of this module?:
    • Common answer A
    • Common answer B
    • Common answer C
    • Recent answer A
    • Recent answer B
    • Recent answer C
    • Enter your own

  2. "What are the core features of this module?"
  3. "Is the language of this module easy to follow?"
  4. Etc.

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."

In reply to Re: Perldocs and peer reviews by Ardemus
in thread 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 cooling their heels in the Monastery: (4)
As of 2024-03-29 14:58 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found