That really depends on what you mean by good.

Module POD is traditionally modelled after Unix 'man' pages: a terse synopsis to remind you of common usage forms; followed by a comprehensive reference section detailing options, method names and arguments, object models if appropriate, etc; and possibly some examples to close. From memory, the DBI documentation is a pretty good example of this genre (it's certainly comprehensive).

Unfortunately, someone looking for tutorial-style material to get them started in unfamiliar territory is not likely to find this 'good'. The best documented distributions often have an 'Intro' document in addition to the reference docs. The Intro.pod document from the XML::SAX distribution is a good example. Perl also comes with a number of tutorial man pages like 'perlreftut' and 'perltoot'


In reply to Re: Looking for Mr. Good Documentation! by grantm
in thread Looking for Mr. Good Documentation! by hsmyers

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.