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
- Understand the image's purpose within the documentation
23
23
- Consider if context + image together make the image informative or decorative
24
24
25
-
3.**STEP 3 - Apply W3C decision tree**
25
+
3.**STEP 3 - Determine if informative or decorative**
26
26
-**Technical docs assumption:** Images are informative unless obviously decorative
27
-
-Categorize as: UI screenshot, procedural step, diagram, code example, graph, or configuration screen
28
-
-Only use `alt=""` if certain the image is pure decoration (borders, spacers, decorative backgrounds)
27
+
-**Informative:** Images that convey information → write descriptive alt text
28
+
-**Decorative:** Images where the information is already given in adjacent text, or pure visual styling with no informational value → use `alt=""`
29
29
30
30
4.**STEP 4 - Generate alt text**
31
-
- Maximum 30 words
32
-
- Convey meaning, not literal description
33
-
- Don't include "screenshot of", "image of", or "picture of"
34
-
- Use Mendix terminology
35
-
- Avoid redundancy with nearby text
36
-
- For UI screenshots: describe the UI element (e.g., "Create Workspace dialog")
37
-
- For diagrams: describe what it shows (e.g., "Client-server connection flow")
38
-
- For procedural steps: describe what user sees (e.g., "Download button in Registration dialog")
31
+
-**If decorative, use `alt=""`.** Never omit the alt attribute entirely.
32
+
-**If informative, generate descriptive alt text:**
33
+
- Focus on the information the image communicates, not what it looks like
34
+
- Give the most concise description possible
35
+
- Maximum 30 words (flag complex images needing longer descriptions for body text)
36
+
- Don't include "screenshot of", "image of", or "picture of" (screen readers already announce it's an image)
37
+
- Use Mendix terminology
38
+
- Avoid redundancy with nearby text
39
+
-**Based on surrounding context:**
40
+
- In a procedure: emphasize the action/element relevant to the step (e.g., "Download button in Registration dialog")
41
+
- Showing UI elements: name the relevant elements (e.g., "Properties pane")
42
+
- Showing structure or relationships: describe what entities/components are connected (e.g., "Domain model with Customer and Order entities connected by one-to-many association")
43
+
- Showing logic or process flow: describe what the flow accomplishes (e.g., "Microflow that retrieves FileDocument list and updates encryption keys")
39
44
40
45
5.**STEP 5 - Edit the figure shortcode**
41
46
- Use Edit tool to add/update only the `alt` attribute
42
47
- Preserve all other attributes: `class`, `width`, `max-width`, `link`
43
48
- Maintain exact indentation and spacing
44
49
45
-
## W3C Guidelines Summary
46
-
47
-
**Informative images:**
48
-
- Convey meaning or information → provide descriptive alt text
49
-
- Be "the most concise description possible"
50
-
- Focus on what information it communicates, not what it looks like
51
-
52
-
**Decorative images (rare in technical docs):**
53
-
- Pure visual styling with no informational value → use `alt=""`
54
-
- When in doubt: describe it—better than incorrectly marking decorative
55
-
56
-
**Never:**
57
-
- Omit the alt attribute entirely
58
-
- Say "image of" or "screenshot of" (screen readers already announce it's an image)
59
-
- Create alt text longer than 30 words (flag as complex image needing body text description)
60
-
61
50
## Special Cases
62
51
63
52
-**Images in numbered lists:** Common in procedures—describe the procedural step shown
0 commit comments