RE: Identifying chapters

Subject: RE: Identifying chapters
From: "Jones, Donna" <DJones -at- zebra -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 24 May 2005 10:47:09 -0500


> > ...; see "Configuring Widget X" under "Changes to Configuration"
> >
> > ...; see "Changes to Configuration", "Configuring Widget X"
> >
> > ...; see "Changes to Configuration: Configuring Widget X"


I have to be a stick in the mud and say that I don't particularly like any of those, though the first is the lesser of evils. Having to locate first one heading then another doesn't seem very user-friendly. If I saw something like this in a document that I didn't absolutely have to read, that would be where I stopped and filed the document in my garbage can.

What about:

...; see "Configuring Widget X" on page Y.

Or can't you use cross-references to page numbers in the format you're using?


Donna


Donna L. Jones
--------------------------------------
Technical Writer II
Zebra Technologies Corp.
Vernon Hills, IL
djones -at- zebra -dot- com

- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l

---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: Tech Writers as Hourly Employees?!
Next by Author: RE: Acceptance of Mediocre Documentation
Previous by Thread: RE: Identifying chapters
Next by Thread: Re: Identifying chapters


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


Sponsored Ads