关于 report-generation
用于生成结构化文档无障碍审计报告的 Skill,涵盖问题、评分、整改优先级及 VPAT/ACR 导出。适用于需要按文件、问题类型或严重程度整理审计结果的场景。
主要功能
- 01规定报告必备章节
- 02按严重程度加权评分
- 03分数等级划分
- 04多种问题组织方式
- 05VPAT/ACR 合规性导出
- 06基线整改跟踪
适用场景
- 01撰写文档审计报告
- 02确定无障碍修复优先级
- 03导出合规性评估
- 04比较不同时间的审计结果
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ community-access/ accessibility-agents --skill report-generation安装后在 Claude Code 中输入/report-generation确认已加载。
详细介绍
报告生成
报告文件
默认输出:项目根目录中的 DOCUMENT-ACCESSIBILITY-AUDIT.md。
必需章节
每份审计报告 MUST 包含以下章节:
- 审计信息 - 日期、审计员、配置文件、范围、数量
- 执行摘要 - 总数、通过率、最常见问题、工作量估算
- 跨文档模式 - 重复出现的问题、系统性故障
- 按文件列出的发现 - 每份文档的问题,包括规则 ID、严重程度、位置、WCAG、影响、修复方法
- 按规则列出的发现(交叉引用) - 跨文件的规则级汇总
- 通过项 - 指出无问题的文档和类别
- 修复优先级 - 按影响排序(立即 / 尽快 / 有空时)
- 无障碍评分卡 - 每份文档的分数和等级
- 元数据仪表板 - 文档属性健康状况
- 置信度摘要 - 按置信度等级细分
可选章节(适用时添加)
- 模板分析 - 批量扫描发现共用模板时
- 对比报告 - 根据基线重新扫描时
- CI/CD 建议 - 不存在配置文件时
严重程度评分公式
Document Score = 100 - (sum of weighted findings)
Weights:
Error (high confidence): -10 points
Error (medium confidence): -7 points
Error (low confidence): -3 points
Warning (high confidence): -3 points
Warning (medium confidence):-2 points
Warning (low confidence): -1 point
Tips: 0 points
Floor: 0 (minimum score)
评分等级
| 分数 | 等级 | 含义 |
|---|---|---|
| 90-100 | A | 优秀 - 问题较少或没有问题 |
| 75-89 | B | 良好 - 有一些警告,错误较少 |
| 50-74 | C | 需要改进 - 存在多个错误 |
| 25-49 | D | 较差 - 存在严重的无障碍障碍 |
| 0-24 | F | 不合格 - 存在关键障碍,使用辅助技术时可能无法使用 |
组织模式
| 模式 | 描述 | 适用场景 |
|---|---|---|
| 按文件 | 将每份文档的所有问题归在一起 | 小批量(< 10 个文件) |
| 按问题类型 | 将各文档中每条规则的所有实例归在一起 | 查看模式 |
| 按严重程度 | 先列出关键问题,再列出严重、中等、轻微问题 | 确定修复优先级 |
VPAT/ACR 合规性导出
一致性等级
| 等级 | 标准 |
|---|---|
| 支持 | 所有文档均未发现违反此 WCAG 标准的问题 |
| 部分支持 | 部分文档通过,部分未通过 |
| 不支持 | 所有或大多数文档未通过 |
| 不适用 | 此标准不适用于已扫描的文档类型 |
支持的 VPAT 版本
- VPAT 2.5 (WCAG) - 对应 WCAG 2.2 标准
- VPAT 2.5 (508) - 对应修订版 Section 508 标准
- VPAT 2.5 (EN 301 549) - 对应欧盟无障碍指令
- VPAT 2.5 (INT) - 国际版(以上三种标准的组合)
修复跟踪
与基线审计报告进行比较时:
| 状态 | 含义 |
|---|---|
| 已修复 | 问题出现在上一份报告中,但现在已解决 |
| 新增 | 问题未出现在上一份报告中,但现在出现了 |
| 持续存在 | 上一份报告中的问题仍然存在 |
| 回归 | 问题之前已修复,但现在再次出现 |
进度指标
- 问题减少百分比:
(fixed / previous_total) * 100 - 分数变化:
current_score - previous_score - 改进的文档:分数提高的文档数量
评论
支持 Markdown