You see, that's my issue. I feel that the CPAN people who accept module submissions should 'raise the bar' on documentation requirements. That way, if you are looking at a module on CPAN, you get at least a certain quality of documentation.

The proposition that author(s) do not have the time to write documentation but do have time to write a module is silly. I would say the ratio of code to documentation is 10:1 (for every 10 hours coding you would probably use < 1 hour documenting). Tell me if I am wrong.

The benefit to improving standards is pretty obvious. Documentation and tutorials are not the same thing! I would be happy to write a tutorial which highlights certain interesting features of a module, but documenting every single feature is boring and tedious, which is probably why the original authors fail to do it. But since somebody has to do it and noone is probably better at it than the author I think the standard for CPAN submission should be in place.

Celebrate Intellectual Diversity

In reply to Re: Re: CPAN documentation improvements by InfiniteSilence
in thread CPAN documentation improvements by InfiniteSilence

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


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.