arcnon has asked for the wisdom of the Perl Monks concerning the following question:

is there a utility/module that will create a starter pod from a existing module?

Replies are listed 'Best First'.
Re: pod stub from module
by friedo (Prior) on Feb 20, 2006 at 22:43 UTC
    Module::Starter will set up some nice POD stubs for you, though I usually end up rewriting the whole thing anyway.
[reply]
Re: pod stub from module
by etm117 (Pilgrim) on Feb 21, 2006 at 02:16 UTC
    1. I would spend an hour and stub out a basic POD template that fits your needs. If this is for personal use, and not for use at work, skip to step 3.
    2. Send out POD template to co-workers, take their feedback, re-work. Rinse, later, repeat until you get their sign-off. (NOTE: this step may be impossible to complete, as you cannot cater to everyone. So in my book, majority (or the boss ;-) rules in this type of scenario)
    3. Save this template somewhere, preferably in a source control system.
    4. Set the template up as a macro in <insert editor here>
    5. Whenever starting a new script or module, you can run the macro and it gives you the core POD documentation you need with things like author and copyright filled in.

      At this point you have a re-usable template that fits your (or your team's) needs. For example, my team has a section for On-call support on what return-codes mean and another about whether a job is re-runnable or needs to have things staged (and what they are) to be re-run. This makes the on-call support's team's lives easier when they are awoken at 3am to fix a broken script.

[reply]

Back to Seekers of Perl Wisdom