Versions, updates

Print topic Print topic Previous topic  Next topic

Use the following terms and phrases. Also, note the given spellings.

Expand /Collapse All Subsections

When to use version numbers

Don’t mention a particular version number if the number doesn’t add any important information. (Usually, it only does when you’re talking about the differences between two versions.) Only specify the version number on the first mention in a topic or section.

If you must mention a version number, only make the version number as specific as needed.

Examples:

When possible, don’t mention the version number at all:
“With DemoSoft you can ….”
(The version isn’t mentioned, so this statement refers to the latest version or to the version that’s described in the document.)

When needed, add the full version number:
“With DemoSoft version 5.2 you can ….”
(You want to point out the difference from another minor version, most likely version 5.1 or version 5.0.)

If the minor version isn’t relevant, only mention the major version number:
“With DemoSoft version 5 you can ….”
(You want to point out the difference from another major version, most likely version 4.)

Except in a dedicated “What’s New” topic, avoid describing a product or feature as new. With the next version, this statement becomes obsolete. If it’s important to point out that a particular feature hasn’t been available in earlier versions, add the version number.

No:

The new printing feature ….

Yes:

The printing feature, introduced in version 3.2, ….

Version numbers

Use lowercase for the word version.
Don’t use: release

It’s OK to leave out the word version. Don’t abbreviate it with the letter v.

Don’t use x to mean any number.

No:

In the 5th release of DemoSoft, ….

No:

In DemoSoft Version 5, ….

Yes:

In DemoSoft version 5, ….

Top:

In DemoSoft 5, …

No:

DemoSoft works with OtherSoft v5.x.

Yes:

DemoSoft works with OtherSoft 5.

In the middle of a sentence, don’t add a period after the last number.

Yes:

DemoSoft 5.0.1 is the current version.

Yes:

The current version is DemoSoft 5.0.1.

Avoid the word running to refer to a specific version. Instead, use the words use, using, or installed.

No:

If you’re running DemoSoft 3 or an earlier version, ….

Yes:

If you’re using DemoSoft 3 or an earlier version, ….

Yes:

To use this feature, you must have DemoSoft 4 or a later version installed.

Earlier versions, later versions

There may be earlier versions of a program and later versions.
Don’t use: prior, lower, higher, older, newer, above, below, smaller, bigger, greater, better, modern, legacy

Yes:

… requires DemoSoft version 5 or a later version.

Yes:

… requires DemoSoft version 5 or an earlier version.

Yes:

Make sure that you’re using the latest version.

Yes:

To convert data from earlier versions, ….

A program can be backward compatible and forward compatible.
Don’t use: future compatible, upward compatible

Upgrades, updates

Upgrade refers to a new major version. Update refers to a new minor version.

Yes:

If you want to upgrade DemoSoft 4, ….

(means: If you want to install version 5 or a later version, ….)

Yes:

If you want to update DemoSoft 4, …

(means: If you want to install version 4.x, ….)

Instead of update, use the term critical update for a bug fix that can affect the core functionality of your product but that isn’t related to security. For security-related bug fixes, use security update.
Don’t use: bug fix, patch, maintenance release

Requirements

Software may be compatible with other software or with hardware. If it’s compatible, it works with other software or hardware.
Don’t use: supports

No:

DemoSoft supports the XYZ standard.

Yes:

DemoSoft is compatible with XYZ standard.

Yes:

DemoSoft works with XYZ.