Beefy Boxes and Bandwidth Generously Provided by pair Networks
more useful options
 
PerlMonks  

Re: Please for the love of god, can I get a documentation format that doesn't suck?

by raptnor2 (Beadle)
on Sep 10, 2005 at 14:53 UTC ( #490903=note: print w/ replies, xml ) Need Help??


in reply to Please for the love of god, can I get a documentation format that doesn't suck?

The problem won't go away if we use XML over POD. Both formats are display orientated, not data oriented. XML doesn't have to be, but in this context it is. There are other ways to do do this. We, the community, could impose a standard, which won't work. We could also build on the POD test suites.

I actually discovered these last weekend after using Module::Starter::PBP for the fist time. All the sudden I had 14 failues. Once I figured out that there were POD test suites in there, I got the motivation to finish up my documentation.

Test driven development works for developers because we can see what we have accomplished, and what we have left to do. In fact tests help us remember that we're not done yet. The same works for a certain class of POD, too. Why not extend it?

Cheers,

John


Comment on Re: Please for the love of god, can I get a documentation format that doesn't suck?

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others about the Monastery: (6)
As of 2014-07-10 23:42 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    When choosing user names for websites, I prefer to use:








    Results (217 votes), past polls