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:RE: Runbook vs. run book, and why? From:salatas <salatas -at- micron -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 6 Apr 2000 08:25:09 -0600
Cheryl Walker wrote:
>we're not sure if "runbook" is one word or two.
Response:
I agree with Tom Murrell's post: "make a decision based on the best
information you have and
go with it." Technical writers deal with these issues all the time, and it's
easier in the long run to come up with a consistent method of dealing with
the issue than trying to debate each term as it comes along.
Here's what I do:
Spelling Checklist
1. Run the spelling checker in the tool you are using. If the spelling
checker does not recognize a word, you have the following options:
a. Recognize that the word is misspelled, and enter an alternative.
b. Recognize that the word is a company-specific or
industry-specific term. Check the spelling and definition against a company
or industry glossary. Include it in your document's glossary or in a pop-up.
c. Recognize that the word is an application-specific term. Include
it in your document's glossary or in a pop-up.
d. Recognize that the word is a foreign word. Replace it with an
English word, or italicize it.
e. Recognize that the dictionary attached to your spelling checker
is just not broad enough to include this perfectly good, correctly spelled
English word. Go to step 2.
2. Look up the word in whatever dictionary your group has chosen as its
standard. If your standard dictionary does not list the word, you have the
following options:
a. Go back to step 1 and choose a, b, c, or d.
b. Decide that this word is just too new for your standard dictionary.
If the word pertains to the computer industry, go to step 3. If not, choose
a more standard word.
3. Look up the word in whatever computer dictionary your group has chosen as
its standard. If it's not in there, go back to step 1 and choose a, b, c, or
d, choose a more standard word, or recognize that your issue is actually one
of style, not spelling. See the Style Checklist.
Style Checklist
1. Look up the style issue in your project, group, or corporate style guide.
If the local style guide does not address your issue, go to step 2.
2. Look up the issue in the whatever published style guide your group has
chosen for its standard.