All,

We all know we suck at writing docs, even though we have several book
authors in our midst.

There are some problems I see with maintaining a separate reference manual:
 - base format -> docbook is a nasty piece of work to write, latex is
somewhat better, word is not multi-user
 - recency -> the docs are pretty soon outdated.

If we are able to get a single point of definition, then that would be
a killer IMO.

It should be possible to generate a reference manual based on our
javadocs. If the descriptions for classes are written correctly we
only have to maintain the javadocs, and generate a pdf and website
based on that.

We don't have to generate the document for *all* classes, we can
create a ToC based on whatever classes we wish to include, and group
them in everyway we see fit. With maybe some extra javadoc annotations
we will be able to select particular methods that are of interest for
the reference manual, whilst ignoring the rest of them.

There are several doclets that allow you to generate PDF's, latex or
docbook as an output format. http://doclet.com is the cannonical list.

What do others think?

Martijn

-- 
Buy Wicket in Action: http://manning.com/dashorst
Apache Wicket 1.3.0-beta3 is released
Get it now: http://www.apache.org/dyn/closer.cgi/wicket/1.3.0-beta3/

Reply via email to