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.
Subject:There must be some kind of standard.... From:"jopakent" <jopakent -at- comcast -dot- net> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 24 Feb 2010 15:06:01 -0800
It's reading day here at highly-regulated, bigCorp and I'm reading through a
stack of procedures that have been updated recently.
As I yawn my way through these, I am increasingly amazed at the seemingly
random use of capitalization used in these documents. As my disdain (and my
gorge) rises at this unsophisticated usage, it occurs to me that my sneering
may be off base.
Is there some kind of different standard that applies to procedure writing
that allows for sentences like the following:
"The purpose of this procedure is to establish the responsibilities and
requirements
for controlling Documents."
I run into this kind of writing so frequently here, that I'm beginning to
wonder if there might be some basis for it. It seems like there is some kind
of guideline that says: "if something is important or significant,
capitalize it."
Of course, when you do that you run into consistency issues.
. What's important to one writer isn't as important to the next writer,
. The same word can be used in different contexts, which times do you
capitalize it?
I get called on to edit these from time to time and so far, I've been very
aggressive in removing every instance of these random capitals. My misgiving
today is that besides the fact that my tiny efforts (I've edited 3 or 4 out
of perhaps hundreds of procedures) seem futile, there may actually be some
kind of standard that calls for this otherwise inexplicable usage.
Has anyone seen a written standard that provides a justification or
explanation for this kind of writing?
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-