New Page 3

Klariti Home Page

Download Templates Online

About Us Free Tools Tips Templates Affiliates Site Map

MS Word template

4  x User Guide Templates - Instant Download
Download Now!


Using Version Control Software

Many IT Managers face the challenge of managing hundreds of files with several tech writers working on them at the same time.

For a Documentation Manager, there are several options available to remedy this.

Most use Microsoft SourceSafe, CVS or PVCS to manage this thorny process.

Creating IT Dept Guidelines

When it comes to version control procedures, the lack of formal guidelines is a serious issue for Publication departments; for example, there may be no "best practice" guidelines for "getting" versus "checking out" documents.

With certain software packages you can "get" a copy of a file in read-only mode and then make it write-able. This overrides the security "check out" feature of the system which can later prove counter-productive and create even more confusion.

Using Version Control to Checkout software and documents

Checkout procedures have several purposes:

1. They put a copy of the file on a local machine.
2. They lock the file; only the user who checked it out can check it back in.

This process protects your team from itself it alerts the rest of the team when someone is working on that file.

Version control software protects team members when two or more writers attempt to update a document simultaneously. Should this happen, they risk losing one writer's contribution, as the last saved version will overwrite the previous version.

Using CVS

CVS doesn't truly support a lock system. Instead, its default mode is a 'merging model'. You can use a lock system with CVS if you use the -L and -l options to the Admin command.

Multiple users can check out the same documents and then attempt to check them back in. When working in ASCII modes, such as HTML, this works fine as it will calculate your differences from the last version and apply them. Depending on your product version and platform, it can figure this out quite well.

However, if there is a conflict it will stop you checking files back in, and force you to manually reconcile the difference.

RCS and Microsoft SourceSafe offer locking.

Note: You can override the checkout lock, but use this in emergency situations only, e.g. when someone leaves the company and forgets to unlock their files.

When you override a lock, ensure that the locker has checked in the most recent version, or you'll lose the work.

Managing versions by product line

When preparing documentation plans, one approach is to delineate your documents based on product lines and give each writer their own set of files to manage. You then have to ensure that there are no files shared between products.

If you don't control this, you will end up with writers working on the same files, and everyone having copies of the files on their local drives to edit. Documents will clash when they are checked back in.

Needless to say, the larger the team, the more important a clearly defined source control procedure is followed.

Your Thoughts?

What are your thoughts on this? Drop me a line at ivan at klariti dot com


Biz Templates: Proposal Template  Project Management  Employee Handbook  Procedures Business Case Process Design

IT Templates: Software Development  Testing Templates  Training Plan  User Guide Change Management Plan

Sales Templates: White Paper Case Study Business Plan Marketing Plan Cost Benefit Analysis Action Plan

$ 9.99: Acceptance Test Plan  Design Document  Requirements  Test Plan  Feasibility Study Risk Management Plan


Ads

Follow me on Twitter  Facebook  YouTube

T e m p l a t e   S h o p


Software Development Templates

T e m p l a t e   S h o p

Acceptance Test Plan

Acquisition Plan

Action Plan

Audience Analysis

Availability Plan

Bill of Materials Template

Business Case

Business Continuity Plan

Business Plan

Business Process Design

Business Requirements

Business Rules

Capacity Plan

Case Study Templates

Change Management Plan

Communication Plan

Concept Proposal

Configuration Management Plan

Conversion Plan

Concept of Operations

Cost Benefit Analysis

Data Sheet Template

Database Design Document

Deployment Plan

Design Document

Disaster Recovery

Documentation Plan

Employee Handbook

Error Message Guide

Expression of Interest

Fact Sheet Template

Feasibility Study

FAQ Template

Functional Requirements

Grant Template

Installation Plan

Interface Control Document

Invitation To Tender

Maintenance Plan

Marketing Plan

Needs Statement

Operations Guide

Policy Manual

Project Management

Project Plan

Proposal Template

Proposal Forms and Checklists

Request For Proposal

Release Notes

Risk Management Plan

Service Level Agreement

Setup Guide

Statement of Work

Software Development Templates

Software Testing (QA) Templates

Software Requirements Specification

Standard Operating Procedure

System Admin Guide

System Boundary Document

System Design

System Specifications

Security Plan

Test Plan

Technical Writing Templates

Training Plan

Transition Plan

User Guide Template

Use Case Templates

Verification Plan

White Paper Templates

How to Write

Business Documents

Case Studies

Grants Applications

Process Design

Proposals and RFPs

Project Management

Technical Documents & FrameMaker

White Papers

Writing for the Web

Business Process Templates
Project Management Templates

Standard Operating Procedures

Employee Handbook

Policy Manual

Grant Proposal

Training Plan

Statement of Work

Sponsors
 

 



Forms, Checklists, & Templates - Updated Daily

I'm Ivan Walsh, the person behind this site. I help people improve how they write, publish and extend their business assets.

You can email me here or connect with me at Twitter @ivanwalsh, Disqus, Facebook, LinkedIn, Delicious & Google.

Endorsements | About Us | Contact Us | Site Map | Privacy| License | T&Cs | FAQs | Klariti

^^^ Return to top of page ^^^