the theory of x-refs in a modular writing environment

Subject: the theory of x-refs in a modular writing environment
From: Kevin McGowan <thatguy_80 -at- hotmail -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 Feb 2008 11:09:37 -0500

Hi all,

A philisophical question for this snowy Wednesday. I'm starting to do a lot of reuse of my DITA topics through my user guides, training guides, etc.

I find myself in the position of having to go through and either "fix" or "remove" a lot of X-references simply because I'm not always sure which topics will be reused, and where they may end up. I certainly don't want to build a series of new guides and have broken references everywhere.

has anyone got any thought on x-refs? Typically, they take the format of "for more information on Topic A, see "AAA on page 15" and really just serve as a guide to some extra or related data. Would a thorough Index be sufficient for readers who may want to read more on a topic?



Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.


Words with double meanings: From: Michelle Vina-Baltsas
Re: Words with double meanings: From: Dana Worley

Previous by Author: Re: Word 2007 -- BUMMER! Can't create pdf files!
Next by Author: RoboHelp X5 Search has stopped working
Previous by Thread: Re: Words with double meanings
Next by Thread: RE: the theory of x-refs in a modular writing environment

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

Sponsored Ads