Hi Carlos, the only thing i can say is: Wiki. :)
I've found out that documentation is collaborative work and isn't done in one step. Therefore wiki is a perfect fit: One starts off with writing together some information, others add comment or organize that information. Wiki is the tool to make editing and re-editing really easy. At present, the problem with the wiki approach is that the documentation in Wiki syntax doesn't transform very well into other formats. To fix this, i've started working a Maven plugin in for Atlassians Confluence Wiki: It retrieves Wiki pages as listed in the project's navigation.xml and transforms them into XDocs. After that Maven's PDF plugin and the Xdoc plugin take over. My two cents, -Stefan > -----Original Message----- > From: Carlos Sanchez [mailto:[EMAIL PROTECTED] > Sent: Tuesday, September 07, 2004 7:15 PM > To: 'Maven Users List' > Subject: [Poll] Writing documentation with Maven > > > Hi all, > > I'd like to start a thread about how do you write your > documentation to be > integrated with Maven. Maybe I can give away some GMail > invites to those > participating, it's not much, but as you may know open source > doesn't pay > the bills, at least not MY bills ;-) > > 1. What format do you use to write documentation? > A. xdoc > B. html > C. docbook > D. latex > E. who needs documentation? > > 2. If you didn't choose A, how do you transform your doc to > be integrated in > a Maven powered site? > A. html2xdoc > B. docbook plugin > C. sdocbook plugin > D. latex plugin > E. other, please say what > F. I don't transform, only link to my docs > G. I write it again > > 4. What tool do you use to write the docs? > A. notepad / vi and similar > B. one that is not WYSIWYG (please say what) > C. a WYSIWYG editor (please say what) > D. an hex editor > > 3. Would you like to use another format instead of answered > in (1) and why? > > > Leave your name here if you'd like a Gmail invite. > > > Regards > > Carlos Sanchez > A Coruņa, Spain > http://www.jroller.com/page/carlossg/Weblog > > Oness Project > http://oness.sourceforge.net > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
