Runbook vs. run book, and why?
Walker, Cheryl L
"runbook" is one word or two. I searched the archives of this list and found
a couple of opinions, but no one gave a reason why. (Heck, if all we have to
go on is opinions, my team already has plenty of those!)
I also searched the following references (from a post by Sandy Harris), but
none of them contained the term.
Free Online Dictionary of Computing:
http://nightflight.com/foldoc/
Dictionary of Computer Science:
http://hissa.ncsl.nist.gov/~black/CRCDict/
General technology glossary:
http://www.trinity.edu/rjensen/245gloss.htm
The "Hacker's Dictionary", computer slang and folklore:
http://www.tuxedo.org/~esr/jargon/
Thanks,
Cheryl Walker
Technical Writer
www.intelonlineservices.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sponsored by Weisner Associates Inc., Online Information Services
Training & consulting for RoboHELP, Dreamweaver, HTML, and HTML-Based Help.
More info at http://www.weisner.com/train/ or mailto:trai...@weisner.com.
Your web site in 32 languages? Maybe not now, but sooner than you think.
Contact ForeignExchange for the FREE paper, "3 steps to successful
translation management" (http://www.fxtrans.com/3steps.html?tw).
---
You are currently subscribed to techwr-l as: tech...@GTS.ORG
To unsubscribe send a blank email to leave-tech...@lists.raycomm.com
Send administrative questions to ej...@raycomm.com. Visit
http://www.raycomm.com/techwhirl/ for more resources and info.
Murrell, Thomas
This is one of the many areas where the writer or writing department has to
make a decision based on principles of English usage and the needs and
expectations of the audience for the documentation in question. A case can
be made either way. One of the characteristics of technical documentation
is that we are constantly dealing with new terms and old terms used in new
and creative ways. Only when they get written down do these terms begin to
standardize.
As writers, you make a decision based on the best information you have and
go with it. From my perspective, that's part of the writer's job. The
nature of the world we write in is such that we're always dealing with these
new constructions.
FWIW, I would go with two words: "run book."
Tom Murrell
| ----------
| From: Walker, Cheryl L[SMTP:cheryl....@intel.com]
|
| My team is creating a runbook for the first time, and we're not sure if
| "runbook" is one word or two. I searched the archives of this list and
| found
| a couple of opinions, but no one gave a reason why. (Heck, if all we have
| to
| go on is opinions, my team already has plenty of those!)
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
salatas
|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.
Salette Latas
sal...@micron.com