| Using Author-it Variants for Multi-release Software Documentation |
|
|
| Written by Hamish |
| Sunday, 08 February 2009 03:01 |
|
Many software products have multiple supported releases deployed on customer sites. Documentation teams are often required to maintain documentation for all supported releases If you use this solution, please register for updates. [Update: 2009-12-17] Updated document with information about removing older releases and an FAQ. [Update: 2010-03-10] Updated 'Removing old releases' section with information about re-indexing the search and using release states to track the variants to be removed. |
| Last Updated on Wednesday, 10 March 2010 12:10 |
Comments
What a great document. You've explained the situation very well. I've been thinking about this for 2 days and I probably would have never figured this out.
I appreciate your posting this document.
Great document. Very helpful indeed. I am curious though as to how multiple products with multiple releases might work. For example, we have about 9 products all with there own release numbers. So we would have Release 11.7 & 11.8 with priority 1 & 2 and Release 10.3 & 10.4 with priority 1 & 2 and so on. Do you know if they would work independently of each other?
I have a couple of clients using this solution, and for the most part it's working pretty well. However, one of them has a question about localization using this approach.
Their issue is that they need to be able to maintain the variant structure in their target libraries. But since the latest release is always the primary object, it's always going to overwrite the previous translated object (which should now map to a variant with a different object code in the source library).
Have you encountered this scenario? Do you have any thoughts on how to work around this?
The only approaches I can think of are highly manual: copying content from topic to topic in each target library as variants are updated, or using XML publishing to create archives for each release (again in every target library).
Am I making sense?