In a previous thread Tanktalus suggested breaking the documentation up more so that the element documentation doesn't collide with the twig documentation and so on. The reply mentioned the tension between searching multiple places for information and being overwelmed by a huge document with the author's inclination falling on the side of one large searchable document.
I understand that viewpoint, however I'd be inclined to split the document up and add an overview document with links to the main documentation for each part. A number of improvements can then be made:
- fuller description of individual functions
- more example material can be added
- preferred function names should provide full documentation for the function
- function documentation provides a full list of aliases
- function aliases simply link to the section for the preferred name
- the overview document lists all members and provides links but no further function documentation
- a fully worked examples document that uses current examples plus answers provided to common SoPW questions (links to the questions would be really cool)
Having the documentation available offline is important for those times you are working offline and need some help. A web based tutorial is fine, but is not a substitute for good POD documentation.
I'm available to help refactor and proof edit the XML::Twig documentation if required.
DWIM is Perl's answer to Gödel
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.