This is just to keep you up-to-date to what I'm doing. Ideas and suggestions are most welcome.
I've finished porting the 5.1 reference documentation and the cookbok to confluence. This was a matter of using a doxia converter and some additional regexps to clean up things. Importing the stuff into confluence had to be done manually though.
I'm now investigating how to keep the documentation in sync with our releases so that people interested in the current documentation, the documentation for a specific version and people interested in the differences between two versions all find what they need. My initial idea was that we could do with some macros that mark parts of the documentation as deprecated or add a "since" information to it. I fear that this will make the documentation unreadable though as features are added, changed and removed. People looking for documentation on a specific version will have to ignore the parts talking about deprecation or addition of features not applicable to their version of the product. Or we have to support that by hiding the unnecessary information by means of javascript or something. All that is cumbersome to the reader though.
An easier approach would be to not put the reference documentation into confluence but maintain it in svn where it would live the same lifecycle as the product itself. This will make it a bit harder to maintain for the documentation authors though.
Right now I am favouring the second approach where we put the reference documentation (i.e. the user guide) into svn and have tutorials and cookbook articles in confluence. I will work on that in the next days.
Cheers, Uli --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
