Friday, August 29, 2008

Style guide: LANDesk usage and terminology

LANDesk wording and usage style guidelines follow the following style guidelines in order of precendence:

  1. LANDesk style guidelines
  2. Microsoft Manual of Style
  3. Chicago Manual of Style

In general, theMicrosoft Manual of Style guide covers most terminology and usage issues. Areas where LANDesk differs with that style guide, or that deserve extra attention, are covered below.

Terms



Terminology




Introduction


These terms are listed alphabetically and are marked as follows:

= use this term
= don't use this term; a better one is suggested

Term Description
64-bit, 32-bit, 16-bit Hyphenate when used as an adjective
Alert on LAN No hyphens. Alert on LAN is am IBM trademark term.
AMS² Superscript the "2"
AMT Do not use in most instances. AMT is marketed as Intel(R) VPro(tm). AMT refers to only certain base technologies.
antivirus Do not hyphenate
Autorun One word. Capitalize the "A"
CD Use instead of "disc"
chart Use instead of "graph" when referring to report types. For example, don't use "bar graph," do use "bar chart"
check Use when referring to selecting check boxes. If the check box shouldn't be selected, use "clear"
check box Don't use. Use "option"
clear Use instead of "deselect" (e.g., clear the option)
click Use instead of "select" or "choose" when referring to using menus, buttons, dialog options, and dialog tabs
command line Two words if used as a noun. Hyphenated as an adjective (e.g., command-line option)
computer Use instead of "machine," "PC," or "station"

Use when referring to a combination of Windows NT servers/workstations. Otherwise, use "workstation" or "server"

console Use to refer to the main UI of a product

Don't capitalize. Never use "console" to refer to a computer in general

customer support Use "LANDesk Customer Support." Capitalize each word
deselect Don't use. Use "clear" (e.g., clear the option)
dialog box Use instead of "dialog"

A UI element is a "dialog box" if you can't resize it. A UI element is a "window" if you can resize it, or it has Minimize and Maximize buttons.

dimmed Use instead of "grayed" or "shaded" to describe the appearance of a UI control that's unavailable
disabled Don't use. Use "dimmed" to describe a UI control that's unavailable
drives Don't use a ":" with a drive letter. Instead, use "C drive" or "drive C"
drop-down list Use instead of "pull-down list" or "drop-down list box"
edit box Don't use. Use "field" to describe an area in a dialog that users type or enter information into
e.g. Don't use. Use "for example"
e-mail Hyphenate
enable Use instead of "allow"
etc. Don't use. Use "and so on" or write around: "such as..." and name two examples. In tables, where space may be an issue, you can use "etc."
execute Don't use. Use "run" to describe the action users perform to start an application
file name Two words
floppy disk Don't use. Use "disk"
GB Abbreviation for gigabyte. In text, place a space between the GB and associated number
(e.g., 10 GB)
Gbps Abbreviation for gigabits per second. In text, do not place a space between the Gbps and associated number (e.g., 8Gbps)
GBps Abbreviation for gigabytes per second. In text, do not place a space between the GBps and associated number (e.g., 80GBps)
grayed Don't use. Use "dimmed" to describe a UI control that's unavailable
hard disk Two words. Use instead of "hard drive"
host name Two words
i.e. Don't use. Use "that is" or "such as"
illegal Don't use. Use "invalid" or "unrecognized" + noun. For example, "Invalid command"
Internet Capitalize
intranet Always lowercase
KB Abbreviation for kilobyte. In text, place a space between the KB and associated number
(e.g., 100 KB)
kHz Abbreviation for kilohertz. Use lowercase "k."
launch Don't use. Use "run" to describe the action users perform to start an application
login Use in the context of NetWare servers. Is one word if used as an adjective. "Log in" is two words if used as a verb
logon Use in the context of Windows NT servers. Is one word if used as an adjective. "Log on" is two words if used as a verb. (Log on to the server.)
machine Don't use. Use "device" instead
MB Abbreviation for megabyte. In text, place a space between the MB and associated number
(e.g., 10 MB)
Mbps Abbreviation for megabits per second. In text, do not place a space between the Mbps and associated number (e.g., 100Mbps)
MBps Abbreviation for megabytes per second. In text, do not place a space between the MBps and associated number (e.g., 100MBps)
menu bar Two words. Typically just referred to as a menu.
MHz Abbreviation for megahertz. In text, place a space between the MHz and associated number
(e.g., 450 MHz)
MS-DOS Use "MS-DOS" when specifically referring to the operating system, as in system requirements for one of our products

