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.
I've just ran into an issue that is tangential to the current discussion on
numbered headings, namely cross references.
I'm currently editing a moderately large (150 pages) specification document
that uses numbered headings. There are a fair number of cross references of
the form 'for more information, refer to section 3.1.1, "Watching Out for
Stobor" on page 34.' Given that I am stuck (for the moment, anyway) with
the mumbered headings, do you think I should simplify this by just refering
to the section and heading title without the page number? The section title
should give the reader enough information to find the heading quickly in the
doucment - most of the sections are fairly short.
Complicating factors are that I am writing in Word, which means that with
the current style I have to insert three different things to make a cross
reference. This is a bother for me and since the document will be used as a
template for future specifications, I really want to simplify it for the
poor developers who will be using it.
Any thoughts?
And no, FrameMaker is not an option (sigh).
PS - anybody got a macro that will insert the cross reference to a heading
and page number in one step?
Best
Keith
--
Keith Soltys
keith -at- soltys -dot- ca
Host of "Internet Resources for Technical Communicators" since 1994
Now at http://www.soltys.ca/techcomm.html
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.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.
