Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked
 
PerlMonks  

Re^6: The problem of documenting complex modules.(Summation.)

by einhverfr (Friar)
on Jul 20, 2015 at 08:30 UTC ( [id://1135417]=note: print w/replies, xml ) Need Help??


in reply to Re^5: The problem of documenting complex modules.(Summation.)
in thread The problem of documenting complex modules.

That is, or should be, a different set of docs. Design documents make lousy user documentation.

I think it depends on the sort of module. Ideally, in my view, the user documentation should be at least a part of the design documentation. At very least it represents the contract as offered. If that is hard to document, you have design problems.

That doesn't mean that's all of the documentation, but my experience is that clear user documentation is a general indication of clear design (exception made for Microsoft Xenix).

  • Comment on Re^6: The problem of documenting complex modules.(Summation.)

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others cooling their heels in the Monastery: (6)
As of 2024-04-23 13:47 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found