Word List

Don’t use above to indicate the position of an item on a page. Various devices, screen readers and browsers may position elements in different places. Instead, use words such as previous or earlier.

This term is sometimes used to indicate the absence of a dependence on some other software component, such as an operating system or platform. It’s better to use a clearer term, such as platform-independent.

This is an abbreviation of also known as. Although it may be briefer, it has tone not appropriate for software documentation. Instead, use parentheses or the word or. For example:

Don’t use the ampersand character in place of and in general text. It may be used in page titles, as well as section and sub-section headings.

Although it’s widely accepted and understood, use application rather than app.

Write this word in full. Don’t use approx.

When stating that something looks like something else, you should be referring to a thing and not an action — regardless of what extra words you might add to make it understandable, even though it may be a common way of speaking. For example, read these two sentences:

The second example likens the subject, which is a noun, to a verb phrase. That’s not preferred. An alternative, if you want to use the word "like", then liken the subject to a noun or noun phrase like so:

As "expects" to be followed by a verb clause. Instead, like "expects" to be followed by a noun or noun phrase — a phrase that has the grammatical function of a noun. For example:

As such does not mean for that reason.

Instead, it means in its role as the previously mentioned thing.
For example:

As such is often incorrectly used in place of phrases like so or consequently. Here are some examples of incorrect usage:

ASCII is an abbreviation for the American Standard Code for Information Interchange. It should always be written as an abbreviation and now written out, with the rarest of exceptions as it is here. It also should not include periods after each letter (i.e., not A.S.C.I.I.). Written as ASCII is acceptable.

The adjective is asynchronous. The adverb is asynchronously. Don’t use async or asynch.

No general rule exists on whether to hyphenate a word that begins with the prefix auto-.
It’s best to check in the dictionary.

If the word isn’t given either in this guide or in the Merriam-Webster online dictionary, don’t invent it yourself; use another term, for example with the adverb automatically.

The noun and adjective are backup. The verb is to back up. For example:

The noun is backward compatibility. The adjective is backward-compatible.

Don’t use below to indicate the position of an item on the screen, as different devices and browsers may position elements differently. Instead, use later or in the following.

The word beta should be written in lowercase, unless it appears differently as part of a defined product name.

Don’t use the term blacklist. Instead, use deny list or block list. The opposite is allow list, not whitelist.

Avoid using blind in an idiomatic or metaphorical sense.

To refer to people, use, for example, a blind person or a visually impaired person (whichever is more accurate in the context).

See also color blind.

Bluetooth is a proper noun, so it should be capitalized.

Capitalize Boolean in general use.

"Both" is an emphatic word that applies specifically to two stated things.
It can’t be used for more than two.
For example:

To apply similar emphasis to more than two things, it would be necessary to say something like:

However, it might be more elegant to say, for example:

The adjective is built-in when it’s used attributively (that is, before the noun that it describes).
When it’s used predicatively (that is, after a verb such as be, seem, look), the adjective phrase is built in. For example:

The noun and adjective are callback. The verb is call back.

canceled, canceling, cancellation.

Use catalog, not catalogue.

Don’t use cell phone.
Instead, use mobile or mobile phone.

Don’t use check to refer to selecting a checkbox in the user interface.
Instead, use select.

In the UI, a check mark is a visual indication that an item is selected.

The spelling is checkbox.

Use select and clear to refer to user interaction with checkboxes.

Click is both a verb and a noun.

Use click on when referring to "virtual" objects, for example, when instructing the reader to click on a part of the user interface (e.g., a button):

Use click (i.e., without on) when referring to physical objects, for example, when instructing the reader to click a specific mouse button:

More-specific variants are left-click, right-click, and double-click (all hyphenated).

When used as a noun phrase, client side has no hyphen:

When used as an adjective phrase, it should be written with a hyphen to avoid ambiguity:

Use non-breaking spaces before and after the slash ("/") character. In AsciiDoc, this would be written as client / server.

The function of a colon in a sentence is to signal the beginning of an explanation or a list.
Often, we can think of it as saying
and this is it…
or
and the following is what I’m talking about….
Some examples of this are:

A colon is also commonly used to introduce a list, particularly at the end of a sentence.
For example:

A colon shouldn’t be used to join two full clauses outside the uses mentioned here.
If you are looking for the right punctuation to join two clauses that have some logical relationship, consider using a semi-colon.
Don’t use a comma for this purpose.

