Skip to content

Commit aa60238

Browse files
authored
Contribute patch (docker#15959)
* contribute-patch * guidance on UI content and brackets
1 parent 5179260 commit aa60238

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

_data/toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1832,6 +1832,8 @@ contribute:
18321832
title: Voice and tone
18331833
- path: /contribute/file-conventions/
18341834
title: Source file conventions
1835+
- path: /contribute/ui/
1836+
title: UI elements in content
18351837
- sectiontitle: Useful components
18361838
section:
18371839
- path: /contribute/components/accordions/

contribute/style/grammar.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,3 +157,6 @@ Version 4.8.2
157157
- Avoid awkward doubling of vowels. For example ‘semi-independence*’,* or ‘re-elect’.
158158
- Prevent misreading of certain words. For example ‘Re-collect’ means to collect again; without a hyphen the word recollect has a different meaning.
159159

160+
### Parentheses
161+
162+
Don't use parentheses in technical documentation. They can reduce the readability of a sentence.

contribute/ui.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: UI elements in content
3+
description: How to refer and interact with UI content
4+
keywords: ui, contribute, style guide
5+
---
6+
7+
This page contains information on how to write technical content that involves a user interface (UI).
8+
9+
## Format names of UI elements
10+
11+
Always bold UI elements when referring to them by name.
12+
13+
This includes names for buttons, menus, dialogs, windows, list items, or any other feature on the page that has a visible name.
14+
15+
Don't make an official feature name or product name bold, except when it directly refers to an element on the page that uses the name, such as a window title or button name.
16+
17+
In most cases, follow the capitalization as it appears on the page. However, if labels are inconsistent or they're all uppercase, use sentence case.
18+
19+
## Focus on the task
20+
21+
When practical, state instructions in terms of what the user should accomplish, rather than focusing on the widgets and gestures. By avoiding reference to UI elements, you help the user understand the purpose of an instruction, and it can help future-proof procedures.
22+
23+
|Correct |Incorrect |
24+
|:-----------|:------------|
25+
|Expand the **Advanced options** section | Select the zippy to expand the **Advanced options** section|
26+
27+
28+
## Refer to UI elements
29+
Don't use UI elements as if they were English verbs or nouns.
30+
31+
|Correct |Incorrect |
32+
|:-----------|:------------|
33+
|In the **Name** field, enter an account name. | **Name** the account.|
34+
|To save the settings, select **Save**.| **Save** the settings.|
35+
36+
## Prepositions
37+
38+
When documenting the UI, use the following prepositions.
39+
40+
|Preposition |UI element | Example |
41+
|:-----------|:------------|:-----------|
42+
|in | dialogs <br>fields <br>lists <br>menus <br>panes <br>windows <br>| In the **Alert** dialog, select **OK**. <br> In the **Name** field, enter `wsfc-1`. <br> In the **Item** list, select **Desktop**. <br>In the **File** menu, click **Tools**.<br> In the **Metrics** pane, select **New**. <br>In the **Task** window, select **Start**. |
43+
| on |pages <br>tabs <br>toolbars | On the **Create an instance** page, select **Add**. <br> On the **Edit** tab, select **Save**.<br> On the **Dashboard toolbar**, select **Edit**.<br>|

0 commit comments

Comments
 (0)