No such thing as a small change | |
PerlMonks |
How to lay out POD documentation for multi-faceted appsby stevieb (Canon) |
on Apr 02, 2017 at 22:31 UTC ( [id://1186756]=perlmeditation: print w/replies, xml ) | Need Help?? |
Take Test::BrewBuild for instance. There are three included binaries (well, scripts) that accompany the various modules that make up the distribution, but it may not be clear to a user which one to read first. When you search CPAN for the distribution, it automatically loads the POD file for the main API module, in which I redirect users to read another doc if they are not looking to use the API directly. What type of approaches do I have here. Should I hijack the main module's POD with the main binary's POD, and redirect to the other ones from there? What have others done in these situations, and as an end-user, what would you like to be presented with on a first glance after clicking on a search result? update: note that the first entry in the Changes file in the link above has been rectified, as I updated berrybrew late last week. Updating berrybrew rids one of the win10 issue. /update
Back to
Meditations
|
|