Vaadin uses US English in its documentation. US usage allows a colon to be followed by a sentence beginning with a capital letter, if that sentence is the first of two or more sentences that are governed by the same colon.

However, if the colon governs only one sentence, begin the sentence with a lowercase letter:

Use the term color-blind only in its literal sense, to refer to a person who is unable to distinguish certain colors.

When it’s used as a noun phrase, write command line. When it’s used as an adjective phrase, write command-line. For example:

However, see "command line interface"

This is a common, easily recognized phrase, so it’s unnecessary to hyphenate command line here.

In the first reference in the document, write this as command line interface ("CLI"). In subsequent occurrences, it’s acceptable to write it as CLI.

In the context of the command line interface, the command prompt indicates the location where the user may enter a command. Typical command prompts are "$ " (in Unix-like systems) and "C:\> " (in Windows-based systems).

This indicates that one thing is made up of one or more other things, and nothing else. If you want to say that one thing is made up of one or more things plus some other things, use include. For example:

Avoid this as an abbreviation for configuration. Spell it out in full.

It’s acceptable to use CSS, rather than write out cascading style sheets in full.
Don’t use the extension .css to refer to a file type.

On the first mention, write this as cross-site request forgery (CSRF). On subsequent mentions, CSRF is sufficient.

Don’t use the extension .csv to refer to a file type.
Instead, use the capitalized abbreviation CSV.
For example:

Although data is, strictly speaking, a plural Latin form, the generally accepted convention is to treat it as singular. For example:

The verb decrement means to decrease an integer by a specified value. It’s the opposite of increment.

In the context of software development, if something is deprecated, it means that it’s recommended not to use this thing.
It doesn’t mean that it isn’t possible to use it.

The term deprecated is often used in situations where that particular thing is scheduled to become unavailable at some point in the future.

Don’t use desire as a synonym for want.
Instead, use want.

A determinate progress bar is a progress indicator that informs the user how much of a process has been completed, and how much remains to be done.

A dialog or dialog box is an element of the user interface.
A dialogue is a conversation between two people.

Use different from, rather than different than or different to.

Don’t use the term direction keys.
Instead, use arrow keys.

On the first mention, write distributed denial-of-service (DDOS). On subsequent mentions, it’s sufficient to write DDOS.

DNS is an abbreviation of Domain Name System (not Server), which is a protocol.
A server that operates this system is a DNS server.
A client of such a server is a DNS client.

Write this in full.
Don’t write doc.

Avoid using due to.
Instead, use because of or as a result of.

See Latin Abbreviations.

Like the word both, the word either is used in the context of two things.
For example:

It isn’t correct to use either where there is a choice between more than two things. For example:

For added emphasis, we could also say:

For clarity, either should be placed as close as possible to the point where choice occurs. For example:

Use element, rather than tag, when referring to HTML elements.

The noun is end user. The adjective phrase is end-user. For example:

In the context of IT systems, to enter refers to inputting a specific piece of data to the system. For example:

This abbreviation is always terminated by a period.

Don’t use etc. in situations where it isn’t clear exactly what it means.
For example:

FAQ is an abbreviation for frequently asked question. The term is sufficiently well known for it not to need explanation.
The plural is FAQs.

Fast-forward can be a noun, an adjective or a verb.

Fewer (not less) should be used with countable nouns. For example:

If it stands alone, so to speak, "filename" is acceptable as a compound word — but definitely not a hyphenated word (i.e., "file-name"). Generally, don’t write it as two separate words. However, the term could be split and rearranged into a noun phrase: "name of the file". It can also be split if "name" supports another adjective in a phrase: "path and file name."

Floating-point is an adjective.

Following may be used with some more specific term. For example:

However, it may not always be necessary to be so specific. We may use the expression the following as a noun phrase on its own. For example:

Use for example in preference to e.g.

If you use for example in the middle of a sentence, use a semi-colon if there is a possibility of doubt which part of the sentence it relates to.
For example:

The word former identifies the first of two options previously mentioned. (Former is often used in conjunction with latter, which indicates the last of two options previously mentioned.)
It isn’t correct to use former in a situation where more than two options have been mentioned.
For example:

Former is also used as an adjective to indicate that a person or place had a certain role in the past. For example:

The noun is forward compatibility.
The adjective is forward-compatible.

Don’t use freeze to refer to a situation when a program stops responding.
Instead, write stops responding.

