Skip to content

Commit 3a76556

Browse files
(DOCSP-11403): Update Write for Accessibility (#45)
* (DOCSP-11403): Update Write for Accessibility * Apply suggestions from code review Co-authored-by: Anthony Sansone <[email protected]> Co-authored-by: Anthony Sansone <[email protected]>
1 parent 5ac83cb commit 3a76556

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

source/style-guide/writing/write-for-accessibility.txt

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Writing with accessibility in mind improves the documentation experience for all
3535
Provide Context for UI Elements
3636
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3737

38-
Do not identify UI elements using only one sensory characteristic (such
38+
Don't identify UI elements using only one sensory characteristic (such
3939
as color or location).
4040

4141
Directional phrases like “at the top of the page” or "right-hand side"
@@ -61,16 +61,19 @@ to” or “above” might not provide the correct context.
6161
* - Click **Save**.
6262
- Click the green button.
6363
Click the round button.
64-
* - *Where an element appears more than once in the UI:*
65-
1. Click **Clusters**.
66-
2. Click **...** next to the cluster you want to modify.
67-
*or*
68-
*Where an element appears once in the UI:*
69-
1. Click **Clusters**.
70-
2. Click **...**.
71-
- 1. Click **...**.
72-
*or*
73-
2. In the clusters view, click the **...** button next to the cluster you want to modify.
64+
* - | *Where an element appears more than once in the UI:*
65+
| 1. Click **Clusters**.
66+
| 2. Click **...** next to the cluster you want to modify.
67+
|
68+
| *Where an element appears once in the UI:*
69+
| 1. Click **Clusters**.
70+
| 2. Click **...**.
71+
- | *Where an element appears more than once in the UI:*
72+
| 1. Click **...**.
73+
|
74+
| *Where an element appears once in the UI:*
75+
| 1. In the clusters view, click the **...** button next to the
76+
| cluster you want to modify.
7477

7578
Write for Ease of Reading
7679
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -95,12 +98,12 @@ heading. Make the hierarchy clear and headings meaningful.
9598
their browser and the page. It's easier to jump between pages and
9699
sections of a page if the headings and titles are unique.
97100
- Use a heading hierarchy and don't skip levels. For example, put an
98-
``h3`` only under an ``h2>``.
101+
``h3`` only under an ``h2``.
99102
- Don't use a heading level that doesn't fit the hierarchy. Find
100103
another way to change the visual formatting of a heading.
101104
- Don't have empty headings or headings with no associated content.
102-
- Tag headings using heading elements, not bold.
103-
- Use a level 1 heading for the page title or main content heading.
105+
- Format headings using RST markup, like `heading types <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections>`__, not **bold**.
106+
- Use an ``h1`` for the page title or main content heading.
104107

105108
Use Meaningful Link Text and Formatting
106109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)