关于 reviewing-a11y
用于检查网页、代码实现或设计稿的无障碍审查技能。它根据目标选择相应指南,并在知识库可用时参考适用的评估标准。
主要功能
- 01识别网页、代码或设计稿目标
- 02选择对应的审查指南
- 03查阅适用的无障碍标准
- 04区分证据与未验证项目
- 05整理发现和后续步骤
适用场景
- 01根据 URL 审查已部署网页
- 02检查源文件中的无障碍问题
- 03评估 Figma 设计或样稿
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ masup9/ a11y-specialist-skills --skill reviewing-a11y安装后在 Claude Code 中输入/reviewing-a11y确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.ja.mdREADME.mdSKILL.ja.mdagents/openai.yamlreferences/code-review.ja.mdcode-review.mddesign-review.ja.mddesign-review.mdpage-review.ja.mdpage-review.mdwcag-checklist.ja.mdwcag-checklist.md详细介绍
无障碍审查
识别用户希望审查的内容,然后按照相应的参考指南执行无障碍审查。
第 1 步:识别审查目标
分析用户的请求,确定审查目标:
网页(实时 URL)
判断依据:
- 用户提供以
http://或https://开头的 URL - 用户说“检查这个页面”“审查这个网站”“测试这个 URL”
- 用户希望审查已部署或正在运行的网站
操作: 按照页面审查指南执行
代码实现
判断依据:
- 用户提供文件路径(
.jsx、.tsx、.vue、.html、.js等) - 用户说“审查这个组件”“检查我的代码”“看看这个实现”
- 用户提到代码库中的特定文件或目录
- 用户询问静态代码分析
操作: 按照代码审查指南执行
设计稿/规范
判断依据:
- 用户提供 Figma URL(figma.com/file/...)
- 用户分享设计图片文件(.png、.jpg、设计稿的 .pdf)
- 用户说“审查这个设计”“检查这个模型图”“看看这个线框图”
- 用户询问设计规范或视觉无障碍
操作: 按照设计审查指南执行
情况不明确时
如果不清楚,请询问用户:
I can review accessibility for:
1. **Live web pages** (provide URL) - I'll test the rendered page
2. **Code implementation** (provide file paths) - I'll analyze the source code
3. **Design mockups** (provide Figma URL or images) - I'll review visual designs
Which would you like me to review?
第 2 步:在知识库中查找判定标准
识别目标后、查看代码或页面之前,请参照 a11y-knowledge 来核对发现。
- 按 ARIA 角色列出目标中出现的组件(button、dialog、combobox 等)。
- 使用 index-by-component.md 查找适用于各角色的成功标准。审查布局或整个页面时,也请从 index-by-criterion.md 中选取“Whole page”和“Multiple pages”标准。
- 对找到的每项标准,在撰写发现之前,先阅读
../a11y-knowledge/references/criteria/<number>.md中的“Judgment lines”和“When building”。不要报告“Judgment lines”中注明不适用的内容。 - 如果发现基于 [Our interpretation] 判定标准(操作性解释),请在发现中说明这一点(例如:“[Our interpretation] 判定标准;项目可能另有规定”)。[Understanding] 判定标准无需此类说明。
知识库的相对路径为 ../a11y-knowledge/。作为插件安装时,该路径可解析。若通过符号链接单独安装技能目录,也请链接 a11y-knowledge。如果该路径无法解析,请跳过此步骤,并在报告中写明“未查阅知识库”。
第 3 步:加载指南并进行审查
识别目标后,阅读与用户所用语言相匹配的参考指南,并直接按照其流程执行。
网页
Read the page review guide:
- English: references/page-review.md
- Japanese: references/page-review.ja.md
Follow the guide using available browser interaction, web retrieval, or user-provided content.
代码
Read the code review guide:
- English: references/code-review.md
- Japanese: references/code-review.ja.md
Follow the guide by inspecting the target files and related implementation.
设计
Read the design review guide:
- English: references/design-review.md
- Japanese: references/design-review.ja.md
Follow the guide using available image, document, or Figma retrieval capabilities.
何时使用子 Agent
- 仅当用户明确要求并行审查、委派给专家或拆分多个目标时,才使用子 Agent。
- 为每个 Agent 分配一种目标类型,并提供相关指南和目标。
- 等待所有结果,删除重复项,并汇总为一份报告。
- 如果无法使用子 Agent,请在当前 Agent 中按顺序审查各个目标。
第 4 步:返回结果
审查完成后:
- 向用户呈现发现
- 如有需要,提出可继续审查其他目标
- 建议后续步骤(例如:“要我接下来审查代码实现吗?”)
重要说明
- 开始审查前,务必先阅读相应指南
- 根据用户所用语言选择语言(英语或日语)
- 区分证据与信息缺口,并说明哪些内容无法验证
- 不要混合审查类型——每种目标类型使用一份指南
工作流示例
示例 1:用户提供 URL
User: "Review https://example.com for accessibility"
1. Identify: This is a web page (URL provided)
2. Look up: find the criteria in index-by-component and read "Judgment lines" and "When building"
3. Read: references/page-review.md
4. Execute: Inspect the page by following the guide
5. Return: Present findings
示例 2:用户提供文件路径
User: "Check src/components/Button.tsx for a11y issues"
1. Identify: This is code (file path provided)
2. Look up: find the criteria in index-by-component and read "Judgment lines" and "When building"
3. Read: references/code-review.md
4. Execute: Inspect the target and related code by following the guide
5. Return: Present findings
示例 3:用户提供 Figma URL
User: "Review this design: https://figma.com/file/abc123"
1. Identify: This is a design (Figma URL)
2. Look up: find the criteria in index-by-component and read "Judgment lines" and "When building"
3. Read: references/design-review.md
4. Execute: Inspect the design by following the guide
5. Return: Present findings
WCAG 和标准参考
所有评审都应参考:
- WCAG 2.2:https://www.w3.org/TR/WCAG22/
- WAI-ARIA APG:https://www.w3.org/WAI/ARIA/apg/
- WCAG 快速参考:https://www.w3.org/WAI/WCAG22/quickref/
常见的参考成功标准:
- 1.1.1 非文本内容(A)
- 1.3.1 信息和关系(A)
- 1.4.3 对比度(最低)(AA)
- 2.1.1 键盘(A)
- 2.4.6 标题和标签(AA)
- 4.1.2 名称、角色、值(A)
不要将缺失的证据视为确凿结论。将缺乏依据的检查列为需人工验证。
评论
支持 Markdown