in reply to Re: Our documentation sucks
in thread Our documentation sucks
Not everyone can write good documentation just like not everyone can write good code. And just because someone can write good code doesn't mean that they can document it well.
++ just for that quote!
I don't think the need is for Yet Another Documentation Protocol, but simply for better and more consistent use of the current protocol.
I agree. Personally, I think the synopsis ought to show at least some cases, not be a dumb list of how the constructor works and what methods can be called.
More generally, I think the standard is for people write cookbooks that give more in depth use-cases.
Of course, it helps if the main Pod mentions that a cookbook exists, too.
-xdg
Code written by xdg and posted on PerlMonks is public domain. It is provided as is with no warranties, express or implied, of any kind. Posted code may not have been tested. Use of posted code is at your own risk.
|
---|