Diction
Preferring some terms over the others makes consistent documentation.
| Preferred | Non-preferred | Example |
|---|---|---|
| shows, appears | displays | The element appears. |
| enable | allow | The feature enables you to do something. |
| file name | filename | Enter a file name. |
| image | picture, photo | Select an image. |
| screenshot | screen capture, screen image | Upload a screenshot. |
| want | wish, desired | Select the option that you want to enable. |
pop-up | popup | The browser blocks pop-ups from automatically showing up on your screen. |
| Term | Usage | Example |
|---|---|---|
| window | large interface areas that contain buttons, fields, and a close icon. | In the Bulk Change window... |
| dialog | small interface areas, usually for errors or confirmations | In the Insert dialog... |
| pane | distinct interface areas grouping related items typically placed on the right or left | In the Activity pane... |
| Term | Usage | Example |
|---|---|---|
| drop-down menu | selectable list items in a menu | From the More drop-down menu, select... |
| check box | selectable boxes | Select the Owner check box... |
| field | area where you can enter text strings | In the Keys field, enter... |
| Term | Usage | Example |
|---|---|---|
| click | interactions with buttons, icons, or links | In the content library, click the Open icon. |
| right-click | opening a contextual drop-down menu | In the content library, right-click a file and... |
| select | interactions with a drop-down menu | In the More drop-down menu, select... |
| select and clear | interactions with a check box | Select the check boxes next to the files you want to rename. |
| enter | typing text into a text area | Enter a title for your file. |
| navigate | find a file or folder | Navigate to the image you want to upload. |
| place | cursor location | Place your cursor where you want to insert a table. |