This is a question that have somewhat been asked before (i.e.: How to manage an

Question

This is a question that have somewhat been asked before (i.e.: How to manage an open source project's documentation). However, my question is a little different because:

We're not developing open source software, but proprietary software
The documentation has to be hand-written, because we do not want to publish the actual software API documentation, but only the public API documentation
I do want developers and project managers to write the documentation collaboratively
Obviously, wikis are a solution, but they're very generic. I'm looking for a more specialized tool for this job. I've looked around and found a few like Adobe Robohelp, SaaS solutions and such, but I'd like to know if any open source software exists for that purpose.

Do you know any Open Source Web-based CMS for writing and managing API and software documentation?

Explanation / Answer

If the solution not being OS isn't actually a deal breaker, I can very highly recommend Confluence.

We started using it in our team about 6-8 months ago and since then it's had a very high adoption rate. MUCH higher than the 2 or 3 purely OS wiki based systems we trialled before that.

We have found that it's easy to get to grips with, has a great wiki style syntax (or a very solid WYSIWYG editor if your team prefers that approach) and as David Freitas mentioned in the comments on your question, a 10-user license only costs $10 - and that whole $10 goes to charity too so everyone's a winner.

Related Questions

Navigate

• Browse (All)
• Browse T
• Subjects

Integrity-first tutoring: explanations and feedback only — we do not complete graded work. Learn more.