Clinton,
At OpenSymphony a lot of projects,
including WebWork, use Confluence for documentation. We found the best practice
is to export the documentation to HTML and PDF just before every release and
then include those _exported_
pages on the website. This basically “tags” the documents so the
wiki can keep evolving, even during large product changes.
_________________
Patrick Lightbody
Professional Services
Jive Software
[EMAIL PROTECTED]
www.jivesoftware.com
317 SW Alder, Ste 500
Portland, OR
97204
ph (503) 295-6552
fx (503) 961-1047
From: Clinton Begin [mailto:[EMAIL PROTECTED]
Sent: Tuesday, September 27, 2005
9:18 AM
To: user-java@ibatis.apache.org;
Dan Bradley
Subject: Re: Quetion about
documents
What if we ditched the documentation altogether and started using the wiki as
our primary documentation?
* We could update it quicker and easier
* Anyone could update it
* Confluence has a PDF export feature
Thoughts?
Clinton
On 9/27/05, Dan
Bradley <[EMAIL PROTECTED]>
wrote:
A couple suggestions that I think would really help on the
documentation front:
1) Take all the documentation that's currently available only in PDF
and make it also available in an HTML format
2) Host the current API javadocs online
And then, of course, more user participation in the Wiki. Replacing or
supplementing the mailing list with forums would also be nice.
I've been able to discover most of what I've needed about iBATIS so
far, but the above changes would have made it a lot easier.
On 9/27/05, Farsi, Reza <[EMAIL PROTECTED]>
wrote:
> Hi all,
>
> I've been working with iBATIS and find it very good. The documentation
> has not the same high quality like the framework. I wonder if there is
> any document like e.g. iBATIS best practices.
>
> I'm reading the Developer Guide (DevGuide.pdf). I miss figure 1 on page
> three. Is it a converting problem (doc2pdf)?
>
> Regards
> Reza
>
