Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl-Sensitive Sunglasses

Re: Preferred method of documentation?

by dragonchild (Archbishop)
on Oct 05, 2004 at 21:55 UTC ( #396788=note: print w/replies, xml ) Need Help??

in reply to Preferred method of documentation?

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:

  • What requirements does this satisfy?
  • What were the architecture choices? Why was this one chosen?
  • What is the API? If possible, who uses the API? How much of the API is inviolable?
  • What are the assumptions? Preconditions and postconditions are an excellent way of putting it.
  • What were the implementation choices? What was this one chosen?
  • Most importantly, where are you going with this? What are the intended future directions? Why?
  • What tests does this pass? How are the tests run? How often?
  • What is the build process? How is the build run? How often?

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.
Being unknowing, is not the same as being stupid.
Expressing a contrary opinion, whether to the individual or the group, is more often a sign of deeper thought than of cantankerous belligerence.
Do not mistake your goals as the only goals; your opinion as the only opinion; your confidence as correctness. Saying you know better is not the same as explaining you know better.

Replies are listed 'Best First'.
Re^2: Preferred method of documentation?
by knowmad (Monk) on Oct 08, 2004 at 13:29 UTC

    Nice post dragonchild. For large applications that need this kind of documentation, I've found the ReadySET templates to be quite helpful. The project provides html templates for all of the questions you ask and more.

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others musing on the Monastery: (None)
    As of 2021-10-20 05:01 GMT
    Find Nodes?
      Voting Booth?
      My first memorable Perl project was:

      Results (78 votes). Check out past polls.