I'll chime in on this thread finally.

"Let’s write a response that we will still be proud of, decades hence."

One of the oldest responses on the Internet is "RTFM", no matter how you slice it. It's also the most realistic response to anyone who is having an issue when it has been proven that the docs clearly portray how something should be done.

Now, I am in agreement with others that if the docs are followed but are either inaccurate, ambiguous or otherwise confusing, ask a question about it, and, I'm in agreement with sometimes you just need a quick answer so ask it (Rubber Duck Debugging), but I do not agree with asking questions when one has the time to read the docs thoroughly but don't. That don't go over too well.

As a (what I like to think as a somewhat) prolific software author amongst a few languages who is vehement on keeping documentation as accurate, legible and understandable as possible, I want to know when my docs aren't portraying the usage of the API or binary I've written so that it is completely understood. It takes me as long, or even longer to write my usage documentation than it does to write the code, and oftentimes longer than writing the code and tests combined.

When one has time to take a few moments to read the docs, then say they were scanned (without actually testing what the doc says) is actually an insult to any software writer who takes the time to write really decent documentation.

RTFM

In reply to Re^2: RTFM!!!!! (but if you didn't, no biggie) by stevieb
in thread RTFM!!!!! (but if you didn't, no biggie) by nysus

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.