Make page narrow Make page wide    Green theme Blue theme Orange theme Red theme

baner
You are here:   Home > Author-it Resources > Tips and Tricks > Using Author-it Variants for Multi-release Software Documentation
large small default
Using Author-it Variants for Multi-release Software Documentation PDF Print
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

This document (1.3 MB) outlines one solution for using Author-it Variants (introduced in v5.1) for maintaining documentation for multiple releases of software.

Also, this document (0.25 MB) outlines some alternative solutions.

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.

Comments

Theresa Putkey
0
 
 
Hello Hamish,

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.
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
Hi Hamish,

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?

Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
John Hawkins
0
 
 
Hi Hamish,

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?
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
Essay Writers
0
 
 
Thanks for sharing these. We've been having difficulty figuring out Author-it so far.
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
First of all thanks a lot for the informative and useful information. I am very interested in all information about software so it was quite interesting and even useful to read this your post about this subject. The document which you have shared for us is really useful and I am so glad that I have found this your post. Well I will definitely bookmark your website because I see that your website is full of good information about various subjects. Thanks a lot one more time for the great post and I will be waiting for more great articles from you in the nearest future. Regards, Kevin Patton.
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
Damien5
0
 
 
Thanx, there always was a problem with documentation. Especialy while editing essay after classes.
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
editing essays
0
 
 
Thanx, there always was a problem with documentation. Especialy while editing essay after classes.
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
Rapidshare SE
0
 
 
Interesting! I've never heard about author-it varients.
Name *
Email (for verification and replies)
URL
ChronoComments by Joomla Professional Solutions
Submit Comment
Cancel
Name *
Email (for verification and replies)
URL
Submit Comment
Last Updated on Wednesday, 10 March 2010 12:10