mirror of https://github.com/docker/docs.git
Contribute patch (#15959)
* contribute-patch * guidance on UI content and brackets
This commit is contained in:
parent
5179260655
commit
aa60238970
|
@ -1832,6 +1832,8 @@ contribute:
|
|||
title: Voice and tone
|
||||
- path: /contribute/file-conventions/
|
||||
title: Source file conventions
|
||||
- path: /contribute/ui/
|
||||
title: UI elements in content
|
||||
- sectiontitle: Useful components
|
||||
section:
|
||||
- path: /contribute/components/accordions/
|
||||
|
|
|
@ -157,3 +157,6 @@ Version 4.8.2
|
|||
- Avoid awkward doubling of vowels. For example ‘semi-independence*’,* or ‘re-elect’.
|
||||
- Prevent misreading of certain words. For example ‘Re-collect’ means to collect again; without a hyphen the word recollect has a different meaning.
|
||||
|
||||
### Parentheses
|
||||
|
||||
Don't use parentheses in technical documentation. They can reduce the readability of a sentence.
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: UI elements in content
|
||||
description: How to refer and interact with UI content
|
||||
keywords: ui, contribute, style guide
|
||||
---
|
||||
|
||||
This page contains information on how to write technical content that involves a user interface (UI).
|
||||
|
||||
## Format names of UI elements
|
||||
|
||||
Always bold UI elements when referring to them by name.
|
||||
|
||||
This includes names for buttons, menus, dialogs, windows, list items, or any other feature on the page that has a visible name.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
## Focus on the task
|
||||
|
||||
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.
|
||||
|
||||
|Correct |Incorrect |
|
||||
|:-----------|:------------|
|
||||
|Expand the **Advanced options** section | Select the zippy to expand the **Advanced options** section|
|
||||
|
||||
|
||||
## Refer to UI elements
|
||||
Don't use UI elements as if they were English verbs or nouns.
|
||||
|
||||
|Correct |Incorrect |
|
||||
|:-----------|:------------|
|
||||
|In the **Name** field, enter an account name. | **Name** the account.|
|
||||
|To save the settings, select **Save**.| **Save** the settings.|
|
||||
|
||||
## Prepositions
|
||||
|
||||
When documenting the UI, use the following prepositions.
|
||||
|
||||
|Preposition |UI element | Example |
|
||||
|:-----------|:------------|:-----------|
|
||||
|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**. |
|
||||
| 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>|
|
Loading…
Reference in New Issue