Your skill will accomplish what the force of many cannot |
|
PerlMonks |
Re: The problem of documenting complex modules.by ksublondie (Friar) |
on Jul 07, 2015 at 17:45 UTC ( [id://1133581]=note: print w/replies, xml ) | Need Help?? |
...slow clap with misty eyes...
FINALLY, someone said it. I don't know how many times I can read documentation and still not have a flipping clue how to start. And documentation without any example code at all? I'm sure the author is extremely brilliant, but if I don't know how to use the module, it doesn't matter. It ain't getting installed. Next pet peeve would be modules requiring an extensive installation process without any documentation besides the copy/pasted ./configure; make; make install in the README. You know the ones. The ones that require jumping on your left foot backwards 7 steps under a harvest moon at midnight in a cemetery before they'll install correctly. I've been coding in perl for about 10 years and I DREAD a new module. ...Finally in desperation, pleading to the blessed holy monks for help. Only to receive the answer: "It's in the documentation." ...sigh...
In Section
Meditations
|
|