Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re: good examples of POD documentation

by jplindstrom (Monsignor)
on Mar 06, 2009 at 14:24 UTC ( #748867=note: print w/replies, xml ) Need Help??


in reply to good examples of POD documentation

Who is the audience for the documentation?

  • Is it a programmer who needs to learn how to use the module and call it from their own programs?
  • Or is it a programmer (you / your team mates) who needs to know how it works so they can work with and extend the code?

These two audiences have two quite different needs.

/J

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://748867]
help
Chatterbox?
[marto]: pointing out the advantages of cpan modules is well worth in, as both developer and $client/$company benefit greatly
[Tux]: $src =~ m{^(.*),(.*)$/ and $2 !~ $valid and $src = $1;
[Tux]: s,/,},

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (9)
As of 2018-05-27 10:51 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    Notices?