You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/style-guide/writing/write-for-accessibility.txt
+17-14Lines changed: 17 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Writing with accessibility in mind improves the documentation experience for all
35
35
Provide Context for UI Elements
36
36
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
37
38
-
Do not identify UI elements using only one sensory characteristic (such
38
+
Don't identify UI elements using only one sensory characteristic (such
39
39
as color or location).
40
40
41
41
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.
61
61
* - Click **Save**.
62
62
- Click the green button.
63
63
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.
74
77
75
78
Write for Ease of Reading
76
79
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -95,12 +98,12 @@ heading. Make the hierarchy clear and headings meaningful.
95
98
their browser and the page. It's easier to jump between pages and
96
99
sections of a page if the headings and titles are unique.
97
100
- 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``.
99
102
- Don't use a heading level that doesn't fit the hierarchy. Find
100
103
another way to change the visual formatting of a heading.
101
104
- 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.
0 commit comments