@appfire-ux/audit-agent 0.20260708.0 → 0.20260708.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/templates/commands/full-audit.md +103 -3
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appfire-ux/audit-agent",
|
|
3
|
-
"version": "0.20260708.
|
|
3
|
+
"version": "0.20260708.1",
|
|
4
4
|
"description": "Claude Code audit agents for Appfire apps — ux-auditor (/ux-audit), ui-auditor (/ui-audit), a11y-auditor (/a11y-audit: WCAG 2.2 + axe-core scan feeding the Appfire VPAT/ACR process), /full-audit parallel orchestration. Confluence-ready MD+HTML+PNG output, runtime capture & scan scripts.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"publishConfig": {
|
|
@@ -61,6 +61,9 @@ Hard fail gate:
|
|
|
61
61
|
<out-dir>/
|
|
62
62
|
├── AUDIT-SUMMARY-<date>[-prod].md
|
|
63
63
|
├── AUDIT-SUMMARY-<date>[-prod].html
|
|
64
|
+
├── RECOMMENDATIONS-TABLE-<date>[-prod].md
|
|
65
|
+
├── RECOMMENDATIONS-TABLE-<date>[-prod].html
|
|
66
|
+
├── RECOMMENDATIONS-TABLE-<date>[-prod].json
|
|
64
67
|
├── prod-assets/ # only when orchestrator shares PNG captures across agents
|
|
65
68
|
├── ux-audit/
|
|
66
69
|
│ ├── UX-AUDIT-<date>[-prod].md
|
|
@@ -78,6 +81,84 @@ Hard fail gate:
|
|
|
78
81
|
|
|
79
82
|
Relative image paths in MD/HTML: `assets/<file>.png` — never base64, never `../prod-assets/`.
|
|
80
83
|
|
|
84
|
+
## New required artifact — UX Recommendations Table
|
|
85
|
+
|
|
86
|
+
In addition to existing reports, `/full-audit` MUST generate a consolidated recommendations table artifact in **English**.
|
|
87
|
+
|
|
88
|
+
Output files (required) under `<out-dir>/`:
|
|
89
|
+
- `RECOMMENDATIONS-TABLE-<date>[-prod].md`
|
|
90
|
+
- `RECOMMENDATIONS-TABLE-<date>[-prod].html`
|
|
91
|
+
- `RECOMMENDATIONS-TABLE-<date>[-prod].json` (machine-readable for npm/automation)
|
|
92
|
+
|
|
93
|
+
Purpose:
|
|
94
|
+
- planning-ready recommendations across UX/UI/A11Y with clear priority, implementation intent, justification, and expected user value.
|
|
95
|
+
|
|
96
|
+
Canonical table schema (required columns, exact order):
|
|
97
|
+
1. `Area`
|
|
98
|
+
2. `Priority` (P0/P1/P2)
|
|
99
|
+
3. `Recommended UX Work`
|
|
100
|
+
4. `Justification`
|
|
101
|
+
5. `Expected Value (User Perspective)`
|
|
102
|
+
|
|
103
|
+
Row requirements:
|
|
104
|
+
- Minimum: 6 rows
|
|
105
|
+
- Must include at least:
|
|
106
|
+
- Empty/first-run states
|
|
107
|
+
- Navigation IA/wayfinding
|
|
108
|
+
- Feedback/confidence loops
|
|
109
|
+
- Destructive action safety
|
|
110
|
+
- Accessibility semantics/manual validation
|
|
111
|
+
- Responsive usability
|
|
112
|
+
- Every row must be actionable (not only diagnostic).
|
|
113
|
+
- Language: English only.
|
|
114
|
+
- Keep recommendations deduplicated and normalized across UX/UI/A11Y reports.
|
|
115
|
+
|
|
116
|
+
Priority mapping rules:
|
|
117
|
+
- `P0` = major user risk, activation blocker, or high operational risk
|
|
118
|
+
- `P1` = significant productivity/confidence/accessibility gain
|
|
119
|
+
- `P2` = meaningful optimization, lower urgency
|
|
120
|
+
|
|
121
|
+
Data source rules:
|
|
122
|
+
- Build from:
|
|
123
|
+
- `ux-audit/UX-AUDIT-<date>[-prod].md`
|
|
124
|
+
- `ui-audit/UI-AUDIT-<date>[-prod].md`
|
|
125
|
+
- `a11y-audit/A11Y-AUDIT-<date>[-prod].md`
|
|
126
|
+
- `AUDIT-SUMMARY-<date>[-prod].md`
|
|
127
|
+
- Do not invent runtime evidence.
|
|
128
|
+
- If static-only mode is used, include a note that confidence is lower.
|
|
129
|
+
|
|
130
|
+
Required JSON format:
|
|
131
|
+
```json
|
|
132
|
+
{
|
|
133
|
+
"meta": {
|
|
134
|
+
"date": "YYYY-MM-DD[-prod]",
|
|
135
|
+
"language": "en",
|
|
136
|
+
"sourceReports": [
|
|
137
|
+
"ux-audit/UX-AUDIT-...",
|
|
138
|
+
"ui-audit/UI-AUDIT-...",
|
|
139
|
+
"a11y-audit/A11Y-AUDIT-...",
|
|
140
|
+
"AUDIT-SUMMARY-..."
|
|
141
|
+
]
|
|
142
|
+
},
|
|
143
|
+
"columns": [
|
|
144
|
+
"Area",
|
|
145
|
+
"Priority",
|
|
146
|
+
"Recommended UX Work",
|
|
147
|
+
"Justification",
|
|
148
|
+
"Expected Value (User Perspective)"
|
|
149
|
+
],
|
|
150
|
+
"rows": [
|
|
151
|
+
{
|
|
152
|
+
"Area": "...",
|
|
153
|
+
"Priority": "P0|P1|P2",
|
|
154
|
+
"Recommended UX Work": "...",
|
|
155
|
+
"Justification": "...",
|
|
156
|
+
"Expected Value (User Perspective)": "..."
|
|
157
|
+
}
|
|
158
|
+
]
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
81
162
|
## Role division (/full-audit)
|
|
82
163
|
|
|
83
164
|
| Agent | Owns | Same protocol |
|
|
@@ -159,13 +240,32 @@ Before writing AUDIT-SUMMARY:
|
|
|
159
240
|
- Do not finalize `/full-audit` if UX+UI combined produce fewer than 6 MAJOR findings,
|
|
160
241
|
unless runtime coverage is explicitly blocked and documented.
|
|
161
242
|
- If `coverage_percent < 100`, mark the run `INCOMPLETE AUDIT` and do not present as finished.
|
|
162
|
-
3.
|
|
243
|
+
3. Build `RECOMMENDATIONS-TABLE-<date>[-prod].md|.json` from UX/UI/A11Y/SUMMARY reports:
|
|
244
|
+
- Use required columns in exact order.
|
|
245
|
+
- Ensure at least 6 actionable, deduplicated rows with required topic coverage.
|
|
246
|
+
- Force language to English.
|
|
247
|
+
- Include confidence-lower note if static-only mode was used.
|
|
248
|
+
4. Generate HTML for **all** reports (including `RECOMMENDATIONS-TABLE-*.html`):
|
|
163
249
|
```bash
|
|
164
250
|
node node_modules/@appfire-ux/audit-agent/scripts/build-html-reports.mjs --dir <out-dir>
|
|
165
251
|
```
|
|
166
252
|
(or repo-local `docs/audits/build-html-reports.mjs` if present)
|
|
167
|
-
|
|
253
|
+
5. Optionally serve preview: `npx --yes serve <out-dir> -p 4173` and give user links to `*.html`.
|
|
254
|
+
|
|
255
|
+
## Definition of done extension
|
|
256
|
+
|
|
257
|
+
`/full-audit` is complete only if all are true:
|
|
258
|
+
1. Existing UX/UI/A11Y/SUMMARY artifacts exist (MD + HTML + A11Y JSON).
|
|
259
|
+
2. Recommendations table artifacts exist (MD + HTML + JSON).
|
|
260
|
+
3. Table has required columns and minimum row coverage.
|
|
261
|
+
4. Priorities are assigned and justified from audit evidence.
|
|
168
262
|
|
|
169
263
|
## Relay to the user
|
|
170
264
|
|
|
171
|
-
MD + HTML paths (all reports), combined severity counts, Baseline Accessibility Score + safe conclusion (a11y), top 3 issues, capture coverage, Limitations, local preview URLs, whether parallel run and STOP & ASK occurred.
|
|
265
|
+
MD + HTML paths (all reports), combined severity counts, Baseline Accessibility Score + safe conclusion (a11y), top 3 issues, capture coverage, Limitations, local preview URLs, whether parallel run and STOP & ASK occurred.
|
|
266
|
+
|
|
267
|
+
Always include:
|
|
268
|
+
- paths to recommendations table `.md`, `.html`, `.json`
|
|
269
|
+
- one-line summary of highest-priority (`P0`) recommendation themes
|
|
270
|
+
|
|
271
|
+
Remind the user the a11y `.json` feeds "AI Agent: VPAT Document" (Confluence, CRUX) for the ACR draft.
|