If using in a generic way, such as "from the DOS prompt, type...", use "DOS" or command prompt.

motherboard For UNIX and Linux, use "baseboard"
network adapter Use instead of "network card"
NT Don't use on its own. Use "Windows NT" instead
online One word
option Use instead of "check box" and "radio button." To describe an action users can perform with an option, use these words: click, check, clear. Or, just use the name of the option: "Click to select Allows USB drives."
pages Use to refer to the dialog boxes of a panel dialog or wizard
paths Use the actual folder capitalization. Don't surround with quotes.

If telling users how to type a UNC path, use this example in lowercase: \\servername\directory

PC In general, don't use. Use "device" instead
please Avoid unless necessary. Instead of saying "Please wait," just let the user know what to expect. "Configuration database. This might take a few minutes."
Plug and Play Uppercase "P's," use "and," no hyphen
press Use to describe the action users perform with keys or a key combination
pre-boot environment Abbreviated as PE as in Linux PE. Environment used as a basis to start a new OS install or to run troubleshooting tools before the full OS boots.
pull-down menu Don't use. Use "menu"
radio button Don't use. Use "option"
real-time Two words. Always hyphenate before a noun.
reinstall One word
rerun Don't use. Use "Run [ProgramName] again"
run Use instead of "execute" or "launch" to describe the action a user must perform to start an application
select Use "click" when possible, but when "click" is ambiguous or when there's a choice users must make among several dialog options, use "select."
Setup One word if used as a noun or adjective. Capitalize when referring to a specific program’s Setup process
set up Two words if used as a verb. "Click Install now to set up the application."
shaded Don't use. Use "dimmed" to describe a UI control that's unavailable
taskbar One word
technical support Don't use. Use "LANDesk Customer Support"; capitalize each word
terminate Don't use. Use "cancel" or "end" instead
that is Use instead of "i.e."
toolbar One word
ToolTip One word; capitalize both Ts
uninstall One word. Use instead of "de-install"
uppercase One word
user name Two words
VPro Formerly known as AMT. AMT now only refers to certain base technologies. VPro should always be accompanied be accompanied by Intel VPro. The approved Intel noun is "technology."
Wake on LAN technology No hyphens. Is a trademark of IBM; always follow with the word "technology." If you refer to it, add this statement to the trademark page of your document:

*Wake on LAN is a trademark of IBM Corporation.

Web site Two words; capitalize "Web"
webmaster Lowercase, one word
Windows operating systems Do not abbreviate. Always spell out the entire name: Windows 95/98, Windows NT, Windows 2000, Windows XP, Windows Vista

To properly trademark: Windows* 95/98, Windows NT*, Windows* 2000

In documentation, after the first occurrence, it's OK to refer to both Windows 95 and Windows 98 as "Windows 95/98." It's also OK after the first occurrence to refer to both Windows NT and Windows 2000 as "Windows NT/2000"

wizard Use instead of "dialog box" when writing about a wizard

Each dialog box of a wizard is called a "page" Most "wizards" are replaced with panel manager dialogs in ver. 8 + product releases.

World Wide Web Capitalize each word. If using just "Web," capitalize. Don't use "Net"

See also:

1 comment:

BarbaraS said...

It seems that we only have a couple of differences in terminology. We don't use:
Dimmed - we use greyed out, or unavailable.
Check - we use Select the check box
Drop-down list - we just use list
option - we do use this instead of radio buttons, but we use 'Select the Private check box' to avoid confusion if there are both check boxes and option buttons on the same window.
Apart from that, we follow the same rules. Not bad considering.