Product SiteDocumentation Site

Chapter 5. Avoiding Slang

Glossary
We write software documentation for a global audience, and in many cases this documentation is translated into many languages. To reach the widest possible audience, and to make the task of translation as straight-forward as possible, it is necessary to avoid slang and other culture-specific terminology. This page is an attempt to identify commonly-used slang terms and phraseology, and to provide alternatives.

Glossary

"anything you/they like"
This is probably readily understood but shouldn't appear in formal documentation.
"They can also use the slapi_register_plugin() call to register any kind of plug-in they like."
I rewrote it to be "...to register any other kind of plug-in."
"root your server in the /serverRoot directory"
This is not very elegant. Be aware of the multiple meanings of words. Try something like "Use the /serverRoot directory as the root directory for your server".
Check this site
Understood to mean "have a look at this website". The standard phraseology is something like "Refer to www.somewhere.com for more information". It is generally better to avoid "check" because it has so many meanings. Refer to the StandardTerminology page for more information.
dig deeper
Also - "delve deeper". "Visit the following web link to dig deeper into [subject]...". Using "dig deeper" may translate awkwardly. Instead, consider rewording to the suggested referral style in "check this", or to something like this: "For detailed information regarding [subject], refer to [internal link/external link]".
double-edged sword
Also - "double-bladed sword". If something is described as a double-edged sword, it indicates that it has two opposing behaviours or consequences. Instead, state that it can have unexpected consequences, or that the positive result might be offset by the negative result.
eat your own dogfood
Developer-speak. It means to use your own products. You can get a detailed description at http://en.wikipedia.org/wiki/Eat_one%27s_own_dog_food
Fibs
A fib is "small lie", also known as a "white lie". This appeared in one of the GLS books: "this command tells fibs". Use something like "The output of this command can be misleading".
Flying by the seat of your pants
Generally understood to mean "reacting to events as they occur". Difficult to offer alternatives without context
frown upon
"To frown upon" means to hold in low regard, not to approve of, etc. This translates to (and should have been written as) ".. the use of session context is not recommended..." (or words to that effect).
fuzzy (search)
1. Even though "fuzzy" is slang, it's common when referring to searches, especially in databases. If you do a fuzzy search for "Smith" you will probably also get "Smyth", because it sounds the same. The use of "fuzzy" is valid in this context.
Note the difference between this and "wildcard" searches: "Sm?th" could return "Smith", "Smyth", "Smeth", or even "Smrth".
2. Don't use "fuzzy" to refer to something that is not clear, such as an image, a concept, an idea, etc. For example, "He was a bit fuzzy on the details" is not valid.
have a crack at
Have a crack at and jump right in are closely related in meaning as they imply to "get started or give it a try". Alternatives for these are "start/try/begin" and will depend on the context of what's being discussed.
in a pinch
Under a tight schedule, hard pressed to achieve something.
jump right in

See have a crack at.

Kettle of fish
Commonly used in the expression "a different kettle of fish", to mean, "that's a different matter (altogether)". Depending on the context, try to use "topic", "subject", "matter", or something similar.
Neologisms (Invented words)
The English language is full of these. Some of them are useful, some of them are less so, others are just painful, difficult to translate, and should be avoided. Many of them are the result of creating nouns from verbs, verbs from nouns, and adjectives from just about anything. Unless a particular word has been in use for some time and has been generally accepted into common English (for example, "kerberized", which refers to a Kerberos-aware application), try to avoid these neologisms. If necessary, reword or restructure your sentences.
Examples
* "This feature allows synchronization of adds, deletes, and changes ..."
o This sentence has converted three verbs to nouns. A better structure might be, "This feature allows the synchronization of add, delete, and change operations..."
over the wire
Commonly used in expressions like "password information is sent in plain text over the wire", meaning "sent unencrypted through the transmission medium" (whether it is a wired or wireless network, the Internet, or whatever). You probably don't need to say it at all. "Sent/transmitted in plain text" is fine.
pain in the backside
Nobody should ever write this or anything like it in any distributable documentation. Use something like "problematic", "difficult", etc., as appropriate.
Ready to Rumble
In US English slang, being "ready to rumble" means you are "ready to go ahead" or "ready to start".
right before doing something
It's better to use "immediately before doing something" or otherwise write around the phrase.
shoot yourself in the foot
To "shoot yourself in the foot" indicates that you have done something to harm your own cause, or acting against your own best interests. Just cut out the sentence - it should be self-evident from the surrounding information.
shy of
Apart from the "normal" meaning of shy, it is also found in such phrases as "he was just shy of the mark", meaning that he didn't quite succeed. Also, to be "a few items shy of what's required" means to have less than the minimum number required. Avoid this terminology and use more easily understood terms; it will help our translators and also those reading our English documentation who are unfamiliar with such slang.
under the covers
This refers to something being out of plain sight or not immediately obvious. For example, you might only see the results of some action or command, but what happens "under the covers" is what is going on in the background, that you can't see or are not aware of, to make that action of command possible.
virtual elephants
This refers to a group of blind-folded people all touching different parts of an elephant and trying to describe what it is. Nobody sees the "big picture". It falls into the same category as "skeletons in the closet", "dark horse", "black sheep", etc. Use descriptions, adjectives, etc., that aren't specific to a particular culture or locale. Refer to http://en.wikipedia.org/wiki/Blind_Men_and_an_Elephant for more information.