Two points from Perl Best Practices (Documentation section) you might want to contemplate:

Personally, I dislike intermingling POD with code. Documentation of code is for programmers, so I use simple Perl comments (not POD) for that, right by the code it is documenting. Makes it easier to update the comments in step with the code.

Technical documentation of the system architecture (not the code) I place in a single large POD documentation section at the end of the file, or in a separate file.

User documentation should be kept separate from technical documentation. For that, I suggest either a separate POD file (or a big POD block at the end of the source file) ... or simply a Usage subroutine displayed when the user enters --help at the command line, making the user documentation more discoverable and more likely to be read.

See also:

In reply to Re: [RFC] Review of module code and POD (Doco) by eyepopslikeamosquito
in thread [RFC] Review of module code and POD by Bod

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.