Bi-directional traceability and docs

Subject: Bi-directional traceability and docs
From: dan_roberts -at- adp -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 15 Jun 2004 14:23:04 -0600

We're going thru the pains of CMMi here, and one of the objectives is to
institute "bi-directal traceability", which, in a nutshell, means that the
spec points to the places in the code and doc that need to change to meet
a user req, and the code and the doc reflect the user req that prompted a
change. And my group here has been asked to consider implementing this
traceability in our doc.

A little background. We release new software versions every 6 months, each
new version consisting of a number of user req "enhancements", which are
then summarized in Release Notes, and propogated throughout the
installation, configuration, and user doc. The Release Notes list each
"enhancement" that goes in a version, but the other docs do not mention
specific enhancements by number. The request is that the other pieces of
doc also begin mentioning the specific "enhancements".

I can come up with good reasons to do so - it helps our users and our
business analysts track how an enhancement ripples through our system.
OTOH, I can see this turning into a big pain in the tuckus.

So, I'm curious: Do any of you folk implement bidirectional traceability
in your docs? If so, how successful was it? Are there caveats to doing
this, things to watch for and guard against?

Any advice would be appreciated.


SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!

COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. .

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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 for more resources and info.

Previous by Author: Powerpoint > Extracting figures/images
Next by Author: Re: upload/download terminology
Previous by Thread: RE: Unwanted popularity
Next by Thread: RE: Bi-directional traceability and docs

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

Sponsored Ads