Please make a really good synopsis. The synopsis should be a small, self-contained, working program that shows off the functionality of the module.

When I evaluate modules, the synopsis is a productivity tool. I cut and paste the synopsis to create a small test program. Modules with a bug in the synopsis, or with a synopsis that doesn't show the strength of the module, have trouble getting my attention.

I first watched the pod-synopsis cut-and-paste technique used by a tremendously strong perl programmer during a perl programming competition. I have used it ever since.

Your challenge will be to come up with a synopsis that functions without having a known database to work with. So if you follow BUU's advice and test the install with a small test database, could you use this same database in your synopsis?

It should work perfectly the first time! - toma

In reply to Re: A First CPAN Odyssey by toma
in thread A First CPAN Odyssey by skyknight

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.