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'
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|