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 prefer the first option, because it follows the way I am thinking. I'm reading about Widget X, so "Configuring Widget X" speaks to where I am at. Then I think - where is this section? Then you say 'under "Changes to Configuration". Excellent.
Cheers,
Eileen Neumann
Business Rules and Procedures
-----Original Message-----
From: bounce-techwr-l-177285 -at- lists -dot- techwr-l -dot- com [mailto:bounce-techwr-l-177285 -at- lists -dot- techwr-l -dot- com] On Behalf Of Patrick Wright
Sent: Tuesday, May 24, 2005 6:39 AM
To: TECHWR-L
Subject: Identifying chapters
Hi
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?
Thanks
Patrick
Notice: All email and instant messages (including attachments) sent to
or from Franklin Templeton Investments (FTI) personnel may be retained,
monitored and/or reviewed by FTI and its agents, or authorized
law enforcement personnel, without further notice or consent.
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.
