Keyboard Keys
Different keyboards use different names for common keys. For consistency, use the following key names unless the technology that you are documenting requires other forms:
Alt
arrow keys (generic)
Backspace
Command
Ctrl
Del
Down Arrow
End
Enter
Esc
Home
Ins
Left Arrow
Option
Page Down
Page Up
Right Arrow
Shift
Space
Tab
Up Arrow
When showing specific key names and key combinations, use the following guidelines. For more information about formatting keyboard key combinations, names, and shortcuts, see Text Formatting.
Guideline | Example |
---|---|
When telling users to type a letter key (as in a command), use lowercase for the letter unless uppercase is required. Use type or enter when the action results in output on the interface. | When prompted, type To change from command mode to insert mode, type |
When telling users to press a letter key (as in a key combination), capitalize the letter. Use press when the action doesn't result in output on the interface. NoteDon't use the verbs hit, strike, or punch.Separate the key names by | When you're finished, press Press To move forward word by word, press To toggle between the progress bar screen and a Linux TTY
screen, press |
If part of a key combination requires the use of the | To jump to the end of the file, press To apply the general number format, press |
Avoid using key with specific key names. If needed for clarity, on the first use of a key name, you can use the definite article the and key with the name. On subsequent uses, refer to the key only by its name. | Press Press the Help key ( |