Skip to content

Add alt text skill#11077

Open
dbreseman wants to merge 2 commits intodevelopmentfrom
db-alt-text-skill
Open

Add alt text skill#11077
dbreseman wants to merge 2 commits intodevelopmentfrom
db-alt-text-skill

Conversation

@dbreseman
Copy link
Copy Markdown
Collaborator

No description provided.

@github-actions
Copy link
Copy Markdown
Contributor

⚠️ Claude Configuration Warning

You've modified Claude Code configuration files. These files contain the shared configuration for all contributors. Please revert this change if unintended. ONLY modify these files if you need to change shared configurations that apply to everyone and have discussed this change with the TW team.

To override the Claude settings locally, use .claude/settings.local.json instead. This local file is gitignored and overrides the repo default.

For example, if you're changing AWS_PROFILE:
The default profile name is my-sandbox. If your AWS profile has a different name, override it locally instead of changing the shared file.

Create or edit .claude/settings.local.json in the repo root and include the following lines:

{
  "env": {
    "AWS_PROFILE": "your-sandbox-name"
  }
}

- Consider if context + image together make the image informative or decorative

3. **STEP 3 - Apply W3C decision tree**
- **Technical docs assumption:** Images are informative unless obviously decorative
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My assumption is always the other way around. I believe that you should understand the documentation if the images were removed.

But I know everyone else thinks the opposite way, as described here, so I won't start the argument all over again. 😁

3. **STEP 3 - Apply W3C decision tree**
- **Technical docs assumption:** Images are informative unless obviously decorative
- Categorize as: UI screenshot, procedural step, diagram, code example, graph, or configuration screen
- Only use `alt=""` if certain the image is pure decoration (borders, spacers, decorative backgrounds)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I do think

Suggested change
- Only use `alt=""` if certain the image is pure decoration (borders, spacers, decorative backgrounds)
- Only use `alt=""` if certain the image is pure decoration (borders, spacers, decorative backgrounds, duplication of surrounding textual information)

3. **STEP 3 - Apply W3C decision tree**
- **Technical docs assumption:** Images are informative unless obviously decorative
- Categorize as: UI screenshot, procedural step, diagram, code example, graph, or configuration screen
- Only use `alt=""` if certain the image is pure decoration (borders, spacers, decorative backgrounds)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in STEP 4 where the alt text is being generated. It shouldn't impact the categorization?


3. **STEP 3 - Apply W3C decision tree**
- **Technical docs assumption:** Images are informative unless obviously decorative
- Categorize as: UI screenshot, procedural step, diagram, code example, graph, or configuration screen
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Categorize as: UI screenshot, procedural step, diagram, code example, graph, or configuration screen
- Categorize as: UI screenshot, procedural step, diagram, code example, graph, decorative, or configuration screen

- Focus on what information it communicates, not what it looks like

**Decorative images (rare in technical docs):**
- Pure visual styling with no informational value → use `alt=""`
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not what W3C says. It actually says
For example, the information provided by the image might already be given using adjacent text, which is why I don't think they are as rare as you think.

What happens if you tell Claude this instead of "pure visual styling"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants