Versioning of multiple PDF outputs in one project

This forum is for all Flare issues not related to any of the other categories.

Versioning of multiple PDF outputs in one project

Postby Tobias on Tue Sep 20, 2022 1:29 am

Hi,
I´m a new Flare user and currently the only technical author in our team. I create user manuals (PDF) for special purpose machinery. My current plan is to create one project that contains all user manuals. I´m writing one master manual an created a variable "Version", which I inserted e.g. into the title page.
For each of our machines sold I will have to modify some content and give each machine user manual its own version number.
Is there a best practise for managing the version numbers of the different user manuals?
Regards
Tobias
Tobias
Jr. Propeller Head
 
Posts: 1
Joined: Mon Sep 19, 2022 8:07 am

Re: Versioning of multiple PDF outputs in one project

Postby ajturnersurrey on Fri Sep 23, 2022 7:24 am

In that sort of situation I would use a target for each customer.

So, customer Joe gets the target 'Product X User Guide - Joe' initially at version v1.0 (set in the target). Joe's manual contains an extra topic about some special beta-test features that are only in his version of 'Product X User Guide'.
Customer Bob gets the target 'Product X User Guide - Bob' initially at version v1.0 (set in the target). This is a default version of 'Product X User Guide'.
... this way, when things change on those beta-test features you can easily come back make a change and rebuild and reissue Product X User Guide - Joe at version v1.1, without changing or reissuing Bob's version

The open question is whether you have all of these targets using one master TOC, and conditions on the topics, so that the right ones get included in each manual type, or whether you set up a separate TOC for each target. (In this case the beta-test features topic would be conditioned 'Joe only', and Bob's target would be set to exclude items conditioned 'Joe only'). That decision comes down to the complexity of your situtation. I think that using conditions with a single TOC can be the most slick. But if there are too many subtle variants this can get out of hand. In the face of too many options I would make fewer errors with one TOC per target.
ajturnersurrey
Sr. Propeller Head
 
Posts: 342
Joined: Fri Nov 05, 2010 3:30 am


Return to Flare's General Discussion

Who is online

Users browsing this forum: No registered users and 10 guests

cron