Best Practices - Copying Projects for New Versions

[CherylN]

Currently, we have several software user guides that we maintain for the software we write. When we create a new version of the software, we update the guides to that version. I am new to Flare and have created some guides for a specific version of the software. We have since created a new version. The version number is incorporated in the Flare Project. What is the best method of copying the guides to retain the original information, create a new version and make additional changes to the topic? The guides do not use any Source Control software.

I have tried copying from one folder to another, but can't change the name of the Guide. I have also created a folder and imported the original guide. Is this the best method.

What have other people done? Thanks.

Cheryl

[LTinker68]

If you're not using source control, then perhaps the best method is to zip the entire project and save the zipped file to a network file share and append the software version number in the file name. For example, "yoursoftwarehelp_rev3.zip". You could leave out the Analysis folder if you want. Some would say you could leave out the Output folder, too, since you can rebuild the output at any time, but if you just want to look at what you've outputted before, then including the Output folder saves you the trouble of unzipping the project and building the output.

[CherylN]

Thank you for the tip. I didn't need to zip the files, so I copied the Content, Project, and .flprj file. Then I renamed the .flprj file, opened it up and created the output. So far it seems to have worked and was an easier solution than importing the file.

Thanks.
Cheryl

[gnatster]

One thing that is very helpful is to make the product and version number into a snippet. In the updated version just change that snippet and apply. All references to the name and version are then changed in one fell swoop.

[CherylN]

That's a great idea. I've setup a Global Project with several sub projects that get changed with each version. I've used a snippet in the Webhelp footer, but didn't think of using it in those terms. Thanks for the tip.

Cheryl

[gmel999]

Cheryl,
If I am doing a version update for one of my products, I create a zip of the finished version and archive the project for that version, marked as "FINAL." Then, I continue using the same project and revise it for the next version -- no copying needed. If I start a brand-new project, I use our Flare project template folder as the starting point, copying that to wherever it belongs in the filesystem and renaming components as needed.
Regards,
Mel