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'm developing a template in Microsoft Word for a client. It will be used to
create documents that document energy-conservation measures (ECMs) installed
in a series of buildings. There will be a separate document for each
building. It makes sense to organize the document such that several sections
of a document each have a subheading for each ECM in the building.
The problem is that some buildings have only a single ECM, so the documents
for those buildings would have some headings with only a single
next-level-down subheading. This is usually considered a violation of
document-structure conventions, so I'm asking for advice on how to deal with
this situation.
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?
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-