Re: CMS / revision control system for sharing topics across versions?

Subject: Re: CMS / revision control system for sharing topics across versions?
From: Chris Gooch <chris -dot- gooch -at- rocketmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 18 Dec 2011 12:48:15 +0000 (GMT)

> Is anybody using a CMS or revision control system to share XML or
> XHTML topics across document versions?
>
> For example, say we have customers using versions 5.0, 5.1, and 6.0 of
> an application. When a topic is the same in all three versions of the
> doc, I'd like to have a single shared topic file so I could make a
> correction or addition once and generate updated docs for all three
> versions. 


Any regular revision control system (perforce, subversion, git, cvs, rcs)
can do this. Create a branch of the whole thing each time you do a release,
then you can make changes in each branch as needed. If the change is
needed in more than one branch, make the change once and integrate (merge)
it into the other branches using the version control system's merge tool.

I've always used the same version control system as the developers at the
places I work - I don't see why everyone wouldn't do this. Version control
didn't always work so well with binary files, compared to the versioning
within authoring tools, but now everything is XML, and that works well.
Even if you can't easily read the difference between two versions of an
XML file in your version tool (subversion say), you can always view them
both in the authoring tool if need be, Some authoring tools have extra
functionality to allow them to integrate with certain revision control tools
via the authoring tool's GUI, if that's important to you.

I recommend everyone who works with software developers to go and
talk to them about their version control tools and practices. They probably
solved this issue a long time ago (no that it will stop them arguing about
the best tool to use of course...)

Chris Gooch.

Freelance Technical Writer / Software Developer
Sheffield, UK.
http://uk.linkedin.com/pub/christopher-gooch/17/865/97a ;
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: the Hadoop comic
Next by Author: Re: Linked-In Problem
Previous by Thread: RE: Single H2 or H3 headings
Next by Thread: RE: CMS / revision control system for sharing topics across versions?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads