TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: Storing RTF documents in a code management system
Subject:RE: Storing RTF documents in a code management system From:"Rebecca Downey" <rdowney -at- matrox -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 30 May 2002 17:33:02 -0400
Hi.
> Has anyone used CVS or RCS as a repository for their documents?
Yes. We use it for all documentation and source code.
> If so, how has this worked for you?
Quite well actually.
> 1) Being able to easily check documents in and out
I either check in documents as
- DOC: These are checked in as binary.
- HTM: These are checked in as text.
- MIF: These are checked in as text.
> 2) Are you able to merge changes?
I use either MS Word or Adobe FrameMaker to compare changes, but I never
merge changes in a document.
Why?
I have to be able to track changes within a document and associate them back
to the editor who requested the change as well as the build in which it went
in. Allowing merges *might* cause a problem as to what information is
released.
So instead you check out the previous (or desired) version of the document
and use the source-program (FrameMaker or Word) to compare the two.
> 3) Controlling access of documents (which would really be a
> process we might be able to use)
We control access three ways:
- Through named check-ins (essentially any time someone checks in a document
they must log in. Once logged in, any file they check in has their name
attached to the revision) you can always track a change back to its maker.
- Through directory control (any OS can do this - controlling who has access
to which directory and what kind of access [Read, Read/Write, Modify,
Create...]
> 4) General feedback regarding the use of RTF documents in this
> manner?
Because we use DOC instead of RTF format, we are looking at moving all forms
of documentation over to XML. This would make things a lot easier in regards
to merging changes and save a lot of space on our servers.
Please do post a summary when you get enough posts.
This is a topic I'd really like to hear more about.
Thanks
-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
Rebecca Downey Senior Technical Writer
ITG:NBM Matrox Electronic System
1055 St Regis, Dorval, Quebec, H9P 2T4
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.