Identifying chapters

Subject: Identifying chapters
From: Patrick Wright <pdoubleya -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 24 May 2005 12:39:05 +0200


I'm working on some release notes for a software product. The document
format is standardized, with a New Features, Changes to Configuration,
and a couple of other sections. These release notes are typically 2-15
pages long.

My question is the correct way to refer to subsections within the
larger section. Within "New Features", for example, I am describing
the new Widget X. This widget requires some changes to database
configuration, described elsewhere, specifically, in the section
"Configuring Widget X" in "Changes to Configuration".

Wondering the best way to state the reference, in particular how the
section/subsections are shown

...; see "Configuring Widget X" under "Changes to Configuration"

...; see "Changes to Configuration", "Configuring Widget X"

...; see "Changes to Configuration: Configuring Widget X"

I prefer the first, though it doesn't follow a natural major-minor
section reference. Thoughts?



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!

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


Previous by Author: Printing problems with Imbedded Excel and Visio files
Next by Author: Re: Identifying chapters
Previous by Thread: RE: [HOWTO] Web Domains and registration?
Next by Thread: Re: Identifying chapters

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

Sponsored Ads