...slow clap with misty eyes...

FINALLY, someone said it. I don't know how many times I can read documentation and still not have a flipping clue how to start. And documentation without any example code at all? I'm sure the author is extremely brilliant, but if I don't know how to use the module, it doesn't matter. It ain't getting installed.

Next pet peeve would be modules requiring an extensive installation process without any documentation besides the copy/pasted ./configure; make; make install in the README. You know the ones. The ones that require jumping on your left foot backwards 7 steps under a harvest moon at midnight in a cemetery before they'll install correctly. I've been coding in perl for about 10 years and I DREAD a new module.

...Finally in desperation, pleading to the blessed holy monks for help. Only to receive the answer: "It's in the documentation."

...sigh...

In reply to Re: The problem of documenting complex modules. by ksublondie
in thread The problem of documenting complex modules. by BrowserUk

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.