|
From: Alef A. \(JTeam\) <al...@jt...> - 2003-11-04 12:56:03
|
> What did you use to write this - a plain editor or something wysiwyg? I usually do this kind of stuff in a plain editor, but there are quite some editors out there... Also wysiwyg ones... > > > 1. Do we agree on having documentation based on DocBook? > > > > It seems to be a good choice if since we can generate both > pdf and html. I > assume there is an ant task so we can make this part of the > build. Have you > tried generating both pdf and html with a document that > includes graphics and > source code listings. Sometimes it's hard to get it to look > good in several > formats. Yup, there's some extra targets included in my local build.xml (docpdf, dochtml, dochtml-single), basically I ripped them from Hibernate. Works quite well... About the images and code-listings, I hjaven't had a look at that yet, will see if that works! > > 2. Are we going to aggregate all documentation in one sort of > > reference-manual (docbook allows us to publish it in HTML as well). > > > > I'd like to see a "Spring Users Guide" and separate tutorials > for "Bean > Container", MVC, JDBC, AOP etc. That seems reasonble. > Wiki does not seem to very popular - maybe it's beacuse the > one we have is not > that great. Somehow we should make it clear though what the > preferred channel > for support is - wiki, forums or mailing lists. Agree. Hibernate uses coWiki, which is quite powerful and can be used to maintain the website as well (the complete hib website is coWiki-based). Could be an option. Also to get more interaction with users, having to subscribe to a mailinglist gives people the creeps sometimes... But, we don't have to do this right now (or at all). I think we just have to keeps things like that in the back of our heads... > Could that be beacause you were doing accounting the week before this one. :-) Well, that's finished now, a couple of more shitty jobs to do, then back to development :) |