One-click install
npx skills add https://github.com/qt/qtqa --skill skill-alttext
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skill-alttext
Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-alttext
Command: npx skills add https://github.com/qt/qtqa --skill skill-alttext

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Authoritative style guidelines for authoring accessibility alt text in Qt documentation, covering priority order, formatting rules, and terminology guidelines to ensure consistent, accessible images.

Core Features & Use Cases

  • Enforce a prioritized alt-text approach (visible text from image, then context/behavior from surrounding content, then generic description)
  • Apply formatting rules (80-column limit, line breaks aligned with filenames, avoid anti-pattern prefixes)
  • Provide terminology guidelines aligned with Qt documentation standards for non-Qt-control terms

Quick Start

Apply the alt text guidelines to a given image in Qt docs by writing concise, context-aware descriptions.

Frequently Asked Questions about skill-alttext

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write accessible alt text for images in Qt documentation?

To write accessible alt text for Qt documentation, prioritize visible image text, then add context or behavior, and finish with a generic description. This defined policy ensures screen readers properly convey image information.

What formatting rules apply to image descriptions in Qt docs?

Image descriptions in Qt docs must adhere to an 80-character line limit, align line breaks with filenames, and avoid anti-pattern prefixes. These formatting rules ensure consistent and readable accessibility outputs.

When should I include context versus a generic description for screen-reader understanding?

Include context when the surrounding content explains the image's behavior; otherwise, use a generic description. Always extract visible text first to provide the most accurate screen-reader understanding.

Do Qt documentation standards reference specific external accessibility guidelines?

Qt documentation standards reference W3C and Microsoft alt-text guidelines. This alignment ensures terminology and authoring practices meet broad accessibility documentation requirements for web and printable outputs.

What is the best way to describe complex diagrams for screen readers in API references?

The best way to describe complex diagrams is applying the prioritized alt-text approach: capture visible text, explain the diagram's behavioral context, and provide a concise generic description within the 80-character limit.

Why should I avoid anti-pattern prefixes when authoring alt text?

Avoid anti-pattern prefixes because they add unnecessary verbosity that screen readers read aloud, reducing accessibility. Directly describing the image content provides a much cleaner and more efficient screen-reader experience.