Appendix C. Word usage
This list of words and terms is not intended to take the place of a general dictionary but instead gives advice that is pertinent to technical writing where usage might be more specific or differ from that in the dictionary. Terms have also been included that are found to cause difficulties for technical writers and where consistency of expression needs clarification.
For general spellings, definitions, etymologies, and rules about parts of speech, see Merriam-Webster’s Collegiate Dictionary.
The terms listed here are divided into three categories:
= Preferred term
= Use with caution
= Do not use
Numbers
10BASE2, 10BASE-T n
Write as shown, uppercase “BASE.” Do not use a hyphen when a number follows “BASE” (for example, “10BASE2”), but do use a hyphen when a letter follows (for example, “10BASE-T”).
24×7 adj
Use this abbreviation to indicate high availability, nonstop operation or support, such as for database and e-commerce applications or monitoring. Do not use this abbreviation to indicate the general availability of something, such as service. Do not use “24/7”.
Whenever possible, use descriptive wording: for example, “High-availability databases not only are universally available but also have high reliability and serviceability,” or “Operations are monitored 24 hours a day, every day of the week.” However, 24×7 is acceptable usage, provided that you are consistent within a document or library.
32-bit Windows operating system n
Do not use. Use “Windows 32-bit operating system.”
A
Å n
Use “Å” as the abbreviation of “angstrom.”
A n
Use “A” as the abbreviation of “ampere.”
A-disk n
Write as shown - uppercase “A” and hyphenated.
abend v
Do not use as a verb. Use only as a noun or adjective.
Write as shown - lowercase (for example, “the abend code”). Do not use as a verb.
abend n
Write as shown - lowercase (for example, “a program abend”). Do not use as a verb.
abort v
Do not use. Use “cancel,” “stop,” or “end.”
about adv
Do not use to mean “approximately.”
above adj
Do not use to indicate a relative location in a document, as in “the above restrictions.” Use “previous” or “preceding.”
Example: “The previous restrictions apply to...”
ac n
Write as shown - lowercase - to refer to the abbreviation for “alternating current.”
AC n
Do not use to refer to the abbreviation for “alternating current.” Write in lowercase - “ac”.
acknowledgment n
Spell as shown - not “acknowledgement.”
across prep
Do not use to mean “to” or “for.” For example, write “applications for multiple platforms” rather than “applications across multiple platforms.”
actionable adj
Do not use to mean that action can be taken, for example, “Transform data into actionable business information.” Use only in the legal context of providing grounds for a lawsuit.
active adj
Do not use to describe an interface control that is available. Use “available.”
ad hoc adj
Write as shown - two words.
adapter n
Spell as shown - not “adaptor.” Use “adapter,” not “card,” to refer to a circuit board that enables a computer to use a peripheral device, such as a CD-ROM drive or modem, for which it does not already have the necessary connections, ports, or circuit boards.
adapter card n
Do not use “adapter card.” Use “adapter” or “card,” whichever is appropriate.
adaptor n
Do not use. Use “adapter.”
add-on n
Write as shown - hyphenated.
Do not use. Use “administer.”
afterward adv
Spell as shown - not “afterwards.”
agent n
Do not confuse the concept of a client/server model with that of an agent/manager model.
A client and an agent are similar in that they are each dependent on something else: a client is dependent on a server, and an agent is dependent on a manager. However, they are opposites regarding requests, in that a client requests services from a server and a manager requests services from an agent. In summary, a client and an agent are alike in the direction of dependency but are opposites in the direction of requests.
agile n
Do not use as a noun. Use only as an adjective. For example, write “The agile team advocates multiple two-week iterations,” not “Agile advocates multiple two-week iterations.”
agile adj
Write as shown - lowercase - and use only as an adjective. For example, write “The agile team advocates multiple two-week iterations.”
all caps n
Do not use. Use “uppercase.”
allow v
Avoid stating that inanimate objects grant abilities to people, as in “the product allows you to...” Whenever possible, use a direct, user-focused alternative such as “you can use the product to...” or “with this product, users can...”
alpha adj
Do not use to mean “alphabetic.”
alphabetic adj
Use “alphabetic” to mean of, relating to, or employing an alphabet.
Do not use to mean arranged in the order of the letters of the alphabet.
Example: You must specify alphabetic characters.
alphabetical adj
Use “alphabetical” to mean arranged in the order of the letters of the alphabet. Do not use to mean of, relating to, or employing an alphabet.
Example: The names are displayed in alphabetical order.
alphameric adj
Do not use. Use “alphanumeric.”
alphanumeric adj
Use “alphanumeric,” not “alphameric” or “alphanumerical.”
Example: The password must contain at least 8 alphanumeric characters.
alphanumerical adj
Do not use. Use “alphanumeric.”
Example: The password must contain at least 8 alphanumeric characters.
Use “alternate” (or one of its forms, such as “alternating”) to mean “every other,” and use “alternative” when a choice is involved.
Examples: (1) “An alternating current reverses its direction at regularly recurring intervals.” (2) “If the main system console becomes unavailable, you can designate an alternative system console.”
alternative adj
Use “alternative” when a choice is involved, and use “alternate” (or one of its forms, such as “alternating”) to mean “every other.”
Examples: (1) “If the main system console becomes unavailable, you can designate an alternative system console.” (2) “An alternating current reverses its direction at regularly recurring intervals.”
a.m. adj
Write as shown - lowercase with a period after each letter. Do not use A.M.
ampere n
Abbreviate as “A”.
analog adj
Spell as shown - not “analogue.”
analogue n
Do not use. Use “analog.”
and so on n
Use only when you list a clear sequence of elements, such as “1, 2, 3, and so on” or “Monday, Tuesday, Wednesday, and so on.” When you list items that do not form a clear sequence, use appropriate descriptive wording, such as “device drivers, firmware, and other code.”
and/or conj
Do not use. Depending on the context, use a construction such as “a or b” or “a, b, or both.”
This is not a valid construction in English; it also does not exist in other languages and therefore causes translation problems.
angstrom n
Abbreviate as “Å”.
ANS n
Do not abbreviate “American National Standard.”
For example, to refer to the subject of an ANSI standard, write “American National Standard COBOL,” not “ANS COBOL.”
ANSI n
Use to refer to the institute itself or as part of the identification number of a standard, such as “ANSI X3.23-1974.” Do not use to refer to the subject of a standard; for example, write “American National Standard COBOL,” not “ANSI COBOL.” Always use “ANSI,” not “USASI.”
any time n
Write as shown - two words - when used as a noun. For example, write: “The message might arrive at any time.”
anytime adv
Write as shown - one word - when used as an adverb. For example, write: “You can do this anytime you want.”
Do not use as a noun. Use “any time.”
API documentation n
Use “API documentation,” “Javadoc information,” “Javadoc HTML documentation,” or “Java API documentation” to refer to the output of the Javadoc tool.
appear v
Do not use unless there is no better alternative. Possible alternatives include “is displayed” and “opens.”
“Appear” implies magic or illusion (for example, “it appears to be snowing, but it is the falling volcano ash”). When you are referring to a window in a graphical user interface, always use “open.” Examples: (1) “The message is displayed when you make a mistake.” (2) “The window opens...”
appendices n
Do not use. Use “appendixes.”
appendixes n
Spell as shown - not “appendices.”
Applet Viewer n
Write as shown to refer to the Java tool from Oracle.
application program interface n
Do not use. Use “application programming interface.”
architect v
Do not use as a verb. Use only as a noun. When you need a verb, use “design,” “plan,” or “structure.”
architected adj
Do not use unless there is no better alternative. Consider using a simpler word, such as “designed.”
artefact n
Do not use. Use “artifact.”
article n
Do not use to refer to a topic in an information center. Use “topic.”
article-based information n
Do not use. Use “topic-based information.”
artifact n
Spell as shown - not “artefact.”
as adv
Do not use to mean “because” or “while.”
Example: Write “Because you created the file, you can delete it,” not “As you created the file, you can delete it.”
as long as conj
Do not use to mean “on condition that.” Use “if” or “provided that.”
Examples: (1) Write “Do not stop the process if the map is active,” not “Do not stop the process as long as the map is active.” (2) Write “You can leave the field blank, provided that there are no other users,” not “You can leave the field blank as long as there are no other users.”
Do not use. Use a phrase such as “according to,” “as,” or “as in.”
as well as conj
Do not use to mean “and.”
ASCII n
Write as shown - uppercase. Do not use “USASCII.”
assembler n
Do not use to refer to the language used for an assembler. Use either “assembly language” or “assembler language,” depending on the terminology used in your product. Use “assembler” only to refer to a computer program that converts assembly language instructions into object code.
assembler language n
Use “assembler language” only to refer to the language used by products that include the term “Assembler” in their name (for example “High Level Assembler for z/OS).”
In most cases, use “assembly language” to refer to low-level programming languages used by assemblers.
assembly language n
In most cases use “assembly language,” rather than “assembler language,” to refer to low-level programming languages used by assemblers.
attach v
Do not use as an intransitive verb (for example, “the cable attaches to the monitor”) unless the subject actually performs the action without human intervention. Instead, use “attach” as a transitive verb (for example, “the cable is attached to the monitor”).
attention notice n
Use “attention notice,” not “warning notice.”
auxiliary storage n
Use “auxiliary storage,” not “offline storage” or “secondary storage.”
available adj
Use “available,” not “active,” to describe an interface control that is displayed and enabled.
B
b n
Use this abbreviation (lowercase) in combination with a multiplier prefix such as K, M, G, or T to mean “bit” or “bits” (for example, Kb).
B n
Use this abbreviation (uppercase) in combination with a multiplier prefix such as K, M, G, or T to mean “byte” or “bytes” (for example, KB).
back end n
Write as shown - two words. If possible use a more specific term, such as “server,” “operating system,” or “network.”
back up v
Write as shown - two words - when used as a verb.
Write as shown - hyphenated. If possible use a more specific term, such as “server,” “operating system,” or “network.”
back-level, backlevel adj
Do not use. Use “earlier,” “previous,” or “not at the latest level.”
back-up adj, n
Do not use. Use “backup.”
backside n
Do not use. Use “back” or “rear.”
Examples: (1) The connector is on the back of the device. (2) The rear view shows the connectors.
backslash n
Write as shown - one word - to refer to the character.
backup adj, n
Write as shown - one word.
backward compatible adj
Do not use. Use “compatible with earlier versions.”
BCT n
Do not use as an abbreviation of “breadcrumb trail.” Spell out “breadcrumb trail.”
bean n
Write as shown - lowercase.
JavaBeans is a platform-independent, software-component technology for building reusable Java components called “beans.” “Bean,” apart from its use in the term “JavaBeans,” is a generic term and should be lowercase.
because of prep
Use “because of,” not “due to,” in adverbial clauses.
Although the use of “due to” as a synonym of “because of” has some acceptance in modern English usage, it is imprecise and, therefore, not suited to technical writing. Incorrect: “Due to the power failure, the update stopped.” Correct: “Because of the power failure, the update stopped.”
below adj
Do not use to indicate a relative location in a document, as in “the information below.” Use “the information later in this section.”
Alternatively, you can use “following” to refer to a table, to art, or to a list. Example: “The following table shows ...”
bench-mark n, v
Do not use. Use “benchmark.”
benchmark n, v
Write as shown - one word.
best practice n
Although the term “best practice” is widely used in the business world, it is best avoided in technical documentation. It is better to tell readers what to do, rather than telling them that what they are doing is a “best practice.”
“Best practice” is a generic term to describe the best process, at the time of writing, for doing something. At any time, a new best practice can replace what was considered to be the best practice until then. Never use as an adjective; a term such as “best practices data” might be incorrectly interpreted as meaning “the best data relating to practices.”
beta adj
Write as shown - lowercase.
Avoid using “beta” as a noun when a noun phrase is more accurate (for example, “beta program” or “beta code).”
between prep
Do not use to show a range of numbers; it is not clear whether the two numbers are the boundaries of the range or are included in the range.
See “Ranges of numbers” on page 159 for a more detailed explanation.
bidi adj
Write as shown, with a lowercase “b” to refer to the abbreviation for “bidirectional.”
billion n
Do not use. Use the number rather than the word because it has different meanings in different countries.
To United States readers, one billion means 1,000,000,000 (one thousand million), and in some other countries, one billion means 1,000,000,000,000 (one million million).
binary n
Do not use as a noun. Use only as an adjective, as in “binary file.”
bit field n
Write as shown - two words - not “bit-field” or “bitfield.”
bitstream, bit stream adj, n
Write as one word when used as an adjective - “bitstream.” Write as two words when used as a noun - “bit stream.”
bit string n
Write as shown - two words.
bitmap adj, n
Write as shown - one word.
black box n
Use only in technical documentation, and provide a definition, because “black box” is jargon and might not be understood by all readers.
“Black box” refers to the hidden internal workings of a product or program, as in “black box testing.” Although it is widely used in the computer industry, “black box” is jargon and might not be understood by all readers. Try to find an alternative, but if you must use it in technical documentation, provide a definition.
blink v
Do not use to refer to indicator lights. Use “flash.”
blue screen of death n
Do not use. Use “stop error,” and describe the type of message received. You can mention “blue screen,” but only as additional contextual information.
Example: “You might receive a stop error on a blue screen, with the message *** Fatal System Error: ...”
Do not use by itself. Use as part of the term “system board,” or use “adapter.”
boolean adj
Write “boolean” with an initial lowercase “b” only in API programming information, when “boolean” refers to a primitive return type. In all other cases, use an uppercase “B” - “Boolean.”
Boolean adj
Write as shown - with an initial uppercase “b”. In API programming information, use an initial lowercase “b” when “boolean” refers to a primitive return type.
boot v
Although “boot” is widely recognized among technical users, where usage permits use “start” or “turn on.”
both conj
Use to refer to two items only (for example, “Create a password for both the administrator and the user”).
To conform to modern usage, and to be precise, use “both” for only two items when used as a conjunction. This usage advice is contrary to the example shown in Merriam-Webster’s Collegiate Dictionary.
bottom left, bottom right n
Do not use. Use “lower left” or “lower right” to refer to the location of an item in an interface.
Accessibility requirement: People who are blind or have low vision might not be able to understand information if it is conveyed only by location. Provide additional text information other than location. For example, write “The tables are displayed in the Table List pane, which is in the lower right of the window,” not “The list of tables is displayed in the lower right of the window.”
bottom-left, bottom-right adj
Do not use. Use “lower-left” or “lower-right” to refer to the location of an item in an interface.
Accessibility requirement: People who are blind or have low vision might not be able to understand information if it is conveyed only by location. Provide additional text information other than location. For example, write “The tables are displayed in the Table List pane, which is in the lower-right corner of the window,” not “The list of tables is displayed in the lower-right corner of the window.”
branch n
Do not use to refer to a group of topics in an information center navigation tree. Use “section.”
The term “branch” is used in many products to describe many different types of objects. Ensure that you use the term consistently within your product documentation.
breadcrumb n
Use only to refer to a web interface element that displays the reader’s current position within a site at the top of the web page.
breadcrumb trail n
Do not abbreviate as “BCT.”
breadcrumbing n
Do not use to describe the act of navigating on the web. Use “breadcrumb trail” instead.
breakpoint n
Write as shown - one word.
Do not use. This term is ambiguous. Use “start,” “power on,”
“open,” or “turn on,” as appropriate.
British thermal unit n
Write as shown - with an initial uppercase letter on “British” only. The abbreviation is “Btu.”
broken adj
Use to describe a connection that has been disconnected. Do not use “lost.”
BSOD n
Do not use to refer to the “blue screen of death.” Use “stop error,” and describe the type of message received. You can mention “blue screen,” but only as additional contextual information.
Example: “You might receive a stop error on a blue screen, with the message *** Fatal System Error: ...”
Btu n
Use as the abbreviation of “British thermal unit” and capitalize it as shown.
buffer pool n
Write as shown - two words.
built in adj
Hyphenate the term if you use it before a noun that it modifies (for example, “built-in diagnostic tools”).
bus master n
Write as shown - two words.
buses n
Spell as shown - one “s” - as the plural of “bus.”
“Busses” means “kisses.”
business-to-business adj
Do not use the abbreviation “B2B” in technical writing. Spell out “business-to-business,” but consider using a phrase that is less marketing oriented. For example, instead of “a business-to-business relationship,” consider writing “a relationship between one business and another.”
business-to-consumer adj
Do not use the abbreviation “B2C” in technical writing. Spell out “business-to-consumer,” but consider using a phrase that is less marketing oriented. For example, instead of “a business-to-consumer relationship,” consider writing “a relationship between a business and a consumer.”
business-to-employee adj
Do not use the abbreviation “B2E” in technical writing. Spell out “business-to-employee,” but consider using a phrase that is less marketing oriented. For example, instead of “a business-to-employee relationship,” consider writing “a relationship between a business and an employee.”
busmaster n
Do not use. Use “bus master.”
busses n
Do not use. Use “buses.”
“Busses” means “kisses.”
Use a qualifier with “button” (for example, “radio button” or “toolbar button”) or just refer to a control by its label (for example, “Click New”). Do not use “button” to refer to a key on a keyboard.
button area n
Use to refer to the area at the bottom of a wizard page that contains the push buttons that apply to the entire wizard, not just one individual page.
C
cache v
If possible, avoid the verb form by using a suitable alternative (for example, “store in a cache).”
cache n
Use as a noun rather than a verb in most cases.
“Cache” is used as both a noun and a verb, although translators prefer a term be used in only one grammatical sense.
call out v
Write as two words when used as a verb - “call out.”
callout adj, n
Write as shown - one word - when used as an adjective or noun.
camel case adj, n
Avoid this imprecise colloquialism when possible. Instead, explicitly state your convention and give an example. If you must use this term, write as shown - two words - enclose it in quotation marks, and include an explanation and an example.
Because this term is only one of several terms for the same concept, it causes problems for translators. In addition, it is ambiguous because the capitalization scheme varies.
can v
Use to indicate ability. Use instead of “could.”
In most cases, use “can” or “might,” not “may.”
can not v
Do not use. Use “cannot.”
cancel v
Use “cancel” or “stop,” not “abort.”
canceled, canceling v
Spell as shown - not “cancelled” and “cancelling.”
cancellation n
Spell as shown - not “cancelation.”
This spelling is an exception; the consonant is usually doubled when it introduces a stressed syllable.
cancelled, cancelling v
Do not use. Use “canceled” and “canceling.”
Do not use. Depending on the context, use a more precise word such as “preplanned,” “preconfigured,” or “predefined.”
“Canned” is a jargon term that has many slang interpretations, and it is too vague to use for a wide range of meanings.
cannot v
Write as shown - one word.
card n
Use to refer to a circuit board that is integral to the computer, unless another term (such as “system board”) is more appropriate.
card reader n
Write as shown - two words.
case insensitive adj
Do not use. Use “not case sensitive.”
case sensitive adj
Hyphenate the term if you use it before a noun that it modifies (for example, “a case-sensitive password”).
catalog n, v
Spell as shown - not “catalogue.”
catastrophic error n
Do not use. Use “unrecoverable error” or wording that indicates that the error disrupts operations.
catch v
Do not use to refer to the detection of an undesirable status situation except in Java documentation, as in “catch an exception.” In all other contexts, use an alternative expression such as “detect an error,” rather than “catch an error.”
category n
Do not use to refer to a group of topics in an information center navigation tree. Use “section.”
The term “category” is used in many products to describe many different types of objects. Ensure that you use the term consistently within your product documentation.
CBE n
Do not use this abbreviation of “Common Base Event.” “CBE” is a trademark of another company.
CBTS n
Do not use “CBTS” as the abbreviation of “CICS Transaction Services.” “CICS BTS” is the recommended diminution, although “BTS” is acceptable in the appropriate context.
CD drive n
Use “CD drive” if the read/write characteristic of the drive varies, cannot be predicted, or is irrelevant.
CD-ROM n
Do not use to refer to a compact disc. Use “CD.”
Use “CD-ROM” or “CD-RW” only if you must be specific about the read/write characteristic of the CD.
Use to refer to a read-only CD drive.
If the read/write characteristic of the drive varies, cannot be predicted, or is irrelevant, use “CD drive.”
CD-RW drive n
Use to refer to a CD drive that can be read from and written to (a CD read/write drive).
If the read/write characteristic of the drive varies, cannot be predicted, or is irrelevant, use “CD drive.”
CE n
Do not use this abbreviation of “customer engineer,” which is an obsolete term.
CEC n
Do not use this abbreviation of “central electronic complex.” Use “CPC” (for “central processor complex”).
central electronic complex n
Do not use. Use “central processor complex” or “CPC.”
central processing unit n
Use only when the term is used explicitly in the product interface. Otherwise, use “processor” or “microprocessor.” The same advice applies to the abbreviation “CPU.”
“Central processing unit,” or “CPU,” is an older term for “processor” or “microprocessor.”
central processor complex n
Use “central processor complex” or “CPC,” not “central electronic complex” or “CEC.”
cents n
Spell as shown - following normal English usage of adding an “s” to “cent” to form the plural.
Although the European Union specifies “cent” as the plural form in its own official publications, use the usual English plural form by adding an “s.” This usual usage has been authorized by the EU and adopted by many publishers.
character-based interface n
Use this term to contrast with a graphical user interface. Do not use “green screen.”
check v
Do not use to refer to marking a check box. Use “select” and “clear.”
check box n
Write as shown - two words.
check mark n
Write as shown - two words.
checklist n
Write as shown - one word.
child n
Use “child,” not “children,” to describe a noun (for example, “child processes”).
child topic n
Do not refer to a “child topic” in an information center, except when writing instructions about navigating. Whenever possible, refer to the specific topic title, not the relationship of topics to one another.
The term “child” is often used to describe a hierarchy of objects. Ensure that you use the term consistently within your product documentation.
Do not use “children” to modify plural nouns that include the term “child.” Use “child” (for example, “child processes”).
chip set n
Write as shown - two words.
chipset n
Do not use. Use “chip set.”
choose v
Do not use to refer to actions performed on interface elements. Use “click” or “double-click” for menu commands, push buttons, and other interface elements. Use “select” and “clear” for check boxes.
Christian name n
Do not use. Use “given name,” not “first name” or “Christian name,” to refer to the name that is used to identify an individual within a group, such as a family.
chronological adj
Use “chronological,” not “chronologic.”
Example: The events are displayed in chronological order.
class of service n
Write as three words when used as a noun - “class of service.”
class path n
Write as shown - two words - unless you are using it as a variable.
class-of-service adj
Write with hyphens when used as an adjective - “class-of-service.”
classes of service n
Write as shown as the plural of “class of service.”
classpath n
Use only as a variable. Otherwise, use “class path.”
cleanup, clean up n, v
Write as one word when used as as noun - “cleanup.” Write as two words when used as a verb - “clean up.”
clear v
Use “clear,” not “deselect” or “unselect,” to refer to removing a mark from a check box.
CLI n
In most cases, use “command line” unless you need to make specific reference to the command-line interface, as opposed to the graphical interface.
click v
Use “click,” not “click on,” to refer to the action of selecting something on a graphical interface.
click on v
Do not use. Use “click” instead to refer to the action of selecting something on a graphical interface.
Use “client,” not “customer,” in marketing collateral.
“Client” implies a higher level of strategic consultation and partnership than “customer.”
client/server adj, n
Write as shown, with a forward slash. Do not use “client-server.”
code base n
Use as two words “code base.”
This is a common industry spelling, and does not require usage advice.
code page n
Write as shown - two words.
code point n
Write as shown - two words.
code set n
Write as shown - two words.
cold boot n
Do not use. Use “cold start.”
cold start v
Do not use. Use “restart,” “start again,” or alternative wording.
cold start n
Write as shown - two words.
combination box n
Use only in information for interface developers to explain how to create a graphical interface. Do not use in instructions about how to use a graphical interface; use the name of the field instead. Do not use “combo box.”
combo box n
Do not use as an abbreviation of “combination box.” In instructions about how to use a graphical interface, use the name of the field, as in “the Servers field.” In instructions to interface developers to explain how to create a graphical interface, use “combination box.”
command console n
Do not use. In Windows documentation, use “command prompt.” In non-Windows or cross-system documentation, use “command line.”
command line n
Use to refer to the area where commands are entered in non-Windows or cross-system documentation. Do not use “command line” in Windows documentation; use “command prompt.”
command prompt n
Use “command prompt,” not “command line” or “command console,” in Windows documentation.
It is rarely necessary to refer to the window in which the command prompt is accessed.
command-line adj
Write as shown - hyphenated - when used as an adjective (for example, “the command-line interface”).
Use to describe the act of adding characters to the beginning of a line of code to indicate that the line is not to be compiled.
Common Base Event n
Do not use “Common Base Event” as a noun. Instead use the generic term “event.” If you must be more specific, write something like “an event that conforms to the Common Base Event specification.”
CommServer n
Do not use. Use “Communications Server” and state the operating system to which it applies, such as “Communications Server for AIX” or “Communications Server for z/OS.”
Communications Server n
State the operating system to which the server applies, such as “Communications Server for AIX” or “Communications Server for z/OS.”
compile v
Use as a verb. Use as an adjective when describing standard terms (for example, “compile time”) unless an alternative is available (“compiler option”).
compile adj
Use as an adjective when referring to compiling (the activity), as in “compile time”. Use “compiler” when referring to the actual compiler, as in “compiler option.”
complete v
Do not use as a reflexive verb (for example, “the program completes”). Use “is completed” (for example, “the program is completed”).
component architecture n
Use “component-based development,” “component model,” or “component architecture,” not “componentization.”
component model n
Use “component-based development,” “component model,” or “component architecture,” not “componentization.”
component-based development n
Use “component-based development,” “component model,” or “component architecture,” not “componentization.”
componentization n
Do not use in external communication, such as product documentation or marketing literature; instead, use “component-based development,” “component model,” “component architecture,” “shared components,” or another expression.
Because this term is jargon, it should not be used in external communication; instead, use “component-based development,” “component model,” “component architecture,” “shared components,” or some such phrase.
componentize v
Do not use. This term is jargon. Use “develop components” or a similar phrase.
compress v
Use to mean the compressing of files with a compression utility. Do not use “jar,” “tar,” or “zip.” The terms “zip” and “ZIP” are registered trademarks of other companies. Using them might result in trademark infringement.
Do not use. Use “consists of” or “composed of” to describe parts of a whole (for example, “the library is composed of five books”).
“Comprised of” is often used to mean “consists of” or “composed of.” but this usage is incorrect. Because “comprise” (which means “to include”) is frequently used incorrectly, consider replacing it with a clearer alternative when possible. Incorrect: The array is comprised of five disks. Incorrect: Five disks comprise the array. Correct: The array comprises five disks. Correct: The array consists of five disks.
concurrent peripheral processing n
Do not use. Use “spooling.”
congratulations n
Do not use in technical information. State the task that has been accomplished, such as “You have now completed the tutorial.”
If you believe that it is useful to inform readers that they have completed a tutorial or a complex procedure, state the obvious: “You have now completed the tutorial.” Saying “congratulations” can sound patronizing to native English speakers and also creates problems for translators.
connect v
Do not use as an intransitive verb (for example, “the power cord connects to the computer”). Use “is connected” (for example, “the power cord is connected to the computer”).
console n
Do not use interchangeably with “workstation” or “terminal.”
consumability n
Do not use in technical information. Use more precise terms relating to specific features of a product.
Although this term is widely used, it causes translation difficulties.
consume v
Do not use when a simpler term such as “use” would be more appropriate. Use only to mean “use up.”
Examples: (1) Instead of “The number of disk pages consumed by all indexes defined on a table,” write “The number of disk pages used by all indexes defined on a table.” (2) Correct: “Because the resources have been consumed, they can no longer be used.”
container n
Do not use to describe a high-level topic in an information center. Refer to the topic by its name, not the type of topic.
The term “container” is used in many products to describe many different types of objects. Ensure that you use the term consistently within your product documentation.
content pane n
Do not use to refer to the right pane in an information center. Use “topic pane.”
The term “content pane” is correctly used in many products to describe the right pane in the product interface.
Contents pane n
Use “navigation pane” to refer to the left pane in an information center. The navigation pane contains a Contents view, which contains the navigation tree for the information center.
The navigation pane contains a Contents view, which contains the navigation tree for the information center.
Do not use. Use “menu” if possible. Use “pop-up menu” if you must emphasize how the menu functions.
context-sensitive help n
Use “context-sensitive help” when you are describing how to create different types of help information. When addressing users of help, use just “help.”
contextual help adj
Do not use to describe how to use the help. Use “help” when you are addressing users of help. Use “context-sensitive help” when you are describing how to create different types of help information.
Do not use in customer information to describe how to use the help. Instead, describe the help in terms of how the user accesses it. If you are describing how to create different types of help information, use “context-sensitive help.”
control logical unit n
Use “control logical unit,” not “controlling logical unit” or “control point logical unit.”
If you are describing the logical unit in a Transaction Processing Facility (TPF) type 2.1 node that is used to pass private protocol request units between the TPF type 2.1 node and the logon manager, use “control logical unit,” not “controlling logical unit” or “control point logical unit.”
control point logical unit n
Do not use. Use “control logical unit.”
If you are describing the logical unit in a Transaction Processing Facility (TPF) type 2.1 node that is used to pass private protocol request units between the TPF type 2.1 node and the logon manager, use “control logical unit,” not “controlling logical unit” or “control point logical unit.”
control-click v
Do not use. Use “press Control while you click” for novice users. Use “press Control and click” for experienced users.
controlling logical unit n
Do not use. Use “control logical unit.”
If you are describing the logical unit in a Transaction Processing Facility (TPF) type 2.1 node that is used to pass private protocol request units between the TPF type 2.1 node and the logon manager, use “control logical unit,” not “controlling logical unit” or “control point logical unit.”
conversion n
Use “conversion,” not “translation,” to refer to the conversion of internal data to a different format.
converter n
Spell as shown - not “convertor.”
coordinated universal time n
Do not use “coordinated universal time” (UTC) and “Greenwich mean time” (GMT) interchangeably.
Coordinated universal time (UTC) is the time scale, based on the Système International (SI) second, as defined and recommended by the Comité Consultatif International de la Radio (CCIR) and maintained (using an atomic clock) by the Bureau International des Poids et Mesures (BIPM). The Système International is based on three fundamental units of measure (the meter, the kilogram, and the second) and is sometimes called the “MKS system” because of these units. For most practical purposes, UTC is equivalent to the mean solar time at the prime meridian (0 degrees longitude) of Greenwich, England, which is known as Greenwich mean time. UTC is sometimes called Z time or Zulu time, although this is not preferred.
Use only as a verb. Use “corrupted” for the adjective form (for example, “The file is corrupted”).
corrupted adj
Use “corrupted,” not “corrupt” (for example, “The file is corrupted”).
could v
Do not use in the present tense to mean “might” or “can.” Use only in the past conditional form, for example, “files that could not be identified.”
CPC n
Use “CPC,” not “CEC (central electronic complex).”
CPO adj
Do not use. Use “spooling.”
CPP adj
Do not use. Use “spooling.”
CPU n
Use “central processing unit” and its abbreviation, “CPU,” only when the terms are used explicitly in the product interface. Otherwise, use “processor” or “microprocessor.”
“CPU,” or “central processing unit,” is an older term for “processor” or “microprocessor.”
crash v
Use a more specific term, such as “fail.”
criteria n
Use only as a plural noun. For the singular form, use “criterion.”
criterion n
Use as a singular noun. Use “criteria” only as a plural noun.
cross-reference n
Write as shown - hyphenated.
CRUD adj
Do not use. Use “create, retrieve, update, and delete.”
CS/2 n
Do not use. Use “Communications Server for OS/2,” or when space is limited, use “CS OS/2.”
CS/390 n
Do not use. Use “Communications Server for OS/390,” or when space is limited, use “CS OS/390®.”
CS/AIX n
Do not use. Use “Communications Server for AIX.”
CS/NT n
Do not use. Use “Communications Server for Windows NT.”
Ctrl-click v
Do not use. Use “press Ctrl while you click” for novice users. Use “press Ctrl and click” for experienced users.
In software development, use “customer” to refer to an individual who uses a product or service.
In a software development context, “customer” is generally used to refer to the role for whom an offering is being designed and developed. In marketing content, however, do not use “customer”; use “client” instead.
D
daemon n
Spell as shown - not “demon.”
DASD n
Use “DASD,” or “direct access storage device,” only when a more specific term, such as “hard disk drive” or the specific storage-device name, cannot be used.
data n
Use as a singular noun with a singular verb, even though “data” is the plural of “datum.”
data file n
Write as shown - two words.
data flow n
Write as shown - two words.
data mart n
Write as shown - two words.
data pool n
Write as shown - two words.
data set n
Write as shown - two words.
data sheet n
Write as shown - two words.
data source n
Write as shown - two words.
data store n
Write as shown - two words.
data type n
Write as shown - two words - unless you are using it as a variable.
database n
Write as shown - one word.
datatype n
Use only as a variable. Otherwise, use “data type.”
datum n
Do not use. Use “data” as a singular noun with a singular verb.
Do not use. Use the specific name or function of the plug-in adapter that you are referring to.
daylight saving time n
Write as shown - all lowercase and with the singular “saving.”
dc n
For the abbreviation of “direct current,” write in lowercase - “dc”.
DD statement n
Spell as shown. Do not use as a synonym for “ddname.”
ddname n
Spell as shown - all lowercase - to represent the name of a DD statement. Do not use “ddname” to mean “DD statement.”
DDNAME n
Do not use. Use “ddname.”
deactivate v
Use “deactivate,” not “inactivate.”
deallocate v
Use “deallocate,” not “unallocate.”
deblock v
Use “unblock” except in CICS information.
debuggable adj
Do not use. Rephrase the sentence to use the verb or noun “debug.” For example, change “You must rebuild the debuggable version” to “You must rebuild the version that can be debugged.”
decompress v
Do not use to refer to restoring files that were compressed by using a compression utility. Use “extract.”
deconfigure v
Do not use. Use “unconfigure.”
deinstall v
Do not use. Use “uninstall.”
deinstallation n
Do not use. Use “uninstallation.”
demilitarized zone n
Do not use “demilitarized zone,” which has military connotations, or “perimeter network.” Use “DMZ.”
A “DMZ,” also referred to in the industry as a “demilitarized zone” or “perimeter network,” is a configuration that includes multiple firewalls, which add layers of protection between a corporate intranet and a public network, such as the Internet.
demo v
Do not use, except in marketing content. Use “demonstrate.”
demo n
Do not use, except in marketing content. Use “demonstration.”
Do not use to describe a program that runs unattended. Use “daemon.”
demonstrate v
Use “demonstrate,” not “demo.”
demonstration n
Use “demonstration,” not “demo.”
demount v
Use “demount” except in information for a UNIX system, such as AIX. In that case, use “unmount” or “remove.”
deploy v
Use only as a verb. The noun or adjective is “deployment.”
deploy n
Do not use, as in “the deploy.” Use “deployment.”
deploy adj
Do not use, as in “the deploy code.” Use “deployment” (for example, “deployment code”).
depress v
Do not use to refer to pressing keys, buttons, or latches or typing on a keyboard. Use “press” or “type” to refer to a keyboard, and use “press” to refer to hardware devices.
deregister v
Do not use. Use “unregister.”
descendant adj, n
Spell as shown - not “descendent.”
descendent adj, n
Do not use. Use “descendant.”
deselect v
Do not use to refer to removing a mark from a check box. Use “clear.” Use instead of “unselect” in other situations.
designed to v
In technical information, do not write “designed to” to describe a concrete product function. For example, do not write “product X is designed to provide...”; instead, write “product X provides...”
In some situations, it is appropriate to use “designed to,” for example, to refer to potential performance benefits but ensure that you do not make a false claim.
desire v
Do not use. Use “want.”
desired adj
Do not use. Use “required” or “the <item> that you want.”
destroy v
Do not use to indicate removal of an object from a database. Write specifically what happens to the object, such as “delete from the database.”
Use “developer kit,” “Java developer kit,” or “Java SDK” as a generic reference to a developer kit that is not from Oracle.
diagnostic n
Do not use as a noun. Use “diagnostics.” Use “diagnostic” only as an adjective (for example, “the diagnostic tests”).
diagnostic adj
Use only as an adjective (for example, “diagnostic tests”). Do not use as a noun.
“Diagnostic” is an adjective and should be followed by the noun that it is modifying (for example, “tests”).
diagnostics n
Use as an alternative to “diagnostic tests.”
dial-up adj
Write as shown - hyphenated. Do not use as a noun, only as an adjective (for example, “the dial-up connection”).
dialog n
Spell as shown to refer to communication with a computer - not “dialogue.” Spell as “dialogue” only when referring to a conversation between people. Do not use “dialog” for “dialog box.” Use “dialog box” only in technical information for programmers, where it is important to distinguish the different parts of the interface. For most user information, use “window” when referring to a graphical interface.
dialog box n
Use only in technical information for programmers where it is important to distinguish parts of the interface. Do not use “dialog” or “dialogue box.” For most user information, use “window” when referring to a graphical interface.
A dialog box is a secondary window that gathers additional information from the user.
dialogue n
Use “dialogue” only to refer to a conversation between people. Use “dialog” when referring to communication with a computer.
dimmed adj
Do not use. If an interface control is displayed but is not available, use “disabled.” If the control is not displayed, use “unavailable.”
direct access storage device n
Use “direct access storage device,” or “DASD,” only when a more specific term, such as “hard disk drive” or the specific storage-device name, cannot be used.
disable v
Do not use to refer to making something ineffective or incapable. Use only to describe the act of making an interface control or product function unavailable for users of the product.
disabled adj
Use only to describe an interface control that is displayed but is not available or a product function that has been made unavailable. If the interface control is not displayed, use “unavailable,” not “disabled.”
disc n
Spell as shown only for “compact disc” and “digital video disc.” Otherwise use “disk.”
Do not use to refer to describing a subject in written information. For example, write “The following section contains information about...” not “The following section discusses...”
disk n
Spell as shown for all types of disks except compact discs and digital video discs.
dismount v
Do not use. Use “demount” except in information for a UNIX system, such as AIX. In that case, use “unmount” or “remove.”
display v
Use only as a transitive verb. For example, write “the message is displayed” or “the system displays a message,” not “the message displays.”
DMZ n
Use in preference to “demilitarized zone.” Do not use “perimeter network.”
A “DMZ,” also referred to in the industry as a “demilitarized zone” or “perimeter network,” is a configuration that includes multiple firewalls, which add layers of protection between a corporate intranet and a public network, such as the Internet.
DO-WHILE, Do-While, do-while adj
Write the programming statement as shown - hyphenated - and follow the capitalization convention of the programming language.
domestic adj
Do not use “domestic” and “foreign” to differentiate geographic locations. Use the names of the respective countries or regions, or use phrases such as “United States only” and “countries other than the United States.”
DOS environment n
Do not use. Use “DOS session.”
DOS session n
Use “DOS session,” not “DOS environment” or “virtual DOS machine.”
dotted decimal adj
Write as shown - not hyphenated.
double quotation mark n
Write as shown to refer to the double quotation mark (") character. Use “quotation mark” to refer generically to a single quotation mark (') or a double quotation mark (") character.
Typically, use the straight keyboard character (") as a double quotation mark. Word processors often distinguish between left double quotation marks (“) and right double quotation marks (”).
double quote n
Do not use. Use “double quotation mark.”
double quote mark n
Do not use. Use “double quotation mark.”
double-byte adj
Write as shown - hyphenated.
Write as shown - hyphenated. Also, use “double-click,” not “double-click on” to describe the action.
double-click on v
Do not use. Use “double-click.”
doubleword n
Write as shown - one word.
downlevel, down-level adj
Do not use. Use “earlier, “previous,” or “not at the latest level.”
downtime n
Write as shown - one word.
downward compatible adj
Do not use. Use “compatible with earlier versions.”
drag and drop v
Do not use. Use “drag,” which includes the action of dropping an object.
drag-and-drop adj
Write as shown when used as an adjective - hyphenated.
drill down n
Do not use as a noun. Use only as a verb.
drill down v
Write as shown - two words - and use only as a verb (for example, “Drill down to the folder that contains your file”).
drill up v
Do not use. “Drill up” is jargon and should not be used in technical information. Use “navigate.”
drilldown n
Do not use as a noun. Use only as a verb, and write as two words - “drill down.”
driver n
Use “device drive,” “network drive,” or another appropriate descriptive qualifier on first occurrence in a topic or paragraph. Use “driver” alone only when you are referring to the circuit that sends signals to a device.
drop-down adj
Use only if you must specify the type of menu or list.
due to prep
Do not use to mean “because of.” Use “due to” only in adjectival clauses. Although the use of “due to” as a synonym of “because of” has some acceptance in modern English usage, it is imprecise and, therefore, not suited to technical writing.
Incorrect: “Due to the power failure, the update stopped.” Correct: “Because of the power failure, the update stopped.” Correct: “The power failure was due to an electrical storm.”
dump n
Use carefully to avoid unintentionally offensive phrasing, such as “take a dump.” Preferred usage includes the modifier “memory” (for example, “When the program ends abnormally, it creates a memory dump.”).
Do not use. Use “dump file.”
DVD drive n
Use if the read/write characteristic of the drive varies, cannot be predicted, or is irrelevant.
DVD-ROM n
Use only if you must specify that the DVD is read only; otherwise, use “DVD.” Do not use to refer to a “digital video disc.”
DVD-ROM drive n
If the read/write characteristic of the drive varies, cannot be predicted, or is irrelevant, use “DVD drive.”
DVD-RW drive n
If the read/write characteristic of the drive varies, cannot be predicted, or is irrelevant, use “DVD drive.”
E
e, e- adj
Do not create terms using the prefix “e” or “e-.”
e-book adj, n
Do not use. Use “ebook.”
e-commerce n
Do not use to mean the subset of electronic business that involves the exchange of money for goods or services purchased over an electronic medium such as the Internet. Use the term only as part of a product name; otherwise, use a term such as “online business” or “electronic business.”
e-fix n
Do not use. Use the appropriate term, such as “fix,” “interim fix,” “program temporary fix,” or “test fix.”
e-mail adj, n
Do not use. Use “email.”
e.g. conj
Do not use. Use “for example.”
earlier adv
Use to refer to a previous software version or fix level.
ebook adj, n
Write as shown - one word. If this term occurs at the beginning of a sentence or title, use “Ebook.”
EEPROM n
This abbreviation stands for “electrically erasable programmable read-only memory,” not “electronically erasable programmable read-only memory.”
EEPROM is a special type of PROM that can be erased by exposing it to an electrical charge.
eFix n
Do not use. Use the appropriate term, such as “fix,” “interim fix,” “program temporary fix,” or “test fix.”
Use to mean “any one of two.”
Although “either” can be used to mean “each,” as in “close the latch on either side of the cover,” avoid this usage. Use “each” to avoid confusion or imprecision.
EJB adj
Use only as an adjective, as in “EJB server” or “EJB component.”
The artifact that is created by EJB programmers is called enterprise beans, EJB beans, or EJB components, not EJBs. Note that if the noun following “EJB” is uppercase, you should consult your IPL, because the term is a proper noun.
email adj, n
Write as shown - one word. If this term occurs at the beginning of a sentence or title, use “Email.”
email v
Do not use as a verb. Use only as an adjective or noun, such as in “Send an email.”
embed v
Write as shown - not “imbed.”
enable v
Use to describe the action of making an interface control or product function available to users. Avoid stating that inanimate objects grant abilities to people, as in “the product enables you to...” Whenever possible, use a direct, user-focused alternative such as “you can use the product to...” or “with this product, users can...”
enabled adj
Use only to describe an interface control or a product function that has been made available.
An interface control or product function that is enabled can also be disabled.
end user n
Do not use. Use “user.”
end-user interface n
Do not use. Use “graphical interface” or “interface.”
endpoint n
Write as shown - one word.
ensure v
Write as shown - not “insure,” except in the context of an insurance policy.
enter v
Use to refer to entering text in fields in a graphical interface. Alternately, use “type.” Use “type,” “enter,” or “issue” to refer to entering a command on a command line or at a command prompt; use one term consistently throughout your information.
errata n
Use only as a plural noun. For the singular form, use “erratum.”
erratum n
Use as a singular noun. Use “errata” only as a plural noun.
Write as shown - not “error,” to refer to a message that notifies the user of an error. Use “message” as a generic term to refer to an informational message, a warning message, or an error message.
etc. n
Do not use. Use “and so on” when you list a clear sequence of elements, such as “1, 2, 3, and so on” or “Monday, Tuesday, Wednesday, and so on.” When you list items that do not form a clear sequence, use appropriate descriptive wording, such as “device drivers, firmware, and other code.”
Ethernet n
Write as shown - with an initial uppercase “E”.
EUI n
Do not use “end-user interface” or “EUI.” Use “graphical user interface” or “interface.”
euro n
Write as shown - lowercase.
The word “euro” has a lowercase initial “e,” just as the United States “dollar” has a lowercase initial “d.” Although the European Union specifies “euro” as the plural form in its own official publications, use the usual English plural form by adding an “s.” This usual usage has been authorized by the EU and adopted by many publishers.
EuroReady adj
Write as shown.
executable adj
Use only as an adjective, followed by the noun that it is modifying (for example, “executable program” or “executable routine”).
execute v
Use only in technical documentation and only if a simpler, less technical term, such as “run” or “issue,” or a more specific term, such as “start” or “enter,” is inappropriate. If “execute” is used as a keyword, you can use it in related text to maintain consistency.
exit adj, n
Do not use to mean “exit routine” or “exit program.”
Use “exit” as a noun only to refer to the point in a program from which control exits and goes to an external exit routine or exit program.
exploit v
Use only to mean “to make productive use of.” In most cases, write “use.” “Exploit” can have negative connotations, implying that an unfair advantage is being gained.
exportation n
Use only in the context of shipping goods and services. Do not use to refer to moving data or files - use “export” as an adjective, followed by a noun (for example, “export operation” or “export process”).
extract v
Write as shown - not “decompress” or “unzip,” to refer to restoring files that were compressed with a compression utility.
F
fail back v
Write as shown - two words - when used as a verb.
fail over v
Write as shown - two words - when used as a verb.
failback n
Write as shown - one word - when used as a noun or adjective.
failover n
Write as shown - one word - when used as a noun or adjective.
family name n
Use only when it is necessary to distinguish a family name from other types of surnames, or if you need to be consistent with external material that uses “family name” as a synonym of “surname.” In most cases, use “surname.”
farther, farthest adv
Use “farther” and “farthest” to express a physical distance. Do not use “further” or “furthest.”
fast path n
Write as shown - two words. Do not use initial uppercase letters, unless “fast path” is part of a product name or feature name.
fast-path adj
Write as shown - hyphenated.
fatal adj
Use only to refer to situations resulting in death, and not to refer to the failure of a program or application. Use “unrecoverable” or other wording that indicates that an operation is disrupted.
This term is typically used in hardware documentation.
fax n
Write as shown - lowercase.
fiber adj
Spell as shown, except in the special case of “Fibre Channel,” where the U.K. English spelling of “fibre” has been adopted. For example, refer to “fiber-optic” and “multimode fiber.”
Fibre Channel n
Spell as shown to refer to the Fibre Channel standard.
Fibre Channel adj
Spell as shown to refer specifically to the standard, as in “Fibre Channel standard” and “Fibre Channel Protocol.” Do not hyphenate this term in its adjective form.
field n
In most cases, write as shown; do not use “text field” or “text entry field.” For example, write “the User ID field” rather than “the User ID text field.” Use a qualifier such as “entry” if necessary to distinguish between different types of fields for a specific audience such as programmers.
Write as shown - two words - unless you are using it as a variable.
file name n
Write as shown - two words - unless you are using it as a variable.
file set n
Write as shown - two words - unless you are using it in the context of a UNIX system (such as AIX), in which case it is one word (fileset).
file system n
Write as shown - two words.
file type n
Write as shown - two words - unless you are using it as a variable.
filemode n
Use only as a variable. Otherwise, use “file mode.”
filename n
Use only as a variable. Otherwise, use “file name.”
filetype n
Use only as a variable. Otherwise, use “file type.”
fill in v
Do not use. Use a more precise verb, such as “complete,” “enter,” or “specify.”
Examples: (1) “Complete the remarks section.” (2) “Enter the name and address.” (3) “Specify the job queue parameter.”
firewall n
Write as shown - one word.
first name n
Do not use. Use “given name,” not “first name” or “Christian name,” to refer to the name that is used to identify an individual within a group, such as a family.
fix pack n
Write as shown - lowercase - in the generic sense. Use initial uppercase letters only when referring to a specific fix pack number, as in “Next, install Fix Pack 2.”
fixed disk drive n
Do not use. Use “hard disk drive.”
flash v
Use “flash,” not “blink,” to refer to indicator lights.
flash memory n
Write as shown - lowercase. Do not use “flash storage.”
flash storage n
Do not use. Use “flash memory.”
floppy, floppy disk, floppy drive n
Do not use. Use “diskette” and “diskette drive.”
Do not use to refer to a type of lighting. Use “fluorescent.”
fluorescent adj
Spell as shown - not “florescent” - to refer to a type of lighting.
FOD n
Do not use. Use “Files On-Demand.”
following n
Do not use as a noun except to refer to a group of followers, adherents, or partisans. For example, do not write “Do the following” or “The functions include the following” as lead-in wording to a list. Use “following” only as an adjective, as in “Complete the following steps” or “The adapter has the following functions.”
foo, foobar n
Do not use. These terms are variants of an acronym of a profanity that is sometimes used by developers in code. If you see either term in sample code, revise the example or do not publish it. Rewrite any text to omit these terms.
foot-pound n
Write as shown - hyphenated.
In the metric system, torque is measured in newton-meters. One newton-meter equals 0.738 foot-pound; one foot-pound equals 1.356 newton-meters.
for instance adv
Do not use. Use “for example.”
foreign adj
Do not use to differentiate geographic locations. Use the names of the respective countries or regions, or use phrases such as “United States only” and “countries other than the United States.”
forward compatible adj
Do not use. Use “compatible with later versions.”
forward slash n
Write as shown to refer to the / character.
free adj, adv
Do not use when referring to money or financial transactions. Use “at no cost” or “at no initial cost.”
Some companies interpret “free” to mean free for the life of the product. Because this meaning is rarely the intent of marketers, use of the term can result in legal problems.
FTP v
Do not use as a verb, as in “FTP the file.” Use only as a noun or adjective, as an abbreviation for File Transfer Protocol, for example, “Use FTP to copy the file.”
fubar n
Do not use. This term is an acronym of a profanity that is sometimes used by developers in code. If you see this term in sample code, revise the example or do not publish it. Rewrite any text to omit the term.
fullword adj, n
Write as shown - one word.
Use only to refer to a set of functions and their specified properties. Consider using a simpler term, for example “functions.”
further, furthest adj
Use to express a degree or quantity, not a physical distance. To express a physical distance, use “farther” and “farthest.”
G
gauge n, v
Spell as shown - “gauge.”
generally adv
Use to mean “in disregard of specific instances” or “in all instances.” For example, write “Generally, hot-swap devices can be removed and replaced while the server is operating.”
The definitions of “generally,” “normally,” “typically,” and “usually” are similar, and in some cases, more than one of these terms might be applicable. Use your judgment in deciding which term best applies.
geography n
Do not use to mean “geographical area.” For example, do not write, “This version is available in all geographies.” Write, for example, “This version is available worldwide.”
given adj
Do not use to mean “particular” or “specific.” Consider whether any adjective is necessary.
In many cases, no adjective is necessary. For example, in the sentence “Select this choice to enable a DIMM connector,” no adjective is necessary before “DIMM.”
given name n
Use “given name,” not “first name” or “Christian name,” to refer to the name that is used to identify an individual within a group, such as a family.
GMT n
Do not use “Greenwich mean time” (GMT) and “coordinated universal time” (UTC) interchangeably.
Greenwich mean time (GMT) is the mean solar time at the prime meridian (0 degrees longitude) of Greenwich, England. Greenwich mean time is sometimes called Z time or Zulu time. Although Greenwich mean time and coordinated universal time are sometimes used interchangeably, they are not synonyms. Greenwich mean time is an approximate time. Because the second is no longer defined in terms of astronomical phenomena, the preferred name for this time scale is coordinated universal time (UTC).
graphical user interface, GUI n
Use these terms if you know that your intended audience is familiar and comfortable with what they represent, but in most cases you can write instructions that tell how to access the graphical user interface without using a generic noun.
Avoid “in the GUI, do this” or “in the interface, do that.” In tasks, refer to the specific part of the graphical user interface, such as the name of a window, field, pane, or view. Use “GUI” or “graphical user interface” when you need contrast with named non-GUI components or character-based interfaces, such as a command-line interface.
gray adj
Spell as shown - not “grey.”
Do not use. If an interface control is displayed but is not available, use “disabled.” If the control is not displayed, use “unavailable.”
Although the terms “grayed” and “grayed out” are widely used within the computer industry, they are nevertheless jargon and can cause accessibility problems.
green screen n
In most cases, use a more precise term such as “3270 application,” “5250 application,” or “character-based interface.”
“Green screen” is occasionally used to refer to monochrome display devices. However, the term “green screen” has a different meaning in the film and video industry, and it probably means little to translators or to a younger generation of programmers. Use more precise terms to refer to 3270 or 5250 applications, data streams, or emulation mode. If you need a term to contrast with “GUI,” use “character-based interface.” If you must use “green screen,” for example because you believe your audience will use it as a search term, enclose the first occurrence in quotation marks to indicate that it is a nonstandard term, clarify what it means, and thereafter use preferred alternatives. For example, write “You can use this tool to add a web interface to 5250 character-based applications (sometimes called “green screen applications”)” and then, having established the equivalence, use “5250 application” for subsequent references in the same document.
Greenwich mean time n
Do not use “Greenwich mean time” (GMT) and “coordinated universal time” (UTC) interchangeably.
Greenwich mean time (GMT) is the mean solar time at the prime meridian (0 degrees longitude) of Greenwich, England. Greenwich mean time is sometimes called Z time or Zulu time. Although Greenwich mean time and coordinated universal time are sometimes used interchangeably, they are not synonyms. Greenwich mean time is an approximate time. Because the second is no longer defined in terms of astronomical phenomena, the preferred name for this time scale is coordinated universal time (UTC).
grey adj
Do not use. Use “gray.”
group ID n
Write as shown - two words with “ID” in uppercase.
H
halfword adj, n
Write as shown - one word.
handheld adj
Write as shown - one word. Do not use as a noun.
hard boot n
Do not use. Use “Turn the system off and then back on” or “Restart the system.”
hard copy n
Do not use. Use “hardcopy.”
hard disk n
Use to refer to the disk in a hard disk drive.
Write as shown - no hyphenation. “Hard disk” is a common short form, but the longer, more complete term is preferred. Do not use “hard file.”
Ensure that indexes and metadata include “hard file” for users who search for that term.
hard drive n
Do not use. Use “hard disk” or “hard disk drive” as appropriate.
hard file n
Do not use. Use “hard disk” or “hard disk drive” as appropriate.
hardcopy n
Write as shown - one word.
hash, hash sign n
Use “number sign” to refer to the # character unless you are writing information exclusively for a UK audience.
have to v
Use “have to” only when the use of “must” is too restrictive. For example, “you do not have to...” is not the same as “you must not...”
If an action must be performed, use “must,” not “have to”; for example instead of “you have to format the diskette,” write “you must format the diskette.” Consider using imperative mood: “Format the diskette.” However, write “you might have to format the diskette” when you want to convey that circumstances determine whether you format it; in such cases, “you must format the diskette” clearly would be inaccurate.
headless adj
Use only when it is part of the standard terminology of a product. In most cases use an expression such as “from a command prompt” or “without the Eclipse user interface.”
If you must use “headless,” explain what it means in your context and put it in quotation marks. Never use as an adverb, for example, “running headless”; use only as an adjective, for example, “running in “headless” mode.”
health n
Use only when it is part of the standard terminology of a product. Otherwise, use “condition,” “state,” or another appropriate term.
healthy adj
Use only when it is part of the terminology of a product. Otherwise, use “working correctly” or another appropriate term.
heat sink n
Write as shown - two words.
help n
Write as shown - lowercase.
higher adv
Do not use to describe versions of software or fix packs. Use “later.”
hit v
Do not use to refer to pressing keys or typing on a keyboard. Use “press” or “type.”
Write as shown - two words, lowercase. “Home page” has an initial uppercase “H” only when it is part of a proper noun.
The terms “home page,” “web page,” and “website” have different meanings and should not be used interchangeably.
host ID n
Write as shown - two words with “ID” in uppercase.
host name n
Write as shown - two words.
hostfile n
Use only as a variable. Otherwise, use “host file” or “hosts file.”
hostname n
Use only as a variable. Otherwise, use “host name.”
hover help n
Write as shown - two words. Use “hover help,” not “tooltip” to refer to explanatory text, rich text, or links that can be viewed by moving a cursor over a graphical user interface (GUI) element, such as an icon, field, or text string.
The term “tooltip” refers to a brief, plain text description that is displayed when a cursor is moved over a graphical image, such as an icon, that does not otherwise have a label.
how-to adj
Write as shown - hyphenated and lowercase. For example, refer to a “how-to procedure.” Do not use as a noun.
HOWTO n
Do not use. Use “how-to” (lowercase and hyphenated) only as an adjective (for example, “how-to procedure”).
I
i-fix n
Do not use. Use “interim fix.”
i.e. conj
Do not use. Use “that is.”
I/O adj
Write the abbreviation of “input/output” as shown - uppercase with a forward slash.
ID n
Write the abbreviation of “identification” or “identifier” as shown - all uppercase (for example, “user ID”).
if...then conj
Avoid using “then” to introduce an independent clause that follows an “if” clause. For example, write “If you set a password, access is restricted,” not “If you set a password, then access is restricted.”
Use the “if...then” construction only to clarify that a conditional relationship exists between two actions or events. For example, the “if...then” construction can improve clarity when you are joining two long clauses.
Do not use. Use “IF-THEN,” “If-Then,” or “if-then” according to the capitalization convention of the programming language.
if v. whether conj
Use “if” to express a condition and “whether” to express an alternative.
Example of correct usage: “If the job is canceled, you must determine whether any other jobs exist.”
Example of incorrect usage: “Inform the administrator if the printer has been started.” This second example can have either of the following meanings: 1. If the printer has been started, tell the administrator. (Tell the administrator only if the printer has been started.) 2. Tell the administrator whether the printer has been started. (Regardless of the situation, you must tell the administrator.)
IF-THEN, If-Then, if-then adj
Write as shown - hyphenated and using the capitalization convention of the programming language.
iFix n
Do not use. Use “interim fix.”
ifix n
Do not use. Use “interim fix.”
illegal adj
Use only for matters of law. Otherwise, use a term such as “invalid,” “not allowed,” or “incorrect.”
illuminate v
Use only as a transitive verb. For example, write “the light is illuminated,” not “the light illuminates.”
imbed v
Do not use. Use “embed.”
impact v
Use only to mean “to strike forcefully.” Otherwise, use “affect.”
importation n
Use only to refer to shipping goods from one country to another. Do not use to refer to moving data or files; use “import” as an adjective, followed by an appropriate noun (for example, “import operation” or “import process”).
in conjunction with prep
Use “with” in most cases to avoid wordiness.
in depth adj
Do not use. Use “in-depth.”
in line adj
Do not use. Use “inline.”
in order to prep
Use “to” in most cases to avoid wordiness.
in other words prep
Do not use. Use “for example” or “that is.” Ideally, state the original information clearly so that it does not require explanation.
Do not use. Use “regardless of” or “despite.”
in the event conj
Do not use. Use “in case,” “if,” or “when.”
in-depth adj
Write as shown - hyphenated.
in-line adj
Do not use. Use “inline.”
inactivate v
Do not use. Use “deactivate.”
inactive adj
Do not use to refer to an interface control. If an interface control is displayed but is not available, use “disabled.” If the control is not displayed, use “unavailable.”
inch pound n
Do not use for the imperial measurement of torque. Use “inch-pound.”
inch-pound n
Write the imperial measurement of torque as shown - hyphenated.
In the metric system, torque is measured in newton-meters. One newton-meter equals 8.851 inch-pounds; one inch-pound equals 0.113 newton-meter.
indexes n
Use “indexes” for the plural of “index” unless the context requires “indices,” such as in mathematics.
indices n
Use “indexes” for the plural of “index” unless the context requires “indices,” such as in mathematics.
infinite adj
Do not use to refer to a large or indeterminate quantity, as in “an infinite number of color combinations.” Use an actual number or a scale that relates to a number, as in “more than 1,000,000 color combinations.”
info center, infocenter n
Do not use. Use “information center.”
infopop n
Do not use. Use “pop-up help.”
information about prep
Use “information about,” not “information on.”
information center n
For a generic reference, write as shown - two words, lowercase. To refer to a specific information center, use uppercase “I” and uppercase “C” (for example, “WebSphere Application Server Information Center”).
information on prep
Do not use. Use “information about.”
initial capital letters n
Write as shown - do not abbreviate to “initial caps.”
Do not use. Use “initial capital letters.”
inline adj
Write as shown - one word, unhyphenated.
input v
Do not use as a verb. Use “type” or “enter” as appropriate.
input-output adj, n
Write as “input/output” except where the hyphenated spelling is established, such as in COBOL.
input/output adj, n
Write as shown, with a forward slash, except where the hyphenated spelling is established, such as in COBOL.
install adj, n
Do not use as an adjective or a noun. Use “installation.”
install v
Use only as a verb. For the adjective and the noun, use “installation.”
installation adj, n
Use as an adjective and as a noun, not “install.”
InstallShield adj
Do not use to refer to an installation program that was created by using the InstallShield product. Use “installation program” or “installation wizard.”
InstallShield is a trademark of another company.
instant message n
Use only as a noun.
instant message v
Do not use as a verb. Use wording such as “send an instant message.”
insure v
Do not use. Use “ensure.”
interim fix n
Write as shown - two words, lowercase, no abbreviation.
internationalization n
Do not use.
internet n
Write with a lowercase “i” to refer to a general collection of interconnected networks that use the Internet suite of protocols.
Internet n
Write with an uppercase “I” to refer to the well-known, worldwide collection of interconnected networks that use the Internet suite of protocols and that permits universal public access.
Internet address n
Do not use. Use “Internet Protocol address” or “IP address.”
Use “Internet Protocol address” or “IP address,” not “Internet address.”
intranet n
Write as shown - lowercase. Use to refer to an internet that has restricted access, such as in an enterprise or organization.
invoke v
Use a simpler term, such as “start” or “call,” if it conveys the same meaning.
Although “invoke” is prevalent in the industry, it might cause problems for translators and readers whose first language is not English.
io adj
Do not use as the abbreviation of “input/output.” Use “I/O”.
IP address n
Use “IP address” or “Internet Protocol address,” not “Internet address.”
IPL v
Do not use this abbreviation of “initial program load” as a verb, as in “The system engineer IPLed the system.” Use wording such as “The system engineer loaded the initial program.”
irrecoverable adj
Do not use. Use “unrecoverable.”
issue v
Use “type,” “enter,” or “issue” to refer to entering a command on a command line or at a command prompt. Use one term consistently throughout your information.
IT Resources Optimization n
Do not use. Use wording such as “optimization of IT resources.”
IT Resources Optimization is a trademark of another company.
ITRO n
Do not use. Use wording such as “optimization of IT resources.”
J
jar v
Do not use to refer to the creation of a Java archive (JAR) file. Use a verb such as “compress” or “archive.”
Java Development Kit n
Use only to refer to a developer kit from Oracle. For a generic reference, use “developer kit,” “Java developer kit,” or “Java SDK.”
Java SDK n
Use “Java SDK,” “Java developer kit,” or “developer kit” as a generic reference to a developer kit that is not from Oracle.
JavaBean n
Do not use. Use “JavaBeans.”
Write as shown - one word, uppercase “J,” uppercase “B,” plural.
Javadoc, Javadocs, javadocs n
Do not use as a noun. To refer to the output of the Javadoc tool, use “Javadoc information,” “Javadoc HTML documentation,” “API documentation,” or “Java API documentation.”
Javadoc adj
Write as shown - uppercase “J,” singular. Use only as an adjective. For example, use “Javadoc tool” to describe the tool, or use “Javadoc information,” “Javadoc HTML documentation,” “API documentation,” or “Java API documentation” to describe the output of the tool.
The Javadoc tool from Oracle generates API documentation in HTML format from doc comments in source code.
JDK n
Use this abbreviation of “Java Development Kit” only to refer to a developer kit from Oracle. For a generic reference, use “developer kit,” “Java developer kit,” or “Java SDK.”
job log n
Write as shown - two words.
job stream n
Write as shown - two words.
joblog n
Do not use. Use “job log.”
judgment n
Spell as shown - not “judgement.”
K
k n
Write as shown - lowercase - to mean 1000. Use it only in combination with a unit-of-measure abbreviation, such as bps, Hz, g, or m, never by itself.
For example, write “24 kbps,” not “24 k bits per second.”
K n
Write as shown - uppercase - to mean 1024. Use it only in combination with the abbreviations of bits (b) and bytes (B), never by itself.
For example, write “64 KB,” not “64 K.”
See “Multiplier prefixes for bits and bytes” on page 172.
kanji adj
Write as shown - lowercase.
kbps n
Write as shown - lowercase “k.”
Transmission rates are multiples of 1000, not 1024, and the lowercase “k” always means 1000 in the metric system.
Use only in the context of Internet communication.
Do not confuse with the similar but unrelated term “liveness message.”
key v
Do not use. Use “type” or “press.”
keystore n
Write as shown - one word.
kill v
Do not use except when you are documenting a UNIX system, such as AIX. Use “end” or “stop.”
kilobyte n
Use the abbreviation KB or kB, not the spelled-out form. If your audience needs to see the spelled-out form of an abbreviation, include the spelled-out form parenthetically on first use only, and use only the abbreviation in all other occurrences.
In SI metric style, the abbreviation of the prefix kilo is lowercase “k”. However, this guide distinguishes between uppercase “K” (meaning 1024) and lowercase “k” (meaning 1000). Therefore, KB means 1024 bytes, and kB means 1000 bytes.
See “Multiplier prefixes for bits and bytes” on page 172.
L
labeled adj, v
Spell as shown - not “labelled.”
laptop n
Do not use to refer to hardware. Use “notebook” to refer to a mobile computer.
For safety, do not use wording that implies that such a computer can be used while placed on a person’s lap.
last name n
Do not use. Use “surname,” not “last name,” to refer to the name that is used to identify an individual as a member of a group, such as a family, tribe, or caste.
later adv
Use to refer to a subsequent software version or fix level.
launch v
Do not use unless it is part of the terminology of the product that you are documenting. Use “start” or “open.”
launchpad n
Write as shown - one word.
left adj
Use “left,” not “left-hand.”
Left Arrow key n
Write as shown - uppercase “L” and “A” and unhyphenated.
left-align v
Use “left-align,” not “left-justify.”
Write as shown - hyphenated. Use “left-aligned,” not “left-justified,” to refer to text that is aligned at the left margin.
left-hand adj
Do not use. Use “left.”
left-justified adj
Do not use. Use “left-aligned.”
left-justify v
Do not use. Use “left-align.”
leftmost adj
Use to refer to something farthest to the left (for example, on a page or a panel).
legacy adj
Do not use to refer to older software, applications (as in “legacy product”), values, programming languages, or technologies that are being supplemented or replaced. In particular, avoid any implication that a product is old-fashioned or might not include up-to-date technologies. However, it is all right to refer to “legacy data.”
Because this usage can cause problems for our clients, specify the product information without any explanatory adjectives. For products that are still supported, but are not being actively developed, use “existing,” “heritage,” “traditional,” “established,” “mature,” “earlier,” or another appropriate neutral description in preference to “legacy.” To compare an existing value with a newer one, use words showing time relationships, such as “earlier” or “previous.”
let v
Avoid stating that inanimate objects grant abilities to people, as in “the product lets you...” Whenever possible, use a direct, user-focused alternative such as “you can use the product to...” or “with this product, users can...”
leverage v
Do not use in technical information. Write “use.” For example, write “to use the power management mode,” not “to leverage the power management mode.” In marketing content, use this term only to mean to “gain an advantage by the use of something.” For example, write “leverage the experience of 4,400 consultants” or “to leverage your existing service life cycles.”
In technical information, “leverage” does not translate correctly in some languages. Although it is employed widely in marketing content, avoid overuse of the term.
licensed program n
Use “licensed program,” not “program product.”
life cycle n
In most cases, write as shown - two words. Use “lifecycle” (one word) only if it is used in a product interface, is part of an established product name, or is part of the name of an external standard.
life-cycle adj
In most cases, write as shown - hyphenated. Use “lifecycle” (one word) only if it is used in a product interface, is part of an established product name, or is part of the name of an external standard.
light v
Do not use as an intransitive verb. For example, write “the LED is lit,” not “the LED lights.”
Do not use to mean “such as.”
line cord n
Do not use. Use “power cable” or “power cord.”
link-edit v
Write as shown - hyphenated.
link-editing n
Write as shown - hyphenated.
Linux adj
Write as shown - uppercase “L”. Use only to refer to the Linux operating system or the kernel. Do not describe it as a “UNIX system.” Linux is not a certified UNIX system.
lite adj
Avoid using this term to describe or explain that a function or product has limited capabilities. It is appropriate to use the term when it is part of a formal, approved product or function name, but in those instances, it is still preferable to avoid the term in explanatory text.
liveness message n
Use only in the context of High Performance Routing (HPR).
Do not confuse “liveness message” with the similar but unrelated term “keepalive message.”
load v
Do not use as a synonym for “install.”
loadtime n
Do not use. Use the noun “load time” or the adjective “load-time.”
localization n
Do not use.
log file n
Write as shown - two words.
log in v
Write as shown when used as a verb - two words.
log in to v
Write as shown - three words. Use only in documentation for UNIX systems, such as AIX. Otherwise, use “log on to.”
log into v
Do not use. Use “log in to.”
log off v
Write as shown when used as a verb - two words.
log off from v
Write as shown - three words. Do not use “log off of.” In documentation for UNIX systems (such as AIX), use “log off.”
Do not use. Use “log off from.”
log on v
Write as shown when used as a verb - two words.
log on to v
Write as shown - three words.
logfile n
Do not use. Use “log file.”
login adj, n
Write as shown when used as an adjective or noun - one word.
logoff adj, n
Write as shown when used as an adjective or noun - one word.
logon adj, n
Write as shown when used as an adjective or noun - one word.
look and feel n
Do not use. Use wording that more specifically expresses what you mean.
look-and-feel n
In technical information, use wording that more specifically expresses what you mean.
lose v
Do not use to refer to a connection, as in “the connection is lost” or “you lost the connection.” Use “broken.”
lost adj
Do not use to refer to a connection, as in “the connection is lost” or “you lost the connection.” Use “broken.”
lower adv
Do not use to describe versions of software or fix packs. Use “earlier.”
lower left, lower right n
Use “lower left” or “lower right,” not “bottom left” or “bottom right,” to refer to the location of an item in an interface.
Accessibility requirement: People who are blind or have low vision might not be able to understand information if it is conveyed only by location. Provide additional text information other than location. For example, write “The tables are displayed in the Table List pane, which is in the lower right of the window,” not “The list of tables is displayed in the lower right of the window.”
lower-left, lower-right adj
Use “lower-left” or “lower-right,” not “bottom-left” or “bottom-right,” to refer to the location of an item in an interface.
Accessibility requirement: People who are blind or have low vision might not be able to understand information if it is conveyed only by location. Provide additional text information other than location. For example, write “The tables are displayed in the Table List pane, which is in the lower-right corner of the window,” not “The list of tables is displayed in the lower-right corner of the window.”
lowercase adj
Write as shown - one word - to refer to small letters.
The term “lower case” (two words) refers only to one of the two cases in which compositors stored type: the lower case, where they stored small letters.
M
M.V. n
Do not use. Use “major vector.”
machine n
Use a more specific term such as “workstation,” “personal computer,” “server,” or “component.” In the mainframe context, use the name of the operating system followed by the word “system” as in “OS/390 system.”
main directory n
Do not use. Use “root directory.”
makefile n
Write as shown - one word.
manager n
Do not confuse the concept of a client/server model with that of an agent/manager model.
Clients depend on servers, and agents depend on managers. Regarding requests, clients request services from servers, and managers request services from agents.
manipulation button n
Do not use. Use “right mouse button.”
marketing rep n
Do not use. Use “marketing representative.”
marketing representative n
Use “marketing representative,” not “marketing rep” or “sales representative.”
mashup n
Write as shown - one word.
master and slave n
Do not use “slave.” Use “subordinate” to refer to the devices controlled by the master device.
Note that “master and subordinate” are not synonyms of “parent and child.” In a UNIX system (such as AIX), “master and slave” is acceptable usage.
may v
Use only to indicate permission. Otherwise, use “can” or “might.”
“May” is overused in technical information and should in most instances be changed to “can” or “might.”
memory stick n
Do not use.
This term is a trademark of Sony.
Use “USB flash drive.”
menu bar n
Write as shown - two words.
Use “message” as a generic term to refer to an informational message, a warning message, or an error message.
metadata n
Spell as shown - no hyphen.
mice n
Use “mice” as the plural of “mouse.”
microcomputer n
Do not use. Use “personal computer” or “PC”.
midmarket adj, n
Write as shown - one word.
might v
Use “might” to indicate probability or possibility.
migrate v
Do not use to mean “upgrade” or “port.”
The terms “migrate,” “upgrade,” and “port” are not synonyms. To migrate is to move data, users, or applications to a new program, platform, or environment. Migration can occur between unlike systems, for example, between two different vendors’ databases, and migrating usually involves more work than upgrading. To upgrade is to replace software with a new release or fix level of the same program or to replace hardware with a newer model or more powerful technology. An upgrade involves little work on the user’s part. To port is to move an application program from the operating system for which it was developed to a different operating system. Porting requires less effort than redevelopment. With open technologies such as Java, porting might require no extra work at all.
mixed case adj
Hyphenate the term if you use it before a noun that it modifies (for example, “a mixed-case password”).
mobile adj
Use “mobile” only as a general term to refer to notebooks and handheld devices that are employed by a user who is frequently moving among various locations and might be using different types of network connections (for example, dial-up, LAN, or wireless).”
motherboard n
Do not use. Use “system board.”
mount point n
Write as shown - two words.
mouse button 1 n
Do not use. Use “left mouse button.”
mouse button 2 n
Do not use. Use “right mouse button.”
mouse over v
Do not use. Use “point to” or “move the mouse pointer over.”
“Mouse” is not a verb, and “mouse over” is probably impossible to translate.
Use “move” to refer to moving a cursor, not “position.”
multichannel adj
Write as shown - one word.
multijobbing n
Do not use. Use “multitasking.”
multimedia n
Write as shown - one word.
multitasking n
Use “multitasking,” not “multijobbing.”
multitiered adj
Write as shown - one word. Do not use “multi-tier” or “multi-tiered.”
must v
Use “must,” not “have to” or “need to,” unless “must” is too restrictive. For example, “you do not have to...” is not the same as “you must not...”
If an action must be performed, use “must,” not “have to” or “need to”; for example, instead of “you have to format the diskette,” write “you must format the diskette.” Consider using imperative mood: “Format the diskette.” However, write “you might have to format the diskette” when you want to convey that circumstances determine whether you format it; in such cases, “you must format the diskette” clearly would be inaccurate.
MVS® n
Do not confuse “MVS” with “z/OS.”
“MVS” has been used to refer to operating systems such as OS/MVS, MVS/XA, and MVS/ESA. The code that was known as the operating system called MVS/ESA is the basis for z/OS. The combination of MVS/ESA SP-JES2 (or JES3) and MVS Data Facility Product (MVS/DFP or DFSMS/MVS) composed the MVS/ESA operating system. In addition, the old OpenEdition MVS base services were integrated into MVS/ESA SP. Optional features such as OpenEdition MVS Shell and Utilities, OpenEdition MVS Debugger, MICR/OCR, ESCON® Director, and others were also included in MVS/ESA SP. In z/OS, the term “MVS” refers to those services and functions that were provided by the Base Control Program (BCP) of the MVS/ESA operating system. MVS (or BCP, as it is sometimes called) is a base element of z/OS. You might need to use “MVS” as an adjective, but you should do this only if the context requires you to identify the Base Control Program of z/OS. For example, if you are writing about the specific set of commands that deal with the MVS element of z/OS and it is important for the reader to understand that you are referring to only that set of commands (and not to TSO, RACF®, JES2, or JES3 commands), write “MVS commands.”
N
N/A adj
Write as shown to mean “not available” or “not applicable.” Use this abbreviation only when it is not practical to spell it out.
name server n
Write as shown - two words.
Write as shown - one word - to refer to a document at one specific website that identifies the names of particular data elements or attributes used within an XML file.
national language support (NLS) n
Do not use.
national language version (NLV) n
Do not use.
native adj
Avoid this term when a less-ambiguous term such as “local,” “basic,” or “required” is available.
navigate v
Use only when a more direct verb, such as “click,” “select,” “browse,” or “go to,” is not applicable. Use only to provide direction to a location (for example, “Navigate to the directory that contains the files that you want to edit”).
navigation n
Do not use as a noun. For example, do not refer to “the navigation” to describe the Contents view in an information center. Use only as an adjective (for example, “navigation tree”).
It is acceptable to use “navigation” as a noun in an index, where nouns are preferred to gerunds.
navigation pane n
If you have to refer to the left pane in an information center, use “navigation pane.” In general, refer to the views that are displayed in the navigation pane, not the pane itself.
The navigation pane typically displays views such as Contents, Search Results, Index, and Bookmarks.
navigation tree n
Use only to refer to the structure of information center topics. Use “Contents view” to refer to the view that contains the information center contents.
navigator n
Do not use to refer to the navigation pane in an information center. Use “navigation pane,” or use “Contents view” to refer to the view that contains the information center contents.
The term “navigator” is used in some products to describe various product features, such as the graphical resource in a Lotus Notes database that comprises hotspots for users to access different parts of the database. Ensure that you use the term consistently within your product documentation.
need to v
Avoid using “need to” to refer to a requirement that a product or procedure imposes. Use “must” or, in constructions in which “must” is not idiomatically correct, use “have to” or “required to.”
If an action must be performed, prefer “must,” not “need to.” For example, instead of writing “you need to format the diskette,” write “you must format the diskette.” Alternately, consider using imperative mood: “Format the diskette.” For conditional actions, write “you might have to format the diskette.” Avoid “you do not need to format the diskette.” “Need to” implies a requirement that is imposed from within, and “have to” implies a requirement that is imposed from without.
network-centric computing n
Do not use. Use “network computing.”
Do not use “new” to describe products, functions, features, technologies, or standards, other than in topics such as “Summary and changes” or “What’s new” that are updated for each release.
A topic that describes something as “new” might be in circulation long after the “new” item has become established or obsolete.
new-line adj
Do not use. Write “newline.”
newline adj
Write as shown - one word. For example, write “newline character.”
newton-meter n
Write as shown - hyphenated.
In the United States customary system (or the American system), torque is measured in foot-pounds or inch-pounds. One newton-meter equals 0.738 foot-pound or 8.851 inch-pounds; one foot-pound equals 1.356 newton-meters; and one inch-pound equals 0.113 newton-meter.
NFS n
Use “NFS” as an abbreviation for “Network File System,” not “network file server.”
An NFS server is a Network File System server.
no. n
Do not use as an abbreviation of “number.” Spell out “number.”
The abbreviation “no.” causes problems for translation tools. Because the period marks the end of a translatable segment, translation tools would not associate “no.” with the text that follows, and translators might interpret “no.” as the word “no” at the end of a sentence, not as an abbreviation of “number.”
non-English adj
Do not use “non-English” to refer to the language in which information, software, or other text is written. Use “in languages other than English” or “non-English-language.” Use “non-English-language” only as an adjective, as in “non-English-language document.”
nonpageable adj
Use “nonpageable,” not “virtual-equals-real” or “V=R.”
nonpaged adj
Do not use. Use “nonpageable.”
nonrecoverable adj
Do not use. Use “unrecoverable.”
normally adv
Use to mean “in a manner that does not deviate from a standard pattern.” For example, write “The process is running normally.”
The definitions of “generally,” “normally,” “typically,” and “usually” are similar, and in some cases, more than one of these terms might be applicable. Use your judgment in deciding which term best applies.
not available adj
Do not use to refer to an interface control. If an interface control is displayed but is not available, use “disabled”; if the control is not displayed, use “unavailable.”
Use “notebook” to refer to a mobile computer or to an interface element that resembles a physical notebook with pages and tabs.
null adj
Use “null” only as an adjective, for example, “If a field is null.” For the noun form, use “null value,” for example, “Enter a null value.”
It is preferable to use “null” as an adjective because “null” has various interpretations, such as a blank, a zero value, and a class with no members.
NULL adj
Write as shown - uppercase - only if the user is to enter it that way, or if it is a keyword that is spelled that way.
Most occurrences of “null” are not written in uppercase.
number sign n
Use to refer to the # character unless you are writing information exclusively for a UK audience, in which case use “hash sign,” or unless you are writing information exclusively for a US or Canadian audience, in which case use “pound sign.”
numeric adj
Use “numeric,” not “numerical.”
Example: The Date field contains numeric data.
numerical adj
Do not use. Use “numeric.”
Example: The Date field contains numeric data.
NWSAA n
Do not use. Use “NetWare for SAA.”
O
object oriented adj
Hyphenate the term if you use it before a noun that it modifies (for example, “object-oriented programming”).
obsolete v
Use only as a transitive verb, as in “This version obsoletes previous versions.” Consider using a simpler term, as in “This version replaces previous versions.”
offline adj, adv
Write as shown - one word.
offline storage n
Do not use. Use “auxiliary storage.”
offload adj, v
Write as shown - one word.
okay adj, n
Do not use. Use “OK,” but only to refer to the text in an interface element.
Write as shown - two words.
on line adj
Do not use. Use “online.”
on ramp n
Do not use. Use a term such as “access method,” or rewrite the information. For example, instead of writing “your on-ramp to fast, affordable meetings,” write “your solution for fast, affordable meetings.”
The term “on-ramp,” used to describe a quick way of accessing a product or feature, is colloquial.
on the other hand conj
Do not use. Use “however,” “alternatively,” or “conversely.”
on-demand adj
Write as shown - one word, hyphenated.
Consider using the term as an adverb instead - “on demand.” For example, consider writing “You can deliver these services on demand” instead of “You can deliver on-demand services.”
on-line adj
Do not use. Use “online.”
on-ramp n
Do not use. Use a term such as “access method,” or rewrite the information. For example, instead of writing “your on-ramp to fast, affordable meetings,” write “your solution for fast, affordable meetings.”
The term “on-ramp,” used to describe a quick way of accessing a product or feature, is colloquial.
on-site adj, adv
Write as shown - hyphenated.
once adv
Use only to mean “one time.” Do not use as a conjunction to mean “after” or “when.”
online adj, adv
Write as shown - unhyphenated.
online help n
Write as shown - two words, lowercase.
onsite adj
Do not use. Use “on-site.”
Open Source adj
Use only to refer to the Open Source Initiative. Otherwise, use “open source.”
open source adj
Write as shown - two words, lowercase - except when referring to the Open Source Initiative.
orient v
Use “orient,” not “orientate.”
orientate v
Do not use. Use “orient.”
Do not use. Use text that is suitable for the context and the noun to which this adjective applies. For example, write “applications that you can rapidly integrate into the system,” “items that are ready for immediate use.” “default settings,” “initial values,” or “built-in components.”
“Out-of-the-box” typically refers to something that is ready for customers to use as is, without modification.
output v
Do not use if a clearer and more direct alternative is available. For example, “to produce a report” is better than “to output a report.”
overhead n
Do not use. Use terminology that is more specific. For example, write “running large queries can increase processor usage,” not “running large queries can increase overhead.”
“Overhead” is ambiguous.
P
p.m. adj
Write as shown - lowercase with a period after each letter. Do not use P.M.
page n
Use to refer to the part of a notebook where a user makes selections or types data, or use to describe a web-based user interface that is displayed in a browser, For example, a browser-based application on a PDA displays pages. Do not confuse “page” with “tab” or “window.”
pane n
Use to refer to a separate area in a split window.
A window can be split into two or more panes. For example, a window can have one pane with a group of buttons for one function and other panes for other content. Use lowercase for pane names, as in “the resource management pane.”
panel n
Do not use “panel,” “screen,” and “window” interchangeably because they are not synonyms. A “panel” is an area of a screen that displays formatted information and can also include entry fields.
A “screen” is the physical surface of a display device, not the information that is displayed. A “window” is an area of the screen with visible boundaries in which an application program or information is displayed or in which a dialog is presented.
parent process n
Use “parent process,” not “parent task.”
parent task n
Do not use. Use “parent process.”
parent topic n
Do not use to refer to a topic in an information center, except when writing instructions about navigating. Whenever possible, refer to the specific topic title, not the relationship of topics to one another.
parent-child adj, n
Write as shown - hyphenated.
Do not use to mean a software fix. Use a more precise term that is appropriate for your product, such as “fix,” “test fix,” “interim fix,” “fix pack,” or “program temporary fix.”
path name n
Write as shown - two words.
PCOMM n
Do not use. Use “Personal Communications.”
PDF n
Do not use as a noun, as in “in a PDF.” Instead of using this construction, use the file type as an adjective followed by the word “file,” as in “in a PDF file.”
pel n
Use this abbreviation for “picture element” only in information about the printing industry. See also “pixel.”
per prep
Do not use to mean “according to.” Use a phrase such as “according to,” “as,” or “as in.”
perimeter network n
Do not use. Use “DMZ.”
A “DMZ,” also referred to in the industry as a “demilitarized zone” or “perimeter network,” is a configuration that includes multiple firewalls. These firewalls add layers of protection between a corporate intranet and a public network, such as the Internet.
permit v
Do not use in the sense of an inanimate object granting abilities to people, as in “the product permits you to...,” unless the object is a type of authorization that does grant abilities, as in “DBADM authority permits you to create database objects.” Whenever possible, use a direct, user-focused alternative such as “you can use the product to...” or “with this product, users can...”
Personal Communications n
Use “Personal Communications,” not “PCOMM.”
personal computer n
Write as shown - lowercase.
Phillips screw, Phillips screwdriver n
Write as shown - uppercase “P.”
phone n
Do not use. Use “telephone,” “cell phone,” or “mobile phone.”
pixel n
Use this abbreviation for “picture element” only in information that does not relate to the printing industry. See also “pel.”
PL/I n
Write as shown - uppercase “i,” not the numeral “1.”
planar n
Do not use to mean “system board.”
Do not use. Use “system board.”
platform n
Do not use this ambiguous term if you can use a more precise term or phrase, such as “operating system.”
please adv
Do not use in technical information. Terms of politeness are superfluous, convey the wrong tone for technical material, and are not regarded the same way in all cultures. In marketing information, terms of politeness might be appropriate.
Plug and Play adj
Write as shown - three words, uppercase “P” on “Plug” and “Play.”
plug-in adj, n
Write as shown - hyphenated.
podcast n
Write as shown - one word, lowercase.
pop up v
Do not use. Use “opens” (for example, “When the window opens,...”).
pop-up adj, n
Use only if you must specify the type of menu, list, or window.
pop-up blocker n
Do not use. Use “software to block pop-up ad windows.”
pop-up help n
Use only if you must emphasize how the help functions. Otherwise, use “help.”
pop-up killer n
Do not use. Use “software to block pop-up ad windows.”
pop-up menu n
Use only if you must emphasize how the menu functions. Otherwise, use “menu.”
port v
Do not use to mean “migrate” or “upgrade.”
The terms “port,” “migrate,” and “upgrade” are not synonyms. To port is to move an application program from the operating system for which it was developed to a different operating system. Porting requires less effort than redevelopment. With open technologies such as Java, porting might require no extra work at all. To migrate is to move data, users, or applications to a new program, platform, or environment. Migration can occur between unlike systems, for example, between two different vendors’ databases, and migrating usually involves more work than upgrading. To upgrade is to replace software with a new release or fix level of the same program or to replace hardware with a newer model or more powerful technology. An upgrade involves little work on the user’s part.
position v
Do not use to refer to moving a cursor. Use “move.”
post-requisite adj, n
Do not use. Use “postrequisite.”
Write as shown - unhyphenated.
pound sign n
Use to refer to the # character only if you are writing information exclusively for a US or Canadian audience. Otherwise, use “number sign.”
power cable n
Use “power cable” or “power cord,” not “line cord.”
power cord n
Use “power cord” or “power cable,” not “line cord.”
power down v
Do not use. Use “power off” or “turn off.”
power off v
Write as shown - two words.
power on v
Write as shown - two words.
power-off adj
Write as shown - hyphenated.
power-on adj
Write as shown - hyphenated.
pre-requisite adj, n
Do not use. Use “prerequisite.”
preinstall v
Use “preinstall,” not “preload.”
preinstalled adj
Use “preinstalled,” not “preloaded.”
preinstalled software n
Use “preinstalled software,” not “preload.”
preload v
Do not use. Use “preinstall.”
preload n
Do not use. Use “preinstalled software.”
preloaded adj
Do not use. Use “preinstalled.”
prepend v
Do not use. Use “add a prefix to.”
prerequisite adj, n
Write as shown - unhyphenated.
Use “press,” not “depress,” “hit,” “punch,” “push,” or “strike.”
preventative adj
Do not use. Use “preventive.”
preventive adj
Use “preventive,” not “preventative.”
prior to prep
Do not use. Use “before.”
program operator n
Use “program operator,” not “programmed operator.”
program product n
Do not use. Use “licensed program.”
programmable workstation n
Use “programmable workstation,” not the abbreviation “PWS.”
“PWS” is a trademark of another company.
programmed operator n
Do not use. Use “program operator.”
Programming Language/I n
Do not use. Use “PL/I.”
proper adj
Do not use to mean “correct,” “applicable,” or “appropriate.”
pub/sub adj, n, v
Do not use. Use “publish/subscribe” (adjective, noun) or “publishing and subscribing” (verb).
publish/subscribe adj, n
Write as shown, with a forward slash.
pull down adj
Do not use. Use “pull-down,” but only if you must specify the type of menu or list.
pull-down adj
Use only if you must specify the type of menu or list.
pulldown adj
Do not use. Use “pull-down,” but only if you must specify the type of menu or list.
punch v
Do not use to refer to pressing keys or typing on a keyboard. Use “press” or “type.”
push v
Do not use to refer to pressing keys or typing on a keyboard. Use “press” or “type.”
PWS n
Do not use. Use “programmable workstation.”
Q
quick tour n
Write as shown - two words, in lowercase, when used generically in text. In a title or banner, capitalize the first letter of each word (for example, Quick Tour for WebSphere Message Broker).
quiesce v
Use as either an intransitive verb, as in “I/O operations quiesce,” or a transitive verb, as in “The program quiesces I/O operations.”
Although some dictionaries do not recognize “quiesce” as a verb and others recognize it only as an intransitive verb, its use in the industry is widespread and acceptable.
quotation mark n
Write as shown to refer generically to a single quotation mark (') or double quotation mark (") character.
quote n
Do not use to refer to cited text. Use “quotation.”
quote v
Use to refer to citing text. Do not use to mean to enclose in quotation marks, as in “quote the string.”
quote mark n
Do not use to refer generically to a single quotation mark (') or a double quotation mark (") character. Use “quotation mark.”
quoted adj
Do not use to mean enclosed in quotation marks, as in “quoted string.”
quotes n
Do not use to refer generically to single quotation mark (’) or double quotation mark (“) characters. Use “quotation marks.”
R
radio button n
Avoid using “radio button” in technical documentation unless you must specify the type of control being referred to. In general, refer to the control by its label alone. For example: Click New.
re-create v
Use “re-create,” which refers to creating again, not “recreate,” which refers to taking recreation.
re-occur v
Do not use. Use “recur.”
read-only adj
Write as shown - hyphenated.
read/write adj, n
Write as shown, with a forward slash.
readme adj
Write as shown - all lowercase letters. Use as an adjective to modify the word “file.” For example, write “in the readme file,” not “in the readme.”
Write as shown - unhyphenated.
real-time adj
Write as shown - hyphenated.
reboot n
“Reboot” is widely recognized among technical users, but where usage permits, use “restart.”
recommend v
Avoid if possible. A phrase such as “We recommend that you take the following action” could create a potential marketing or legal problem.
recreate n
Do not use to refer to creating again. Use “re-create.”
recur v
Use “recur,” not “reoccur” or “re-occur.”
Redbooks® adj
Always use this term for an IBM Redbooks publication as an adjective, capitalized, and in the plural form. Preface it with “IBM” the first time you use it. Thereafter, you can use “Redbooks publication.”
redesign v
Use “redesign,” not “repair,” to refer to making changes to code.
refer to v
Use “see” both for references within a document and for cross-references to other material.
reference v
Do not use as a synonym for “refer to.” In cross-references, use “see,” not “refer to.”
rendezvous n
Do not use in products that use BPEL (Business Process Execution Language). Use “join” instead.
reoccur v
Do not use. Use “recur.”
repair v
Do not use to refer to making changes to code. Use “redesign.”
requestor n
Do not use. Use “requester.”
reside v
Use “reside” to refer to someone’s place of residence, not as a location for inanimate objects.
Example of correct usage: “If you reside in the United States or Canada, you can contact IBM Support at 1-800-IBM-SERV.” Example of incorrect usage: “The application must reside in the C:Program Files directory.” Instead, use “The application must be in the C:Program Files directory.”
respective adj
Do not use. Rewrite to avoid using this word.
For example, write “Return each drive to its bay,” not “Return the drives to their respective bays.”
Do not use. Rewrite to avoid using this word to associate parts of a sentence.
For example, write “Use the FILEPATH option to specify fixed data from a file. Use the DIRECTORYPATH option...,” not “Use the FILEPATH or DIRECTORYPATH option to specify fixed data from a file or directory, respectively.”
retry v
Do not use “retry” as a verb. Use “try again.” For example, do not write “retry connecting to the server.” Write “try connecting to the server again.”
reusable adj
Do not use as a synonym for the more specific term “serially reusable.”
Do not use as a synonym for “reentrant” or “reenterable,” which refer to concurrent use rather than serial use.
right adj
Use “right,” not “right-hand.”
right adjust v
Use to refer to shifting characters or digits to the right in a storage area.
right adjusted adj
Hyphenate the term if you use it before a noun that it modifies (for example, “right-adjusted digits”). Use to refer to characters or digits that are shifted to the right in a storage area.
right align v
Use “right align,” not “right justify,” to refer to aligning text at the right margin.
Right Arrow key n
Write as shown, with initial capital letters R and A, and unhyphenated.
right double-click v
Do not use.
Use “double right-click.”
right-aligned adj
Write as shown - hyphenated. Use “right-aligned,” not “right-justified,” to refer to text that is aligned at the right margin.
right-click v
Use “right-click” when writing for experienced users. Use “Using the right mouse button, click...” when writing for novice users. Also, use “right-click,” not “right-click on,” just as you use “click,” not “click on.”
right-hand adj
Do not use. Use “right.”
right-justified adj
Do not use. Use “right-aligned.”
right-justify v
Do not use. Use “right-align.”
Use to refer to something farthest to the right (for example, on a page or a panel).
road map n
Write as shown - two words.
roll back v
Write as shown when used as a verb - two words.
roll forward v
Write as shown when used as a verb - two words.
roll-forward adj
Write as shown - hyphenated. The preferred usage is as an adjective (usually modifying “recovery”) rather than alone as a noun.
rollback n
Write as shown when used as a noun or an adjective - one word.
root n
For clarity, use “root” as an adjective in most cases. However, the term can be used as a noun in some circumstances, such as in reference to a UNIX user account ID: “Log on as root.”
root adj
Use this word as an adjective to refer to “root user” or “root authority,” for example, “log in as a root user.”
Where feasible, use “root” as an adjective. However, “root” is sometimes acceptable as a noun, such as when it refers to the ID for a UNIX user account.
round-robin scheduling n
Write as shown.
round-robin task dispatching n
Do not use. Use “round-robin scheduling.”
rule set n
Write as shown - two words.
run v
Do not use “run” to refer to specifying a command on a command line or at a command prompt. Use “type,” “enter,” or “issue.” Use one term consistently throughout your information. You can use “run” in running text, for example, “If you run the abc command...”
run time n
Write as shown - two words. Use only in expressions relating to time, such as “at run time” or “during run time.” Do not use as a single word except as an adjective, as in “runtime environment.” Never hyphenate.
runnable n
Do not use as a noun. Use only as an adjective, as in “runnable interface.”
runtime adj
Write as shown - unhyphenated. This spelling is consistent with the Oracle “Java Runtime Environment.” See also “run time.”
S
sales representative n
Do not use. Use “marketing representative.”
sanity check n
Do not use. Explain exactly what you mean. For example, use “test” or “evaluate.”
Jargon, such as “sanity check,” is difficult to translate and is difficult to understand by readers whose first language is not English. For example, rather than writing “The quotes received from the vendors undergo a sanity check to establish whether the technical solution matches the requested services,” you might write “The quotes received from the vendors are checked to verify that the technical solution matches the requested services.”
scalable adj
Spell as shown.
schemas n
Use “schemas,” not “schemata.”
According to Webster’s, both “schemas” and “schemata” are acceptable plural forms of “schema.” However, for consistency’s sake, use “schemas.”
schemata n
Do not use. Use “schemas.”
screen n
Do not use “panel,” “screen,” and “window” interchangeably because they are not synonyms. A “screen” is the physical surface of a display device, not the information that is displayed.
A “panel” is an area of a screen that displays formatted information and can also include entry fields. A “window” is an area of the screen with visible boundaries in which an application program or information is displayed or in which a dialog is presented.
screen capture n
Use “screen capture,” not “screenshot” or “screen cap” to refer to a graphic that is part or all of an interface that is displayed on a screen.
screencap n
Do not use. Use “screen capture.”
screenshot n
Do not use. Use “screen capture.”
seamless window n
Use only in programmer documentation. For user documentation, use “runs in a window on the desktop.”
second name n
Do not use. Use “surname,” not “second name,” to refer to the name that is used to identify an individual as a member of a group, such as a family, tribe, or caste.
secondary storage n
Do not use. Use “auxiliary storage.”
section n
In an information center, use to refer to a group of topics in a navigation tree. In a book, do not use in a heading in an information unit. Use as appropriate to refer to a subdivision of text within a chapter or an appendix.
Write as shown - two words, initial uppercase letters.
select v
In general, use the verb “click” to indicate an action using a mouse. For check boxes, use “select” and “clear.”
Examples include:
“Click the Product icon to select it.” “Click Create > Hotspot > Link Hotspot.” “Click OK.” “Select the Start check box.” “The Start check box is selected.”
selected adj
Use to refer to a check box, radio button, menu item or other interface element that is marked or highlighted after selection.
selection button n
Do not use. Use “left mouse button.”
serial database n
Do not use. Use “nonpartitioned database environment.”
server n
Be careful not to confuse the concept of a client/server model with that of an agent/manager model. A client and an agent are alike in their direction of dependency but are opposites in their direction of requests.
Client and agent are similar - but not the same - in that they are both dependent on something else. The client is dependent on the server, and the agent is dependent on the manager. However, they are opposites regarding requests. The client requests services from the server, and the manager requests services from the agent. So, a client and an agent are alike in their direction of dependency but are opposites in their direction of requests.
service-oriented architecture n
Write as shown - lowercase. In technical documentation, hyphenate “service-oriented.” In marketing collateral, it is common practice to omit the hyphen (“service oriented architecture”).
set up v
Write as shown when used as a verb - two words.
setup adj, n
Write as shown when used as an adjective or noun - one word.
shift-click v
Do not use. For novice users, write “press Shift while you click.” For experienced users, write “press Shift and click.”
ship v
Do not use to indicate that something is included in or with a product. Use “include” or “included.”
Example: Write “The feature is included with the product” rather than “The feature is shipped with the product.”
shortcut adj, n
Write as shown - one word.
shortcut menu n
Do not use. Use “menu” if possible. Use “pop-up menu” if you must emphasize how the menu functions.
Always prefer a more direct verb or way of saying something. Omit “should,” or use “must” or “might,” as appropriate.
For example, use “Reset the parameters,” not “You should reset the parameters.”
Show Me n
Do not use as a noun (“a Show Me”) to describe a demonstration created with viewlet or Flash technology. Use “demonstration” or “tutorial.” The phrase is permissible as a control label, where it is used as a command.
Some products use “Show Me” as the menu label that opens an animated demonstration. That usage is fine. The term is a command and should not be used as the name of the information type that has been created.
shut down v
Write as shown when used as a verb - two words.
shutdown adj, n
Write as shown when used as a noun or an adjective - one word.
sibling topic n
Do not refer to a “sibling topic” in an information center. Whenever possible, refer to the specific topic title, not the relationship of topics to one another.
The term “sibling” is often used to describe a hierarchy of objects. Ensure that you use the term consistently within your product documentation.
sign off v
Write as shown when used as a verb - two words.
sign off from v
Write as shown - three words.
sign on to v
Write as shown - three words.
signon v
Do not use. Use “sign on.”
The silent “g” can lead to misreading in “signon.”
signon adj, n
Do not use. Use “sign-on.”
The silent “g” can lead to misreading in “signon”.
Simple Object Access Protocol n
Do not spell out. Use “SOAP.”
simply adv
Avoid this word because it is usually superfluous.
since adv
To facilitate translation, use this word only to refer to time. Do not use it as a synonym for “because.”
single quotation mark n
Write as shown to refer to the single quotation mark (') character. Use “quotation mark” to refer generically to a single quotation mark (') or a double quotation mark (") character.
Typically, use the straight keyboard apostrophe (') character (') as a single quotation mark. Word processors often distinguish between left single quotation marks (‘) and right single quotation marks (’).
single quote n
Do not use. Use “single quotation mark.”
single quote mark n
Do not use. Use “single quotation mark.”
single sign-on n
Write as shown, with “sign-on” hyphenated.
slave adj, n
Do not use. Use “subordinate,” unless you are using “slave” in the context of a UNIX system (such as AIX), where “slave” is acceptable.
smart card n
Write as shown - two words.
SME routine n
Do not use. Use “session management exit routine.”
SNA network interconnect exit n
Do not use. Use “session management exit routine enhancement” or “enhanced session management exit routine.”
so conj
Do not use by itself as a conjunction. Use a less ambiguous alternative such as “so that” or “therefore.”
SOA adj
Use the article “an” with this abbreviation. This suggests the pronunciation “S-O-A,” not the pronunciation “soah.”
SOAP n
Write as shown. Do not spell out as “Simple Object Access Protocol.”
SOAP was originally an acronym for Simple Object Access Protocol. Though the term itself is still used, the acronym was dropped in Version 1.2 of the SOAP specification because the protocol is not mainly used for “object” access. Instead, it is an XML-based messaging protocol. The SOAP specification is currently maintained by the XML Protocol Working Group of the World Wide Web Consortium.
socket interface n
Spell as shown - “socket interface. Do not use “sockets interface.”
SOCKS-enabled adj
Spell as shown - “SOCKS-enabled.” Do not use “socksified.”
soft boot n
Do not use. Use “Press Ctrl+Alt+Del to restart the system.”
softcopy n
Write as shown - one word.
software n
Write as shown - one word.
Do not use as a verb. Use “solve.”
solution n
Use “solution” to describe a combination of products, software, services, or technology that addresses a particular customer problem or project.
The term “offering” refers to the general hardware, software, or service elements, but “solution” refers to the application of an offering in a specific customer environment by means of offering enabling services.
sort merge n
Do not use. Use the separate words “sort” and “merge.”
sort-merge v
Do not use. Use the separate words “sort” and “merge.”
sort/merge v
Do not use. Use the separate words “sort” and “merge.”
spawn (a process) v
Do not use. Use “create.”
spool v
Write as shown - all lowercase, although it is an acronym for “simultaneous peripheral operations online.”
spooling adj
Use “spooling,” not “concurrent peripheral processing,” “CPP,” “concurrent peripheral operations,” or “CPO.”
SQL adj
Use the article “an” with this abbreviation.
This suggests the pronunciation S-Q-L, rather than the more slang “sequel,” which is the pronunciation often used with Microsoft SQL Server.
SQLJ n
Spell as shown - with an uppercase letter “J.”
stand-alone adj
Write as shown - hyphenated. Do not use as a noun.
start up v
Do not use. Use “start.”
startup adj
Write as shown when used as a noun or an adjective - one word.
store n
In most contexts requiring a noun, use “storage” instead of “store.” In data warehousing, the term “data store” is acceptable.
strike v
Do not use to refer to pressing keys or typing on a keyboard. Use “press” or “type.”
style sheet n
Write as shown - two words.
Write as shown - one word, as in Extensible Stylesheet Language (XSL).
subtopic n
Write as shown - one word.
sunset v
Do not use. If possible, use a more specific term such as “withdraw from service” or “withdraw from marketing.” Otherwise, use a more general term such as “discontinue” or “no longer support.”
supersede v
Write as shown - not “supercede.”
supertask n
Do not use to describe a high-level task topic in an information center. Refer to the specific topic title, not the type of topic.
surname n
Use “surname,” not “last name” or “second name,” to refer to the name that is used to identify an individual as a member of a group, such as a family, tribe, or caste.
You can use “family name” rather than “surname” if it is necessary to distinguish a family name from other types of surnames, or if you need to be consistent with external material that uses “family name” as a synonym of “surname.”
sync adj
Spell as shown when used as an adjective - not “synch.”
sync v
Spell as shown when used as a verb - not “synch.”
sync point n
Write as shown - two words. Use sync point as the abbreviated form of “synchronization point.”
system n
Avoid if you can use a more specific term (such as “computer” or “operating system”). Use “system” to mean the computer, its operating system, and its peripheral devices.
system administrator n
Write as shown - all lowercase.
system analyst n
Write as shown.
system board n
Use “system board,” not “motherboard,” “planar,” or “planar board.”
system engineer n
Use “system engineer,” not “systems engineer.”
system programmer n
Use “system programmer,” not “systems programmer.”
systems management n
Some existing product names might include the singular form “System Management,” but this term should usually be “systems management.”
T
tab v
Do not use as a verb to describe navigation in a GUI. Use only to refer to moving a cursor on a display, or the print head of a printer, to a preset location.
table of contents n
Do not use to refer to the contents of an information center. Use “Contents view.” Use “table of contents” only in books, white papers, and similar documents.
table space n
Write as shown - two words.
tap v
Use only to refer to selecting something on a handheld device.
For information about making selections in a graphical interface, see entries for “click” and “select.”
tar v
Do not use to refer to the creation of a tape archive (tar) file. Use a verb such as “compress” or “archive.”
tarball n
Do not use. Use “tar file.”
target disk n
This is a synonym for “destination disk.”
target drive n
This is a synonym for “destination drive.”
target file n
This is a synonym for “destination file.”
taskbar n
Write as shown - one word.
TCP/IP network n
Do not use. Use “Internet Protocol network” or “IP network.”
“IP network” is more accurate than “TCP/IP” network because (1) the transmission control protocol (TCP) is not a required protocol when IP is used and (2) the network consists of subnetworks that are connected with IP. The use of “TCP/IP network” can lead people to believe that the network is connection-oriented because TCP is a connection-oriented protocol; actually, the network has the characteristics of IP: it is connectionless. However, almost every vendor’s product that allows users to connect with this network has “TCP/IP” in the product name. Thus, the use of “TCP/IP network” is common despite its inaccuracy.
teamroom n
Write as shown - all lowercase - except to refer to a Lotus Notes TeamRoom.
technology preview n
Write as shown - lowercase. Do not abbreviate as “tech preview.”
“Tech preview” could be erroneously interpreted as “technical preview.”
telecommunication n
Write as shown - singular - to refer to communication at a distance (for example, by telephone). To refer to the science of telecommunication, use “telecommunications.”
Write as shown - plural - to refer to the science of telecommunication. To refer to communication at a distance (for example, by telephone), use “telecommunication.”
teleprocessing n
Use only to refer to remote-access data processing. Do not use to refer to distributed data processing.
teleprocessing line n
Do not use. Use “telecommunication line” or “transmission line.”
Telnet v
Do not use as a verb. For example, write “Use Telnet to connect to the server,” not “Telnet to the server.”
terminal n
Use only in a mainframe context. In other contexts, use “workstation” or “personal computer.”
terminate v
Do not use to refer to stopping a program or operation. Use “end” or “stop.”
test case n
Write as shown - two words.
text field, text entry field n
In most cases, use “field” (for example, “the User ID field”). Use a qualifier such as “text” or “entry” only if necessary to distinguish between different types of fields for a specific audience, such as programmers.
thank you n
Do not use in technical information. Terms of politeness are superfluous, convey the wrong tone for technical material, and are not regarded the same way in all cultures. In marketing information, terms of politeness might be appropriate.
that conj
Use “that,” without a comma, to introduce a restrictive clause. Use “which,” preceded by a comma, to introduce a nonrestrictive clause.
Consider the following examples: (1) The system units, which have two drives, are floor-standing models. (Nonrestrictive) (2) The system units that have two drives are floor-standing models. (Restrictive)
In the first example, all of the system units are floor-standing models and each has two drives. In the second example, some of the system units have two drives, and some do not. Only the ones with two drives are floor-standing models. See “Relative pronouns” on page 29 for more information.
then adv
In a two-step procedure that is written as one sentence, punctuate “then” as shown in the following examples: (1) “Do this, and then do that.” (2) “Do this; then do that.”
The first example is preferable, but you can use the style shown in the second example if you need to save space. Note that “then” is not a coordinating conjunction (such as “and,” “or,” and “but”). Using “then” as a coordinating conjunction creates a run-on sentence, as in the following example: “Do this, then do that.”
there is, there are v
Avoid at the beginning of an independent clause. In most cases rewrite to remove the phrase. For example, instead of “There are three recovery control data sets in the product” write “The product includes three recovery control data sets.”
thin client n
Write as shown - two words.
Write as shown - hyphenated.
through adj
Do not use as an adjective. Use “finished” or “completed.”
throw v
Use only in Java documentation, as in “throw an exception.” Otherwise, use an alternative construction such as “produce an error.”
throwable n
Do not use as a noun. Use only as an adjective, as in “throwable exception” and “throwable class,” and use only in Java documentation.
throwable adj
Use only as an adjective, as in “throwable exception” and “throwable class,” and use only in Java documentation.
thru prep
Do not use. Use “through.”
thumbstick n
Do not use. Use “USB flash drive.”
time out v
Write as shown - two words.
time slice n
Write as shown - two words.
time stamp v
Write as shown - two words.
time stamp n
Write as shown - two words. Use “timestamp” only in a DB2 context.
time-out n
Do not use. Use “timeout.”
timeout adj, n
Write as shown - one word.
timeslice n
Do not use. Use “time slice.”
toggle off, toggle on v
Do not use. Use “toggle.”
Example: Toggle the switch to the off position.
token ring n
Write as shown - two words.
token-ring adj
Write as shown - hyphenated.
Write as shown - one word.
toolbar button n
Spell as shown to indicate a button on a toolbar. Do not refer to a toolbar button as an “icon.”
A toolbar button usually has a graphical label, but avoid referring to a toolbar button as an “icon.” In instructions, you can usually write “Click X on the Y toolbar.”
toolbox n
Write as shown - one word.
tooling n
Do not use to refer to a set of development tools associated with a product. Use the simpler, more accurate term “tools.”
“Tooling” can be used as an adjective to refer to activities that tool makers perform, for example, “the Eclipse tooling platform.”
toolkit n
Write as shown - one word.
tooltip n
Write as shown - lowercase and one word. Use “tooltip,” not “hover help,” to refer to a brief, plain text description that is displayed when a cursor is moved over a graphical image, such as an icon, that does not otherwise have a label.
The term “hover help” refers to explanatory text, rich text, or links that can be viewed by moving a cursor over a graphical user interface (GUI) element, such as an icon, field, or text string.
ToolTip n
Do not use. Use “tooltip.”
top left, top right n
Do not use. Use “upper left” or “upper right” to refer to the location of an item in an interface.
Accessibility requirement: People who are blind or have low vision might not be able to understand information if it is conveyed only by location. Provide additional text information other than location. For example, write “The tables are displayed in the Table List pane, which is in the upper right of the window,” not “The list of tables is displayed in the upper right of the window.”
top-left, top-right adj
Do not use. Use “upper-left” or “upper-right” to refer to the location of an item in an interface.
Accessibility requirement: People who are blind or have low vision might not be able to understand information if it is conveyed only by location. Provide additional text information other than location. For example, write “The tables are displayed in the Table List pane, which is in the upper-right corner of the window,” not “The list of tables is displayed in the upper-right corner of the window.”
topic n
Use “topic,” not “article” or “topic node,” to refer to an information unit in topic-based information.
topic node n
Do not use to refer to a topic in an information center navigation tree. Use “topic.”
topic pane n
Use “topic pane,” not “content pane,” to refer to the right pane in an information center, where a topic is displayed, to avoid possible confusion with the Contents view in the navigation pane.
Use “topic-based information,” not “article-based information,” to refer to information that has been divided into concept, task, and reference topics.
totaled v
Spell as shown - one “l.”
touch v
Do not use to refer to using a keyboard key or hardware control. Use “press” or “type” to refer to using keys on a keyboard, and use “press” to refer to a hardware control.
touchscreen n
Do not use. Use “touch-sensitive screen.”
toward prep
Use “toward,” not “towards.”
transition v
Do not use. Use “make the transition,” “move,” “migrate,” or “change.”
translation n
Use to refer to language translation, such as from English to German. Do not use to refer to the conversion of internal data to a different format. Use “conversion.”
transparent adj
Do not use to refer to an operation that the user is unaware of, as in “transparent to the user.” Use “not apparent.”
tree view n
Do not use to refer to the structure of information center topics. Use “navigation tree.”
trillion n
Do not use. Use numerals, not the word, because the value of a trillion is not the same in all countries.
troubleshoot v
Write as shown - one word.
truststore n
Write as shown - one word.
twistie n
Avoid in technical documentation, unless you need to specify the type of control being referred to. In general, refer to the control by its label only. Use “expand” to refer to clicking a twistie to display content. Use “collapse” to refer to clicking a twistie to hide content (for example, “Expand Properties”).
twisty n
Do not use. To refer to the control itself, use “twistie.”
TY-RAP n
Do not use. Use “cable tie”; “TY-RAP” is a trademark.
type v
Use “type” or “enter” to refer to entering text in fields in a graphical interface. Use “type,” “enter,” or “issue” to refer to entering a command on a command line or at a command prompt; use one term consistently throughout your information.
Use to mean “in a manner or circumstance that conforms to the characteristics of a type or group” or “in typical circumstances.” For example, write “A hot-swap device typically has a handle that you can grasp to remove the device from its bay.”
The definitions of “generally,” “normally,” “typically,” and “usually” are similar, and in some cases, more than one of these terms might be applicable. Use your judgment in deciding which term best applies.
typo n
Do not use. Use “typing error,” “typographical error,” or other wording.