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 label my styles semantically, as you suggest. For inline boldface of
command names, for example, I create a style called Commands. For body
text I create Body Text or, if it's more specific, Tip Text or
something. There's no useful reason to name the styles with the font
formatting they contain, for just the reason you mention: you can't tell
where the styles are used if they are named in such a way.
From: techwr-l-bounces+cvickery=arenasolutions -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+cvickery=arenasolutions -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of Nancy Allison
Sent: Thursday, April 24, 2008 1:31 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Naming template styles
Hi, everyone. I'm working with a large and exuberant template that was
created before I got here. I notice that the creator has named almost
every style after its font characteristics. Let's say the document has a
header that is used only for Summary sections, and it is not to be
included in the TOC, so you don't want to assign the characteristics to
one of the Heading styles.
I would assign the characteristics -- say, Verdana 14 pt Bold -- to a
style and call it "Summary." That way, if I ever decide to reformat all
the Summary headings, I can edit the style once and have the effect
However, in this template, the style is called "Verdana 14 pt Bold." If
this style is applied *only* to the Summary headings, and if I wanted to
change the Summary format to Verdana 16 pt Bold, then I guess I could do
a universal Search & Replace -- find every instance of the style
"Verdana 14 pt bold" and replace it with the style "Verdana 16 pt.
But, if "Verdana 14 pt. Bold" has been applied to other pieces of text,
I can't do the substitution automatically, but must examine each
instance manually before applying the new style.
This, in a nutshell, is why I have always named styles after their
intended target, rather than after their attributes. But, before I
question it at this place of business, I'd love to know what you do, and
what your reasons are. I wouldn't be surprised if there are equally good
arguments for doing it the other way.
What principle do you adhere to when you name template styles?
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. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-