Re: Single subheading allowed?

Subject: Re: Single subheading allowed?
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 11 Jul 2008 05:01:14 +1000

Jeff Jansen wrote:
> Since the heading will have its own copy text that does not apply
> specifically to an individual ECM, I don't think merging the subheading copy
> with the heading copy (that is, omitting the subheading altogether) is
> appropriate. So is it acceptable, for the sake of cross-document
> consistency, that some documents be allowed to violate the structure
> convention? Or is there some widely accepted method for dealing with this?
> Has anyone dealt with this or a similar situation in another way?

We allow it but only under extreme circumstances.
The main instance in which we see it is with parallel
structures when only one standard subhead applies to
a particular component. We actually don't even say in
our style guide that we allow it due to fears of abuse
but in practical terms, the editors allow it from time
to time when there really is no other reasonable solution.

-- Janice

Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address

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.


Single subheading allowed?: From: Jeff Jansen

Previous by Author: Re: "using" as a verb in a task heading
Next by Author: Re: Single subheading allowed?
Previous by Thread: Re: Single subheading allowed?
Next by Thread: Document Annex?

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

Sponsored Ads