The noun phrase is frontend.
The adjective is frontend.
For example:

On the first mention, use the General Data Protection Regulation (GDPR). On subsequent mentions, use the GDPR — without periods.

In compound phrases with half, use a hyphen. For example:

Don’t use hang to refer to a situation when a program stops responding. Instead, write stops responding.

The verb is hard code. The adjective is hard-coded.

It’s important to avoid using gender-specific pronouns (unless there is a significant reason for doing so).
Don’t overuse he / she or he or she, as this quickly becomes tedious.

The generally accepted approach is to use the pronoun they.
For example:

However, if you can easily avoid the issue by using the plural, do so.
For example:

Write out hexadecimal in full.
Don’t abbreviate it to hex.

Don’t use hit to refer to pressing a key.
Instead, use press.

See Latin Abbreviations.

Clauses that refer to conditions in the future use the present tense. The "result" clause uses the appropriate future form or imperative form. For example:

If there are any further releases, you will receive an advisory email.
[Not If there will be….]

Send us a message via our contact page if you have any problems.
[Not If you will have….]

Use if in clauses that express a simple conditional meaning.
Use whether in clauses that express uncertainty between two possibilities. Sometimes, either is acceptable.
For example:

Indent is a verb that means to apply a greater left (and sometimes right) margin to text than that of the preceding material. The purpose of indentation is to show some distinction between one piece of text and the next.

Don’t use outdent, as it’s often unclear what exactly this means in a given situation. Look for a different way to express this idea.

An indeterminate progress bar is a progress indicator in a situation where it isn’t possible to determine and show how much of the process remains to run.

"Information" is an uncountable noun. In other words, we can’t talk about one information, two informations, etc.
For the same reason, we can’t say an information, as this implies a quantity of one.

If we want to talk about quantity in relation to information, there are several options:

Don’t use input as a verb. Instead, write enter — maybe type in.

On the first mention, write as Internet of Things (IoT).
On subsequent mentions, write as IoT.

The noun is italics.
The adjective is italic.
The verb is italicize.

Possessive adjectives have no apostrophes. Likewise, the possessive form of the word it is its, with no apostrophe. This is logical and consistent with the other possessive adjectives (e.g., he → his, she → her).

It’s with an apostrophe is a contracted form it is or it has, depending on the context, similar to he’s.

Don’t use this as a synonym for crucial.

Use a hyphen, rather than an en-dash.

In US English (which is used in Vaadin documentation), if a verb ends in the letter l, the final l isn’t usually doubled when a suffix (-ing, -ed, -er) is added.
The exception is when the final syllable is stressed.
For example:

See "former"

The noun is layout.
The verb is lay out.

The past simple and past participle of lead is led. For example:

See as or like?

When writing about software, don’t write something like, "it lives there". It’s not alive. Write instead "it’s located there", or something similar.

The noun is login.
The verb is to log in (to).

Don’t use lower to refer to earlier versions of software.
Instead, use earlier.

Use macOS, even at the beginning of a sentence.

The noun is markup.
The verb is to mark up.

Avoid this term.
Instead, consider using primary / subordinate.

As our documentation deals extensively with Java objects and methods, avoid using method to mean way or process.

It’s usually unnecessary to write out this term in full.
However, if it’s required for some reason, it’s multipurpose internet mail extensions.

Use mobile, mobile phone, or mobile device.
Don’t use cell phone.

Don’t use moveable.

Much is frequently used in questions and negative statements, but not usually in positive statements.
In positive statements, use an alternative expression, such as a lot of, a great deal of, or a large amount of.
For example:

Use this abbreviation of not applicable in tables or other contexts where space is limited.

Don’t use needed attributively (that is, before the noun phrase that it describes). Instead, use required. For example:

Write network out in full.
Don’t shorten it to net.

In general contexts, use the term null to refer to a null value.

Don’t add of to prepositions where it isn’t necessary. For example:

Write OK, not okay.

Write on-premises in full, not on-prem.

Don’t use once to mean after, as it can be confusing.
Use after or when.
For example:

As this is a common phrase, it’s unnecessary to use a hyphen, even when it’s used as an adjective phrase.

It’s unnecessary to write out this abbreviation of operating system in full.

Don’t use over in the sense of more than. Instead, use more than.

Don’t use the extension .pdf to refer to a file type.

Use per instead of the slash character (i.e., /) to refer to a rate. For example:

