Buttons
From TechWriter Wiki
Always use the verb to click when describing actions for buttons. Never use hit or press.
Text buttons
| Refers to clickable elements that are a part of a graphical user interface, and consist of text only. Does not apply to hyperlinks. |  Example |
Specify the text only. Text should be in bold, using the same case as the button itself.
Examples:
| Incorrect | Correct |
|---|---|
| Click .
| Click Set focus. |
| Click on the 'set focus' button. |
Note:
Because the button text specified in the instructions is exactly the same as that shown on the screen, it is not necessary to write "the...button".
Icon buttons
| Refers to clickable elements that are a part of a graphical user interface, and consist of an image only. |  Example |
Always give the button or command name, followed by the icon in brackets. Never give only the icon - consider the case where one person [an instructor, or Help Desk] is reading the procedure to another person.
Use the ToolTip text as the button name, but use the 'standard' names for common buttons.
If there is a keyboard shortcut for a button, then include this in brackets after the button graphic. This is to cater for people who don’t like to (or cannot) use the mouse.
Examples:
| Incorrect | Correct |
|---|---|
| Click .
| Click the Save button ( ) (or press Ctrl-S on your keyboard).
|
| Click on the Save button. | |
| Hit Save. |
Combination text/icon buttons
| Refers to clickable elements that are a part of a graphical user interface, and consist of both text and an image. |  Example |
Specify the name of the button (delimited by square brackets) and the text, but do not include a graphic of the icon.
Examples:
| Incorrect | Correct |
|---|---|
| Click .
| Click the [Goto] Additional data button. |
| Click the Additional data button. | |
| Click Goto Additional data. |
Note:
It is necessary to include the text "the…button". This is because the button text given in the instructions does not exactly match what the user sees on the screen.
In some cases (particularly where there is more than one text/graphic button with the same text), it is acceptable to include a graphic of the icon portion of the button after the text, but not a graphic of the entire button including the text.
