And while I'm having ideas, a Maypole::Manual::OptionalModules might
be useful, with each module, and a one to two sentence description of
what's available for each one.
On 26 Sep 2005, at 20:39, Kieren Diment wrote:
...Thanks. Works a treat. Very obvious, but not clearly
documented. I think this offers a clue as to how the documentation
should evolve. Actually, I it needs to be refactored. How's this
for a putative structure:
Maypole::Manual (intro)
Maypole::Manual::Example::Simple (BeerDB)
Maypole::Manual::Example::LessSimple (maybe Simon's latest
example,updated, or something else)
Maypole::Manual::Application::Data (data storage)
Display
(data display)
Structure
(best practice in terms of subclassing out the app for maintainable
structure)
Cookbook
(including stuff like the OP)...
So a more modular documentation to ease maintainability.
I think the problem is that Simon Cozens is clearly a very talented
perl programmer, and a competent technical writer. I think,
documenting his own work, it tends to reflect the contents of his
own mind rather more than it should, i.e. too much assumed
knowledge about problems where the solution is not obvious.
Comments?
-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server.
Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP. Click here to play: http://sourceforge.net/geronimo.php
_______________________________________________
Maypole-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/maypole-devel
-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP. Click here to play: http://sourceforge.net/geronimo.php
_______________________________________________
Maypole-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/maypole-devel
