the first step to a good POD is a good template (e.g. Module::Starter::PBP).

the second step is a good, intuitive API. if your API is good, a useful (meaning not too long and covering enough to start using your module) SYNOPIS section should be possible. I always look at that example code and then search for the functions I need.

Explain that functions in detail: the parameters, return values and exceptions. Your question was probably how to do that right? It is not important as long as you write it down in a clear and consitent way. Maybe look at mature modules like DBI, CGI. Provide example(s). If the examples section for a function needs to be long to cover all functionality, you should probably refactor your code.

In reply to Re: POD conventions by lima1
in thread POD conventions by eff_i_g

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.