Jacek Laskowski wrote:
2006/1/23, Geir Magnusson Jr <[EMAIL PROTECTED]>:
I don't understand - The need for documentation under source control is
important, and we need to find a solution that ensure that is possible.
I think that a documentation system should be a combination of
- reasonably easy to use
- versionable
- able to be used offline
- extractable into an open and transformable format for reuse
Wikis that I've used fail on #2, #3 and #4.
Hi Geir,
Isn't it an issue for the whole Apache org?
Yes, but I don't think a lot of projects do documentation in wiki.
That's an interesting question to get real data for.
Haven't I seen some emails
about it on [EMAIL PROTECTED] recently? I think it's not only us who
straggle with the issue and I'd be very pleased to have some sort of
Confluence with SVN support so that content could be easily made
offline and committed to a repo *and* the the same time introduce
changes thru Confluence and have them checked into the repo, too.
Yep :)
I'm also curious about how in-code documentation can be integrated, via
something like Doxygen or -ish.
I don't know it at all. Do you have any insights on its features?
Something you know after having worked with it for a while?
I don't know it at all, but I've seen it used for _code_ documentation.
I think it would be lousy for general user doc that's not from code.
I realize the clear majority is for Confluence, but these factors should
be considered.
Absolutely! (but shame on me since I had not as I had voted).
Off looking for some information about Doxygen...
geir
--
Jacek Laskowski
http://www.laskowski.org.pl