The verb persist doesn’t take an object (that is, it’s intransitive).
For example:

Don’t use please in the context of instructions.
It’s unnecessary.

Don’t use post as a synonym for after. Instead, use after. It’s sufficient.

Use postal code rather than postcode or the American equivalent, zip code.

In US English, practice can be a noun or a verb, depending on how it’s used in a sentence.

Use the verb press to refer to pressing a key or key combination on a computer keyboard. Don’t use hit or any other such verb in this context as connotes hostile actions.

The noun phrase is real time. The adjective phrase is real-time. For example:

Don’t use regex.

Don’t use repo.

The adverb respectively is used in a well-defined grammatical context.
It has the function of distributing meaning over a defined set of entities.
For example:

Don’t use respectively in any other construction.

It’s unnecessary to write out this abbreviation of representational state transfer in full.

Don’t append (s) or (es) to a singular word in order to indicate that the item in question may or may not be plural. Instead, either use the plural word only, or explicitly give both forms.
For example:

In US English, the suffix -ize is generally preferred over -ise. There are some exceptions, like improvise.

On the first mention, write it as service level agreement (SLA).
On subsequent mentions, write it as SLA.

The noun and adjective are setup.
The verb is to set up.

Don’t use ship to refer to software releases. Instead, use release.

The noun and adjective are sign-in. The verb is to sign in (to) (not to sign into).

Don’t use the term smartphone.
Instead, use mobile or mobile phone.

At the first mention, write software as a service (SaaS). On subsequent mentions, SaaS is enough.

Write specification out in full.
Don’t abbreviate it to spec.

ssh` is the terminal utility.
SSH is the associated communications protocol.

The noun and adjective are startup.
The verb is to start up.

Subclass is a noun and a verb.

The verb forms are sync, syncing, synced.

If the word that is optional, include it for clarity.
The goal, as always, is to help the reader to interpret each phrase and sentence correctly at the first reading.
For example:

In defining relative clauses, we can use either that or which.
For example:

However, in non-defining relative clauses, we can’t use that.
For example:

Because the pronunciation of their and they’re is identical, it’s easy to write the wrong form.
This error is less likely to happen in our technical documentation, as we have made the decision not to use contracted forms.
In general, the form they’re shouldn’t be used in our technical documentation.

Use time frame rather than timeframe.

The verb is time out.
The noun and adjective are time-out.

The noun is time stamp.
The adjective and verb are time-stamp.

If a time zone has an unambiguous name, write it out in full, capitalized on the first use.
Use Coordinated Universal Time (UTC) rather than Greenwich Mean Time (GMT).
For example:

If the time zone doesn’t have a name, or to guard against misunderstanding, use the form UTC-n or UTC+n.
For example:

Use trailing to refer to characters that occur at the end of a string.
The opposite of trailing is leading.

Use trojan or trojan horse.

Something is either unique or it isn’t. There can be no degrees of uniqueness.
Hence, avoid using such expressions as very unique or rather unique.

Don’t use unzip.
Instead, use extract.

Uniform Resource Locator is abbreviated as URL. It shouldn’t be written out like it is here. It also shouldn’t include periods (i.e., U.R.L.). The plural is written URLs.

Don’t use U.S.

UTF-8, UTF-16, UTF-32.

Avoid the word utilize. Use instead the word, use.

Avoid using vice versa, as it’s often unclear exactly what is meant.
Use more-specific language.

Write versus in full, or abbreviate it to vs without a final period.
Avoid using versus in the sense of compared with or as opposed to.

Use web when referring to the World Wide Web.

See "that" or "which"?

Use while in expressions of time.
Don’t use while as a synonym for although or whereas.
For example:

Use who, rather than that, in relative clauses that refer to people. For example:

In general, try to avoid using whom. It can sound pretentious.

However, it’s sometimes difficult to avoid elegantly.
For example:

Sometimes it’s preferable to use whom to avoid an awkward sentence. For example:

Although these two words sound exactly the same, they have completely different meanings.

Whose means of whom or of which.
For example:

Who's is a contraction of who is or who has.

Try to avoid using the future form will unless you really are talking about the future.
A common case is when talking about the behavior of software.
For example:

See also: Present Tense.

Don’t use the extension .yaml to refer to a file type.

The plural of zero is zeros.

Don’t use the extension .zip to refer to a file type.

ECF2A383-1FCE-4659-9697-480EA3A257AF