Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
I think I would move points 3 and 4 up to the top of the list - I guess they are what you want anyone to do first. I'm not sure about use diagnostics; versus use warnings; I suppose it all depends on your level.
General comments:
The document asks rather than demands.. which is the polite thing to do. But if the purpose is to reduce the number of posts that ask questions that have well-known answers, and to reduce the number of posts that don't provide sufficient info in the first instance - then perhaps the document should be more authoritative. Human nature being what it is - people will probably not look at all the recommended links, they will skim the document and then post. Maybe start with something along the lines of:
Before posting ask yourself the following questions
- is the question already covered in the FAQs?
- am I using strict and warnings?
- have I supplied enough code and data so that it is clear what I'm doing?
etc...
Each question would have the appropriate links - I'm sure that others more skilled in this sort of thing could improve the phrasing - the aim being to be authoritative and friendly/encouraging at the same time.

Update:
Has the idea of having an example question and answer been discussed? The question would illustrate all the good practices discussed in the main document e.g. what was trying to be done, what happened, code snippet included, use of HTML tags etc. The answer would show the sort of helpful reply that you get back!
*****Example:
I'm trying to count the number of times a file has a line with "foo" in it. The program looks like this:
while(<>) { $line = chomp; $count++ if ($line =~ /foo/); } print $count;
But when I run it I get:
Use of uninitialized value in print at ./test.pl line 8, <> line 3.
Can someone tell me what's going on?
*****End
For the simplest questions perhaps it would be possible to design a form that could be used?

In reply to Re: New Monks Info Page by Odud
in thread New Monks Info Page by tachyon

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!
  • 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, 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
  • Outside of code tags, you may need to use entities for some characters:
            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.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others drinking their drinks and smoking their pipes about the Monastery: (16)
    As of 2014-12-18 16:35 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      Is guessing a good strategy for surviving in the IT business?





      Results (58 votes), past polls