Eclipse Update URL:
https://download.inetsoftware.de/doqua/ (Eclipse 3.2 - 3.5)
i-net Doqua is an Eclipse Plugin. Add the installation URL to your Eclipse “
Manage Configuration ⇒
New Plugins” Dialog and get started right away.
i-net Doqua can also be downloaded as a standalone version. There are no other prequisites than a current Java installation.
i-net Doqua can be integrated into your JUnit testing environment. Create automated jobs to check your style and remind you to review certain documents.
What we do with Doqua is to supervise our internal documentation. Our developers are brave and very good in what they do. But they are all very different in style as well. To ensure the best all-together experience for our customers we use i-net Doqua to check the documentation on a regular basis using hudson/jenkins. This ensures high-quality documents with a clean HTML structure and a lot more.
…but your documentation tends to become outdated and the documents' styles tend to vary?
i-net Doqua can help to keep track of any inconsistencies between your style guide and the set of documents - it shows them, and even marks the lines where it thinks you will have to correct the content accordingly - so the writers are alerted that they have to follow your company style guide. You can also set certain documents as needing reviews every so often, and it will remind you to check the content.
Finally, you can preserve high quality standards for your documentation using JUnit test framework integration. If you do code reviews - why not do documentation reviews as well?