Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked

Re: Preferred method of documentation?

by l3nz (Friar)
on Oct 07, 2004 at 06:27 UTC ( #397236=note: print w/replies, xml ) Need Help??

in reply to Preferred method of documentation?

I more or less agree with what has been said in this thread; thchnical documentation is definitely important (and I'd use POD, so you get nicely formatted document in no time).

What usually lacks in other peopole docs is the "why": you find a lot of information on all possible API calls but very few on why the module was developed and on the general problem space it was trying to solve.

Simple quick-and-dirty usage examples also help get started. (For a good exaple of documentation, see the LWP cookbook - firts you get started, then you read the docs when you try to do fancier things).

Simple things should be easy, and documentation should help.

Log In?

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://397236]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others scrutinizing the Monastery: (5)
As of 2022-08-07 19:08 GMT
Find Nodes?
    Voting Booth?

    No recent polls found