Beefy Boxes and Bandwidth Generously Provided by pair Networks
Your skill will accomplish
what the force of many cannot
 
PerlMonks  

Re: Re: How to write documentation?

by zuqif (Hermit)
on Oct 18, 2001 at 14:36 UTC ( #119645=note: print w/replies, xml ) Need Help??


in reply to Re: How to write documentation?
in thread How to write documentation?

Just as an aside, I also subscribe to having the users write their own documentation.
This has numerous advantages:
  • They gleen a more formal understanding of your solution to the problem
  • Its more likely to be complete -> not missing 'coder-obvious' elements
  • Its 100% technical-jargon-free!
  • You dont have to do it yourself!
Of course, am sure you could generate a framework template from your code for them to fill in (:
the 'qif;

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://119645]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others studying the Monastery: (2)
As of 2021-11-27 03:27 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?