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

Re^2: Our documentation sucks

by j3 (Friar)
on Apr 13, 2007 at 15:15 UTC ( #609952=note: print w/replies, xml ) Need Help??

in reply to Re: Our documentation sucks
in thread Our documentation sucks

I agree jhourcle, but just to make things more concrete:

  1. The docs for your module's users go in your module's POD. I like xdg's suggestion of including a separate cookbook.pod as well. A tutorial.pod can be included too (since the main module's POD is sometimes more of a user's reference manual than a tutorial).
  2. The docs for maintainers (or advanced users who might want to tinker) just go into the code as regular comments, since maintainers will already be looking at the code anyway.

And actually, there's a third kind of documentation that you might provide: A design doc. This can go in a separate design.pod file.

I think of it this way:

  • As a new user, I'll read the tutorial to learn to use the module.
  • As a novice, I'll use the cookbook and reference manual as-needed.
  • As an advanced user, I'll dig into the module's code and will be grateful to read the comments therein.
  • As any of the above I might want to read the design doc to get a better idea of how the module was put together (which objects/functions use which), why you made the design choices you did, how I might go about extending it (say, with a plug-in), etc.

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others chanting in the Monastery: (6)
As of 2018-04-26 21:51 GMT
Find Nodes?
    Voting Booth?