Skip to content

Commit cff3558

Browse files
committed
Apply feedback from review and condense
1 parent 4b469a0 commit cff3558

1 file changed

Lines changed: 17 additions & 28 deletions

File tree

.claude/skills/docs-alt-text/SKILL.md

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ disable-model-invocation: false
99
1010
## Workflow
1111

12-
**CRITICAL: Follow this order for each image:**
12+
Follow this order for each image:
1313

1414
1. **STEP 1 - View the image file** (REQUIRED)
1515
- Extract image src path from figure shortcode
@@ -22,42 +22,31 @@ disable-model-invocation: false
2222
- Understand the image's purpose within the documentation
2323
- Consider if context + image together make the image informative or decorative
2424

25-
3. **STEP 3 - Apply W3C decision tree**
25+
3. **STEP 3 - Determine if informative or decorative**
2626
- **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=""`
2929

3030
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")
3944

4045
5. **STEP 5 - Edit the figure shortcode**
4146
- Use Edit tool to add/update only the `alt` attribute
4247
- Preserve all other attributes: `class`, `width`, `max-width`, `link`
4348
- Maintain exact indentation and spacing
4449

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-
6150
## Special Cases
6251

6352
- **Images in numbered lists:** Common in procedures—describe the procedural step shown

0 commit comments

Comments
 (0)