One of the most critical areas of the documentation is the synopsis. It should be possible to cut and paste the entire synopsis and create a working program that shows the utility of the module. While the synopsis of Exporter::VA does compile, it doesn't stand alone as a useful program. The synopsis is the equivalent of a 'hello world' program in a new language and programming environment. Think of the module as a shrink-wrapped box, and the user wants to tear off the plastic and make it work as soon as possible. Perhaps the rest of the manual will be read later, after the initial frenzy is over.
The pod needs to include examples that actually work. Foo, bar, and baz have limited utility. I need to see an example in the pod of how your module improves the use of a real CPAN modules.
The $VERSION number is also unrealistic, given that the pod states that it has only been tested on AS/Windows. While perl code is remarkably portable, the idea that pure perl code will port with zero testing is unrealistic. A reasonable version number is perhaps 0.0121, not 1.21. Much of porting deals with installation and other issues that don't seem to have anything to do with the intended use of the code.
It should work perfectly the first time! - toma
In reply to Re: My module - my latest step
by toma
in thread My module - my latest step
by John M. Dlugosz
| For: | Use: | ||
| & | & | ||
| < | < | ||
| > | > | ||
| [ | [ | ||
| ] | ] |