From f333beb744352f359748580ed80072317bc3a3f7 Mon Sep 17 00:00:00 2001 From: Nathan Bower Date: Wed, 9 Aug 2023 10:09:29 -0400 Subject: [PATCH] Add checkbox (#4725) Signed-off-by: natebower <102320899+natebower@users.noreply.github.com> --- STYLE_GUIDE.md | 6 +++--- TERMS.md | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 01efebbb..af3df8cf 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -312,10 +312,10 @@ We follow a slightly modified version of the _Microsoft Writing Style Guide_ gui | **Close** | - Apps and programs
- Dialog boxes
- Files and folders
- Notifications and alerts
- Tabs
- The action a program or app takes when it encounters a problem and can't continue. (Don't confuse with _stop responding_). | - Close the Alarms app.
- Close Excel.
- Save and close the document.
- Closing Excel also closes all open worksheets. | | **Leave** | Websites and webpages | Select **Submit** to complete the survey and leave this page. | | **Go to** | - Opening a menu.
- Going to a tab or another particular place in the UI.
- Going to a website or webpage.
- It's ok to use _On the **XXX** tab_ if the instruction is brief and continues immediately. | - Go to Search, enter the word **settings**, and then select **Settings**.
- Go to **File**, and then select **Close**.
- On the ribbon, go to the **Design** tab.
- Go to the **Deploy** tab. in the **Configuration** list ...
- On the **Deploy** tab, in the **Configuration** list ...
- Go to Example.com to register. | -| **Select** | Instructing the user to select a specific item, including:
- Selecting an option, such as a button.
- Selecting a check box.
- Selecting a value from a list box.
- Selecting link text to go to a link.
- Selecting an item on a menu or shortcut menu.
- Selecting an item from a gallery. | - Select the **Modify** button.
- For **Alignment**, select **Left**.
- Select the text, open the shortcut menu, and then select **Font**.
- Select **Open in new tab**.
- Select the **LinkName** link. | +| **Select** | Instructing the user to select a specific item, including:
- Selecting an option, such as a button.
- Selecting a checkbox.
- Selecting a value from a list box.
- Selecting link text to go to a link.
- Selecting an item on a menu or shortcut menu.
- Selecting an item from a gallery. | - Select the **Modify** button.
- For **Alignment**, select **Left**.
- Select the text, open the shortcut menu, and then select **Font**.
- Select **Open in new tab**.
- Select the **LinkName** link. | | **Select and hold, select and hold (or right-click)** | Use to describe pressing and holding an element in the UI. It's OK to use _right-click_ with _select and hold_ when the instruction isn't specific to touch devices. | - To flag a message that you want to deal with later, select and hold it, and then select **Set flag**.
- Select and hold (or right-click) the Windows taskbar, and then select **Cascade windows**.
- Select and hold (or right-click) the **Start** button, and then select **Device Manager**. | | **>** | Use a greater-than symbol (>) to separate sequential steps.
Only use this approach when there's a clear and obvious path through the UI and the selection method is the same for each step. For example, don't mix things that require opening, selecting, and choosing.
Don't bold the greater-than symbol. Include a space before and after the symbol. | Select **Accounts** > **Other accounts** > **Add an account**. | -| **Clear** | Clearing the selection from a check box. | Clear the **Header row** checkbox. | +| **Clear** | Clearing the selection from a checkbox. | Clear the **Header row** checkbox. | | **Choose** | Choosing an option, based on the customer's preference or desired outcome. | On the **Font** tab, choose the effects you want. | | **Switch, turn on, turn off** | Turning a toggle key or toggle switch on or off. | - Use the **Caps lock** key to switch from typing capital letter to typing lowercase letters.
- To keep all applied filters, turn on the **Pass all filters** toggle. | | **Enter** | Instructing the customer to type or otherwise insert a value, or to type or select a value in a combo box. | - In the search box, enter...
- In the **Tab stop position** box, enter the location where you want to set the new tab.
- In the **Deployment script name** box, enter a name for this script. | @@ -415,7 +415,7 @@ Follow these basic guidelines when writing UI text. * Keep it short. Users don’t want to read dense text. Remember that UI text can expand by 30% when it’s translated into other languages. * Keep it simple. Try to use simple sentences (one subject, one verb, one main clause and idea) rather than compound or complex sentences. * Prefer active voice over passive voice. For example, "You can attach up to 10 policies" is active voice, and "Up to 10 policies can be attached" is passive voice. -* Use device-agnostic language rather than mouse-specific language. For example, use _choose_ instead of _click_ (exception: use _select_ for check boxes). +* Use device-agnostic language rather than mouse-specific language. For example, use _choose_ instead of _click_ (exception: use _select_ for checkboxes). ##### Tone diff --git a/TERMS.md b/TERMS.md index 463ea739..7855d8cd 100644 --- a/TERMS.md +++ b/TERMS.md @@ -154,6 +154,8 @@ certificate authority Use _certificates_ on first mention. It’s OK to use _certs_ thereafter. +**checkbox, checkboxes** + **CI/CD** Use _continuous integration_ and _continuous delivery (CI/CD)_ or _continuous integration and delivery (CI/CD)_ on first mention.