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
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:
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, 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, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||