I am very happy with the documentation that comes with perl. It is an excellent format and reference for perl without the fluff. In fact, last week I began making standard POD templates for the documentation we use in my department.

One of the exceptional features of perldoc that sets it apart from the crowd is simplicity and integration. It's very nice to write in-line formatted documentation and be able to translate that into other formats (i.e. html). Granted, before that, our documentation structure consisted of a box of sand and a stick... but... you get the idea. I have not experienced any of the POD modules yet, but I'm sure they are just as intriguing.

Scott Saddison

in a perfect world, all the servers are UNIX.

In reply to RE: The sad state of Perl documentation by ScottSaddison
in thread The sad state of Perl documentation by SuperCruncher

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.