Problematic Terms

Aside from terminology you create specifically for your program, there is already much established, standard terminology that you should use when appropriate. The Microsoft Manual of Style for Technical Publications contains a comprehensive list of standard software terminology. While the style manual is intended to be a reference, you can't know what's in it without reading it from cover to cover. Since reading the book from cover to cover is sheer torture—I have done it twice and hope never to do it again—I will spare you the misery and present a list of the terms that I find interesting or that I have made mistakes with in the past. Note that this list applies to user documentation and that programmer documentation (such as this book) might use different conventions.

A.M., P.M. Not am or pm.
abort Use end to refer to communications and network connections, quit for programs, and stop for hardware operations.
above Use preceding or earlier instead.
accelerator Use shortcut instead.
and/or Use or instead.
application Use program instead.
bars Taskbar and toolbar are one word; all other bars (scroll bar, split bar, status bar, title bar, etc.) are two words.
below Use following or later instead.
bitmap Use graphic or picture instead.
boot Use start instead.
box Use computer instead.
boxes Toolbox is one word; all other boxes are two words.
button Use "click Cancel" instead of "click the Cancel button."
check When referring to a check box, use select or clear instead.
choose Use click or double-click instead.
close Use for windows, documents, and dialog boxes. For programs and network connections, use quit and end, respectively.
combo box Use box instead (for example, use "In the Font box…" instead of "In the Font combo box…").
context menu Use shortcut menu instead.
context-sensitive Always hyphenate.
corrupt Use corrupted instead.
deselect Use cancel the selection instead.
dialog Use dialog box instead.
dialogue Use dialog box instead.
directory Use folder instead.
disabled Use unavailable instead.
diskette Use disk instead.
DOS Use MS-DOS instead.
double-click Always hyphenate.
edit Use change or modify instead.
end user Use user instead.
enter Don't use as a synonym for type.
error message Use message instead.
execute Use run or carry out instead.
exit Use as a command name only; use quit instead to refer to closing a program. For example, "use the Exit command to quit the program."
Explorer Use Windows Explorer instead.
FAX Use fax instead.
field Use box or option instead.
file extension Use extension or file name extension instead. For the actual extensions, use .txt instead of .TXT or TXT.
filename Use file name instead.
fixed disk Use hard disk instead.
floppy drive Use floppy disk instead.
grayed Use unavailable instead.
hard drive Use hard disk instead.
his Use the instead (for example, "the user can change the settings" instead of "the user can change his settings").
higher Use later instead for product version numbers.
hyphens Don't use in key combinations; use a plus sign instead (for example, "Alt+X").
illegal Use not allowed instead, except when referring to matters of law.
install Use set up instead when referring to software.
internet Use Internet instead.
K Use KB instead with a space following the number. For example, use 40 KB, not 40KB or 40K.
legal Use allowed instead, except when referring to matters of law.
list box Refer to by its label and the word list (for example, use "In the Font list…" instead of "In the Font list box…").
log in/log out Use log on to and log off instead.
lower Use earlier instead for product version numbers.
machine Use computer instead.
menu item Use command instead.
message box Use message instead.
mnemonic key Use access key instead.
noncontiguous selection Use multiple selection or nonadjacent selection instead.
NT Use Windows NT instead.
open Use for windows, files, documents, and folders—not for choosing a command, a menu, an icon, an option, or any other similar element that doesn't produce a working file in a window.
option button Don't use in procedures. Use "click Landscape" instead of "click the Landscape option button."
output Don't use as a verb. Use write to, display to, or print to instead.
pathname Use path instead.
PC Use computer instead.
pop-up menu Use shortcut menu instead.
prompt Do not use as a noun to mean "message."
property page Use tab instead.
property sheet Use dialog box instead.
pull-down menu Use menu instead.
push button Use command button instead.
press Use click when an action can be performed with both the keyboard and the mouse.
radio button Use option button instead.
Readme/Read Me Use readme instead.
reboot Use restart instead.
Registry Use registry instead.
right-click Always hyphenate.
(s) Do not use to indicate that a noun can be singular or plural. Use the plural or one or more instead.
select Use for data, not commands. For commands, use click or double-click instead.
subdirectory Use folder instead.
terminate Use quit or close instead.
Toolbar Use toolbar instead.
tooltip Use ToolTip instead.
will Avoid; make present tense, if possible.
Wizard Use wizard instead.

While it can be a chore to constantly look up terms in the Microsoft Manual of Style for Technical Publications, the second edition has a greatly improved electronic version that makes finding things a snap. I recommend installing the electronic version and its associated compiled HTML file so that you can look up things quickly without having to fool around with the CD-ROM.



Developing User Interfaces for Microsoft Windows
Developing User Interfaces for Microsoft Windows
ISBN: 0735605866
EAN: 2147483647
Year: 2005
Pages: 334

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net