I've gotten requests for a "quick-start" guide, which I plan to add. I also plan to add a FAQ and/or a "how-to" guide for common questions and tasks.

My baseline for any release is 100% complete reference documentation, meaning every method and all its options are documented. For people who learn best from reference-style documentation, this is extremely helpful. Worst case, someone can post to the mailing list and I can point out which part of the documentation to read.

But with a very big, feature-rich module, it's hard for some people to find a "way in," so to speak. The existing tutorial was my first step towards helping with that, providing a narrative-style exploration of the major features as well as examples of best practices. I think the quick-start guide will be next.

If anyone has any more suggestions, just email me or post to the mailing list

In reply to Re^3: Class::DBI vs. DBIx::Class by siracusa
in thread Class::DBI vs. DBIx::Class by hrr

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.