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

Re: On providing documentation with your modules

by leira (Monk)
on Apr 17, 2004 at 05:27 UTC ( #345940=note: print w/replies, xml ) Need Help??


in reply to On providing documentation with your modules

I think you definitely shouldn't copy and paste, because duplicating documentation, like duplicating code, can lead to a maintenance nightmare. You'd need to keep abreast of changes, and keep things updated, and I'm sure you don't want to do that.

I'd suggest that you make it clear in your own POD that extensive documentation is available elsewhere, and where it can be found. Provide links to this other documentation, so that those viewing the documentation in a format where these links are useful (like on the CPAN web site) can easily get to the other documentation without rummaging.

Linda

  • Comment on Re: On providing documentation with your modules

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://345940]
help
Chatterbox?
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (5)
As of 2016-12-11 13:18 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    On a regular basis, I'm most likely to spy upon:













    Results (169 votes). Check out past polls.