report-generation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Report Generation

报告生成

Report File

报告文件

Default output:
DOCUMENT-ACCESSIBILITY-AUDIT.md
in the project root.
默认输出:项目根目录下的
DOCUMENT-ACCESSIBILITY-AUDIT.md
文件。

Required Sections

必填章节

Every audit report MUST include these sections:
  1. Audit Information - date, auditor, profile, scope, counts
  2. Executive Summary - totals, pass rate, most common issue, effort estimate
  3. Cross-Document Patterns - recurring issues, systemic failures
  4. Findings by File - per-document issues with rule ID, severity, location, WCAG, impact, remediation
  5. Findings by Rule (Cross-Reference) - rule-level aggregation across files
  6. What Passed - acknowledge clean documents and categories
  7. Remediation Priority - ordered by impact (Immediate / Soon / When Possible)
  8. Accessibility Scorecard - per-document scores and grades
  9. Metadata Dashboard - document properties health
  10. Confidence Summary - breakdown by confidence level
每份审计报告必须包含以下章节:
  1. 审计信息 - 日期、审计人员、配置文件、审计范围、统计计数
  2. 执行摘要 - 总览、通过率、最常见问题、工作量预估
  3. 跨文档共性问题 - 反复出现的问题、系统性缺陷
  4. 按文件归类的发现 - 每个文档的问题,包含规则ID、严重程度、位置、WCAG、影响、修复方案
  5. 按规则归类的发现(交叉引用) - 跨文件的规则层级聚合统计
  6. 合格项 - 说明无问题的文档和类别
  7. 修复优先级 - 按影响排序(立即修复 / 尽快修复 / 可延后修复)
  8. 可访问性记分卡 - 每个文档的得分和等级
  9. 元数据面板 - 文档属性健康度
  10. 置信度汇总 - 按置信度分级的明细

Optional Sections (include when applicable)

可选章节(适用时添加)

  • Template Analysis - when batch scanning detects shared templates
  • Comparison Report - when re-scanning against a baseline
  • CI/CD Recommendations - when no config files exist
  • 模板分析 - 批量扫描检测到共享模板时添加
  • 对比报告 - 基于基线进行重新扫描时添加
  • CI/CD建议 - 不存在配置文件时添加

Severity Scoring Formula

严重程度评分公式

text
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)
text
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)

Score Grades

得分等级

ScoreGradeMeaning
90-100AExcellent - minor or no issues
75-89BGood - some warnings, few errors
50-74CNeeds Work - multiple errors
25-49DPoor - significant accessibility barriers
0-24FFailing - critical barriers, likely unusable with AT
得分范围等级含义
90-100A优秀 - 仅有微小问题或无问题
75-89B良好 - 存在一些警告,少量错误
50-74C待优化 - 存在多个错误
25-49D较差 - 存在明显的可访问性障碍
0-24F不合格 - 存在严重障碍,使用AT大概率无法正常访问

Organization Modes

组织模式

ModeDescriptionBest For
By fileGroup all issues under each documentSmall batches (< 10 files)
By issue typeGroup all instances of each rule across documentsSeeing patterns
By severityCritical first, then serious, moderate, minorPrioritizing fixes
模式描述适用场景
按文件将所有问题归类到对应文档下小批量扫描(<10个文件)
按问题类型跨文档将同一条规则的所有实例归为一组梳理问题共性模式
按严重程度优先级从高到低:致命>严重>中等>轻微修复优先级排序

VPAT/ACR Compliance Export

VPAT/ACR合规导出

Conformance Levels

合规等级

LevelCriteria
SupportsNo findings for this WCAG criterion across any document
Partially SupportsSome documents pass, some fail
Does Not SupportAll or most documents fail
Not ApplicableCriterion does not apply to scanned document types
等级判定标准
完全符合所有文档的该WCAG标准项均无问题
部分符合部分文档达标,部分不达标
不符合所有或绝大多数文档不达标
不适用该标准项不适用于扫描的文档类型

Supported VPAT Editions

支持的VPAT版本

  • VPAT 2.5 (WCAG) - maps to WCAG 2.2 criteria
  • VPAT 2.5 (508) - maps to Revised Section 508 standards
  • VPAT 2.5 (EN 301 549) - maps to EU accessibility directive
  • VPAT 2.5 (INT) - International edition (all three combined)
  • VPAT 2.5 (WCAG) - 对应WCAG 2.2标准
  • VPAT 2.5 (508) - 对应修订版第508节标准
  • VPAT 2.5 (EN 301 549) - 对应欧盟可访问性指令
  • VPAT 2.5 (INT) - 国际版(包含上述三个版本的全部内容)

Remediation Tracking

修复追踪

When comparing against a baseline audit report:
StatusMeaning
FixedIssue was in previous report but is now resolved
NewIssue was not in previous report but appears now
PersistentIssue remains from previous report
RegressedIssue was previously fixed but has returned
与基线审计报告对比时:
状态含义
已修复上一份报告中存在的问题现已解决
新增上一份报告中不存在,本次扫描新出现的问题
持续存在上一份报告中存在的问题仍未解决
回退此前已修复的问题再次出现

Progress Metrics

进度指标

  • Issue reduction percentage:
    (fixed / previous_total) * 100
  • Score change:
    current_score - previous_score
  • Documents improved: count of documents with higher scores
  • 问题减少百分比:
    (已修复问题数 / 上一次总问题数) * 100
  • 得分变化:
    当前得分 - 上一次得分
  • 改进文档数:得分提升的文档数量