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.
If the example is also a sample of the kind of content your manual
includes (what kind of "manual" is this anyway?) the capitalization
seems appropriate to that domain.
If your audience profile is closer to that of your writers than
yourself, then they understand this convention even though you and
your'n may find it a little "specialized".
I'd suggest distilling the usage into style guidelines to ensure
consistenty application across the document(s).
-edwin
> I am editing a manual, and the writers use a capitalization convention
> that is derived from contracts. The following is an example:
>
> **The Guaranteed Maximum Price (GMP) is the maximum amount that the
> Owner is obligated to pay the Contractor for the construction of the
> project pursuant to a defined scope of work and schedule. The GMP Change
> Order is the instrument that fixes this price after much of the
> preconstruction work is finished. By design, the amount of the GMP
> Change Order cannot exceed the Stated Cost Limitation (SCL) for
> construction. In other words, the Owner cannot authorize the Contractor
> to spend more money than what is available. The GMP Proposal is an offer
> made by the Contractor to facilitate the GMP Change Order.**
>
> If the writer wants this convention included in the manual, should I
> interfere? Or is this capitalization correct? It seems out of the
> ordinary to me and would be difficult to maintain throughout a complex
> manual. Does anyone have any thoughts on this?
>
> Kirk
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as archiver -at- techwr-l -dot- com -dot-
