Perl-Sensitive Sunglasses | |
PerlMonks |
Re: Preferred method of documentation?by dragonchild (Archbishop) |
on Oct 05, 2004 at 21:55 UTC ( [id://396788]=note: print w/replies, xml ) | Need Help?? |
Documentation comes in two flavors - developer docs and user docs. For library-type code, like CGI or DBI, they may be more similar than, say, for Template or Mason.
User docs are the easy one, conceptually. You need to do something similar to Microsoft's helpfiles. Whatever you may feel about their products or practices, they are really good in their docs, for the average user. Developer docs are more specific. I would want to know the following:
These are all the same questions you would ask if you were handed 1200 lines of code and told "Make XYZ changes to it". Being right, does not endow the right to be rude; politeness costs nothing.
In Section
Meditations
|
|