Skip to content

Commit

Permalink
Updates content and updates image.
Browse files Browse the repository at this point in the history
  • Loading branch information
edonehoo committed Aug 14, 2023
1 parent 97e5438 commit bbdfc78
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ However, don’t include too much information. The user doesn’t need to know e
<br />


#### **Lead with the benefit**.
#### Lead with the benefit

When providing users with a resolution, start the sentence with their goal ("the benefit"), followed by what they need to do to continue.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@ id: Punctuation
section: UX writing
---

## Headings and titles
Headings and titles can include punctuation, but should not end in punctuation. For example:

<div class="ws-content-table">

|**Before** | **After** |
|------------|-----------|
| Style, voice, and tone. | Style, voice, and tone |
| Getting started with PatternFly! | Getting started with PatternFly |

</div>

The exception for this rule is a question mark, when it is contextually important. For example, in a confirmation dialog, it is important that users understand what action they are about to take. A valid heading may include a question mark, such as "Delete service account?".

## Referring to text in the UI
When referring to an element or text in the UI, use bold text. Don't use quotation marks or italics -- those should be reserved for quotes and emphasis, respectively. For example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Use abbreviations that users are familiar with, and write out uncommon abbreviat
| **U.S.** | As a noun, use *United States* unless there are space constraints. As an adjective, use *U.S.* (for example, *U.S. soldier*). As part of an organization, use *U.S.* <br /><br /> Taken from Red Hat Corporate Style Guide. |
| **URL** | Stands for *Uniform Resource Locator*. Write *URL* in all caps. |
| **VM** | Refers to a virtual machine. OK to abbreviate as long as you've spelled it out once in the first occurrence and as long as *VM* won't be confused with other terms that share that acronym. <br /><br />Taken from Red Hat Corporate Style Guide. |
| ** N/A ** | Refers to *data not applicable*, meaning data will never apply to the object and will never populate. |
| **--** | Refers to *data not available*, meaning data could apply to the object, but is currently not populating. |
| **N/A** | Refers to *data not applicable*, meaning data does not currently apply to the object and will not populate.<br /><br />This includes scenarios where there is no matching data in the object's data source. For example, when nothing matches a filter, when the data source is empty, or when the object is not connected to any data source.|
| **--** | Refers to *data not available*, meaning data could apply to the object, but is currently not populating.<br /><br />This includes scenarios where the object is connected to a data source, but is not able to fetch data. For example, when there are permission restrictions or errors.|

</div>
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@ To learn how to contribute design guidelines, see our [contribution guide](https
When creating guidelines, information must be presented in the following order. Sections may be omitted, but if present must use the following section headings (H2).

### Elements
Display an image of the component containing numbered annotation tags for each major part of the component's visual design. Include specific icons, headers, fields, symbols, and anything else included in the component's structure. Following the image, list all the parts you tagged, aligning with the number displayed in the respective annotation tag. In this list, provide a description of each one.
Display an image of the component containing numbered annotation tags for each major part of the component's visual design. Include specific icons, headers, fields, symbols, and anything else included in the component's structure. Following the image, list all the parts you tagged, aligning with the number displayed in the respective annotation tag. In this list, provide a description of each one. For example:

Example:

<img src="./img/sliderelements.png" alt="A screenshot of the slider component's element section with 8 elements outlined." width="750px" />
<img src="./img/elements-guidelines.png" alt="A screenshot of the slider component's element section with 8 elements outlined."/>

### Usage
Explain how the component is used, when to use it, and why it should be used. Include explanations of problems it could help solve and address its advantages over similar components. Include images for visual examples.
Expand Down

0 comments on commit bbdfc78

Please sign in to comment.