Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
Trouble is, having a ton of documentation is not really useful if there's not enough introductory stuff. POE suffers from this. The way people use documentation, at least when starting out, is they want to ask "I have problem X, how do I solve it". The POE docs don't help here, they're just a reference - at least that was the case last time I looked. But a reference is only useful once you know what you're doing.

Last time I whined about this, Rocco said that he knew it was a problem and he'd be happy to accept any documentation I could write. Unfortunately there's a bootstrapping problem there - without having sufficient documentation I couldn't learn the product in any reasonable time scale and so couldn't write the documentation.

exim suffers from the same problem. I learnt exim not from the docs but by taking someone elses config file and hacking it until it Did The Right Thing. I tried to learn POE the same way - taking the test suite and trying to turn it into my application, but POE's just a wee bit too complicated for me to learn it that way ;-)


In reply to Re: Re: Documentation for POE? by DrHyde
in thread Documentation for POE? by sri

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others avoiding work at the Monastery: (4)
As of 2024-04-18 19:27 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found