qa-skills 3.0.0 → 3.1.0

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.
Files changed (262) hide show
  1. package/README.md +20 -149
  2. package/bin/cli.js +1 -40
  3. package/package.json +23 -26
  4. package/dist/agents/registry.d.ts +0 -5
  5. package/dist/agents/registry.d.ts.map +0 -1
  6. package/dist/agents/registry.js +0 -101
  7. package/dist/agents/registry.js.map +0 -1
  8. package/dist/agents/types.d.ts +0 -9
  9. package/dist/agents/types.d.ts.map +0 -1
  10. package/dist/agents/types.js +0 -2
  11. package/dist/agents/types.js.map +0 -1
  12. package/dist/dependencies.d.ts +0 -21
  13. package/dist/dependencies.d.ts.map +0 -1
  14. package/dist/dependencies.js +0 -125
  15. package/dist/dependencies.js.map +0 -1
  16. package/dist/installer.d.ts +0 -25
  17. package/dist/installer.d.ts.map +0 -1
  18. package/dist/installer.js +0 -437
  19. package/dist/installer.js.map +0 -1
  20. package/dist/scaffold.d.ts +0 -27
  21. package/dist/scaffold.d.ts.map +0 -1
  22. package/dist/scaffold.js +0 -182
  23. package/dist/scaffold.js.map +0 -1
  24. package/skills/qa-accessibility-test-writer/SKILL.md +0 -127
  25. package/skills/qa-accessibility-test-writer/references/axe-core-patterns.md +0 -349
  26. package/skills/qa-accessibility-test-writer/references/best-practices.md +0 -184
  27. package/skills/qa-accessibility-test-writer/references/wcag-tests.md +0 -331
  28. package/skills/qa-api-contract-curator/SKILL.md +0 -104
  29. package/skills/qa-api-contract-curator/references/breaking-changes.md +0 -363
  30. package/skills/qa-api-contract-curator/references/openapi-structure.md +0 -404
  31. package/skills/qa-browser-data-collector/SKILL.md +0 -132
  32. package/skills/qa-browser-data-collector/references/data-collection-checklist.md +0 -91
  33. package/skills/qa-browser-data-collector/references/playwright-mcp-patterns.md +0 -113
  34. package/skills/qa-bug-ticket-creator/SKILL.md +0 -148
  35. package/skills/qa-bug-ticket-creator/references/bug-report-format.md +0 -149
  36. package/skills/qa-bug-ticket-creator/references/severity-guide.md +0 -81
  37. package/skills/qa-bug-ticket-creator/templates/bug-ticket-template.md +0 -39
  38. package/skills/qa-changelog-analyzer/SKILL.md +0 -134
  39. package/skills/qa-changelog-analyzer/references/git-analysis-patterns.md +0 -138
  40. package/skills/qa-changelog-analyzer/references/impact-mapping.md +0 -120
  41. package/skills/qa-clickup-integration/SKILL.md +0 -166
  42. package/skills/qa-clickup-integration/references/api-patterns.md +0 -102
  43. package/skills/qa-clickup-integration/references/field-mapping.md +0 -71
  44. package/skills/qa-codeceptjs-writer/SKILL.md +0 -136
  45. package/skills/qa-codeceptjs-writer/references/best-practices.md +0 -207
  46. package/skills/qa-codeceptjs-writer/references/config.md +0 -255
  47. package/skills/qa-codeceptjs-writer/references/patterns.md +0 -285
  48. package/skills/qa-coverage-analyzer/SKILL.md +0 -166
  49. package/skills/qa-coverage-analyzer/references/best-practices.md +0 -142
  50. package/skills/qa-coverage-analyzer/references/coverage-dimensions.md +0 -155
  51. package/skills/qa-coverage-analyzer/references/tools.md +0 -204
  52. package/skills/qa-cypress-writer/SKILL.md +0 -134
  53. package/skills/qa-cypress-writer/references/assertions.md +0 -121
  54. package/skills/qa-cypress-writer/references/best-practices.md +0 -82
  55. package/skills/qa-cypress-writer/references/config.md +0 -121
  56. package/skills/qa-cypress-writer/references/patterns.md +0 -170
  57. package/skills/qa-data-factory/SKILL.md +0 -126
  58. package/skills/qa-data-factory/references/factory-patterns.md +0 -164
  59. package/skills/qa-data-factory/references/faker-guide.md +0 -131
  60. package/skills/qa-diagram-generator/SKILL.md +0 -125
  61. package/skills/qa-diagram-generator/references/c4-model.md +0 -53
  62. package/skills/qa-diagram-generator/references/charts.md +0 -58
  63. package/skills/qa-diagram-generator/references/class-diagram.md +0 -85
  64. package/skills/qa-diagram-generator/references/er-diagram.md +0 -69
  65. package/skills/qa-diagram-generator/references/flowchart.md +0 -92
  66. package/skills/qa-diagram-generator/references/from-screenshot.md +0 -45
  67. package/skills/qa-diagram-generator/references/gantt.md +0 -49
  68. package/skills/qa-diagram-generator/references/journey.md +0 -50
  69. package/skills/qa-diagram-generator/references/mindmap.md +0 -75
  70. package/skills/qa-diagram-generator/references/sequence.md +0 -69
  71. package/skills/qa-diagram-generator/references/state-diagram.md +0 -56
  72. package/skills/qa-discovery-interview/SKILL.md +0 -182
  73. package/skills/qa-discovery-interview/references/completeness-checklist.md +0 -53
  74. package/skills/qa-discovery-interview/references/conflict-patterns.md +0 -101
  75. package/skills/qa-discovery-interview/references/qa-categories.md +0 -147
  76. package/skills/qa-discovery-interview/templates/qa-brief-template.md +0 -168
  77. package/skills/qa-environment-checker/SKILL.md +0 -142
  78. package/skills/qa-environment-checker/references/dependency-matrix.md +0 -101
  79. package/skills/qa-environment-checker/references/health-checks.md +0 -209
  80. package/skills/qa-environment-checker/templates/env-readiness-template.md +0 -64
  81. package/skills/qa-flaky-detector/SKILL.md +0 -153
  82. package/skills/qa-flaky-detector/references/ci-analysis.md +0 -140
  83. package/skills/qa-flaky-detector/references/flaky-patterns.md +0 -247
  84. package/skills/qa-github-issues-enhanced/SKILL.md +0 -175
  85. package/skills/qa-github-issues-enhanced/references/issue-templates.md +0 -425
  86. package/skills/qa-github-issues-enhanced/references/label-taxonomy.md +0 -130
  87. package/skills/qa-github-issues-enhanced/references/workflow-patterns.md +0 -188
  88. package/skills/qa-httpx-writer/SKILL.md +0 -138
  89. package/skills/qa-httpx-writer/references/assertions.md +0 -195
  90. package/skills/qa-httpx-writer/references/best-practices.md +0 -140
  91. package/skills/qa-httpx-writer/references/config.md +0 -212
  92. package/skills/qa-httpx-writer/references/patterns.md +0 -262
  93. package/skills/qa-jest-writer/SKILL.md +0 -131
  94. package/skills/qa-jest-writer/references/assertions.md +0 -125
  95. package/skills/qa-jest-writer/references/best-practices.md +0 -136
  96. package/skills/qa-jest-writer/references/config.md +0 -134
  97. package/skills/qa-jest-writer/references/patterns.md +0 -172
  98. package/skills/qa-jira-integration/SKILL.md +0 -135
  99. package/skills/qa-jira-integration/references/api-patterns.md +0 -143
  100. package/skills/qa-jira-integration/references/field-mapping.md +0 -79
  101. package/skills/qa-jira-integration/references/xray-integration.md +0 -85
  102. package/skills/qa-jmeter-writer/SKILL.md +0 -171
  103. package/skills/qa-jmeter-writer/references/best-practices.md +0 -157
  104. package/skills/qa-jmeter-writer/references/config.md +0 -204
  105. package/skills/qa-jmeter-writer/references/patterns.md +0 -242
  106. package/skills/qa-junit5-writer/SKILL.md +0 -157
  107. package/skills/qa-junit5-writer/references/assertions.md +0 -118
  108. package/skills/qa-junit5-writer/references/config.md +0 -97
  109. package/skills/qa-junit5-writer/references/patterns.md +0 -162
  110. package/skills/qa-k6-writer/SKILL.md +0 -155
  111. package/skills/qa-k6-writer/references/best-practices.md +0 -236
  112. package/skills/qa-k6-writer/references/config.md +0 -219
  113. package/skills/qa-k6-writer/references/patterns.md +0 -304
  114. package/skills/qa-linear-integration/SKILL.md +0 -137
  115. package/skills/qa-linear-integration/references/api-patterns.md +0 -249
  116. package/skills/qa-linear-integration/references/field-mapping.md +0 -121
  117. package/skills/qa-locust-writer/SKILL.md +0 -151
  118. package/skills/qa-locust-writer/references/best-practices.md +0 -126
  119. package/skills/qa-locust-writer/references/config.md +0 -170
  120. package/skills/qa-locust-writer/references/patterns.md +0 -235
  121. package/skills/qa-manual-test-designer/SKILL.md +0 -145
  122. package/skills/qa-manual-test-designer/references/exploratory-charters.md +0 -138
  123. package/skills/qa-manual-test-designer/references/personas.md +0 -146
  124. package/skills/qa-manual-test-designer/templates/exploratory-charter-template.md +0 -47
  125. package/skills/qa-manual-test-designer/templates/test-case-template.md +0 -31
  126. package/skills/qa-mobile-test-writer/SKILL.md +0 -144
  127. package/skills/qa-mobile-test-writer/references/best-practices.md +0 -214
  128. package/skills/qa-mobile-test-writer/references/config.md +0 -309
  129. package/skills/qa-mobile-test-writer/references/patterns.md +0 -304
  130. package/skills/qa-nfr-analyst/SKILL.md +0 -177
  131. package/skills/qa-nfr-analyst/references/iso-25010-model.md +0 -159
  132. package/skills/qa-nfr-analyst/references/owasp-wstg-baseline.md +0 -202
  133. package/skills/qa-nfr-analyst/references/wcag-checklist.md +0 -184
  134. package/skills/qa-nfr-analyst/templates/owasp-checklist-template.md +0 -89
  135. package/skills/qa-nfr-analyst/templates/wcag-checklist-template.md +0 -48
  136. package/skills/qa-orchestrator/SKILL.md +0 -132
  137. package/skills/qa-orchestrator/references/handoff-chains.md +0 -105
  138. package/skills/qa-orchestrator/references/pipeline-modes.md +0 -115
  139. package/skills/qa-orchestrator/references/scheduler-rules.md +0 -84
  140. package/skills/qa-pact-writer/SKILL.md +0 -133
  141. package/skills/qa-pact-writer/references/best-practices.md +0 -100
  142. package/skills/qa-pact-writer/references/config.md +0 -135
  143. package/skills/qa-pact-writer/references/patterns.md +0 -161
  144. package/skills/qa-plan-creator/SKILL.md +0 -139
  145. package/skills/qa-plan-creator/references/introduction-plan.md +0 -43
  146. package/skills/qa-plan-creator/references/migration-plan.md +0 -44
  147. package/skills/qa-plan-creator/references/onboarding-plan.md +0 -46
  148. package/skills/qa-plan-creator/references/performance-plan.md +0 -44
  149. package/skills/qa-plan-creator/references/regression-plan.md +0 -45
  150. package/skills/qa-plan-creator/references/release-plan.md +0 -45
  151. package/skills/qa-plan-creator/references/sprint-plan.md +0 -44
  152. package/skills/qa-plan-creator/references/test-plan.md +0 -59
  153. package/skills/qa-plan-creator/references/uat-plan.md +0 -43
  154. package/skills/qa-plan-creator/templates/checklist-template.md +0 -36
  155. package/skills/qa-plan-creator/templates/regression-checklist-template.md +0 -49
  156. package/skills/qa-plan-creator/templates/release-checklist-template.md +0 -46
  157. package/skills/qa-plan-creator/templates/test-plan-template.md +0 -74
  158. package/skills/qa-playwright-py-writer/SKILL.md +0 -156
  159. package/skills/qa-playwright-py-writer/references/best-practices.md +0 -194
  160. package/skills/qa-playwright-py-writer/references/config.md +0 -195
  161. package/skills/qa-playwright-py-writer/references/patterns.md +0 -212
  162. package/skills/qa-playwright-ts-writer/SKILL.md +0 -151
  163. package/skills/qa-playwright-ts-writer/references/assertions.md +0 -109
  164. package/skills/qa-playwright-ts-writer/references/best-practices.md +0 -191
  165. package/skills/qa-playwright-ts-writer/references/config.md +0 -144
  166. package/skills/qa-playwright-ts-writer/references/patterns.md +0 -171
  167. package/skills/qa-pytest-writer/SKILL.md +0 -145
  168. package/skills/qa-pytest-writer/references/assertions.md +0 -149
  169. package/skills/qa-pytest-writer/references/best-practices.md +0 -97
  170. package/skills/qa-pytest-writer/references/config.md +0 -176
  171. package/skills/qa-pytest-writer/references/patterns.md +0 -251
  172. package/skills/qa-qase-integration/SKILL.md +0 -149
  173. package/skills/qa-qase-integration/references/api-reference.md +0 -354
  174. package/skills/qa-qase-integration/references/ci-integration.md +0 -196
  175. package/skills/qa-qase-integration/references/field-mapping.md +0 -157
  176. package/skills/qa-requirements-generator/SKILL.md +0 -152
  177. package/skills/qa-requirements-generator/references/iso-29148-structure.md +0 -153
  178. package/skills/qa-requirements-generator/references/requirement-patterns.md +0 -278
  179. package/skills/qa-rest-assured-writer/SKILL.md +0 -137
  180. package/skills/qa-rest-assured-writer/references/best-practices.md +0 -50
  181. package/skills/qa-rest-assured-writer/references/config.md +0 -124
  182. package/skills/qa-rest-assured-writer/references/patterns.md +0 -192
  183. package/skills/qa-risk-analyzer/SKILL.md +0 -158
  184. package/skills/qa-risk-analyzer/references/impact-analysis.md +0 -133
  185. package/skills/qa-risk-analyzer/references/risk-factors.md +0 -123
  186. package/skills/qa-robot-framework-writer/SKILL.md +0 -147
  187. package/skills/qa-robot-framework-writer/references/best-practices.md +0 -249
  188. package/skills/qa-robot-framework-writer/references/config.md +0 -204
  189. package/skills/qa-robot-framework-writer/references/libraries.md +0 -273
  190. package/skills/qa-robot-framework-writer/references/patterns.md +0 -216
  191. package/skills/qa-security-test-writer/SKILL.md +0 -123
  192. package/skills/qa-security-test-writer/references/best-practices.md +0 -155
  193. package/skills/qa-security-test-writer/references/owasp-top10.md +0 -331
  194. package/skills/qa-security-test-writer/references/zap-config.md +0 -258
  195. package/skills/qa-selenium-java-writer/SKILL.md +0 -143
  196. package/skills/qa-selenium-java-writer/references/best-practices.md +0 -59
  197. package/skills/qa-selenium-java-writer/references/config.md +0 -143
  198. package/skills/qa-selenium-java-writer/references/patterns.md +0 -170
  199. package/skills/qa-selenium-py-writer/SKILL.md +0 -150
  200. package/skills/qa-selenium-py-writer/references/best-practices.md +0 -175
  201. package/skills/qa-selenium-py-writer/references/config.md +0 -224
  202. package/skills/qa-selenium-py-writer/references/patterns.md +0 -255
  203. package/skills/qa-shortcut-integration/SKILL.md +0 -143
  204. package/skills/qa-shortcut-integration/references/api-patterns.md +0 -126
  205. package/skills/qa-shortcut-integration/references/field-mapping.md +0 -66
  206. package/skills/qa-spec-auditor/SKILL.md +0 -162
  207. package/skills/qa-spec-auditor/references/audit-checklist.md +0 -144
  208. package/skills/qa-spec-auditor/references/drift-patterns.md +0 -207
  209. package/skills/qa-spec-writer/SKILL.md +0 -143
  210. package/skills/qa-spec-writer/references/gherkin-guide.md +0 -253
  211. package/skills/qa-spec-writer/references/specification-patterns.md +0 -274
  212. package/skills/qa-spring-test-writer/SKILL.md +0 -170
  213. package/skills/qa-spring-test-writer/references/best-practices.md +0 -57
  214. package/skills/qa-spring-test-writer/references/config.md +0 -179
  215. package/skills/qa-spring-test-writer/references/patterns.md +0 -235
  216. package/skills/qa-supertest-writer/SKILL.md +0 -150
  217. package/skills/qa-supertest-writer/references/assertions.md +0 -192
  218. package/skills/qa-supertest-writer/references/best-practices.md +0 -102
  219. package/skills/qa-supertest-writer/references/config.md +0 -166
  220. package/skills/qa-supertest-writer/references/patterns.md +0 -242
  221. package/skills/qa-task-creator/SKILL.md +0 -142
  222. package/skills/qa-task-creator/references/linking-patterns.md +0 -127
  223. package/skills/qa-task-creator/references/task-types.md +0 -169
  224. package/skills/qa-task-creator/templates/task-template.md +0 -24
  225. package/skills/qa-test-doc-compiler/SKILL.md +0 -114
  226. package/skills/qa-test-doc-compiler/references/agile-tailoring.md +0 -220
  227. package/skills/qa-test-doc-compiler/references/iso-29119-3-documents.md +0 -302
  228. package/skills/qa-test-healer/SKILL.md +0 -101
  229. package/skills/qa-test-healer/references/diagnosis-patterns.md +0 -142
  230. package/skills/qa-test-healer/references/fix-strategies.md +0 -177
  231. package/skills/qa-test-reporter/SKILL.md +0 -130
  232. package/skills/qa-test-reporter/references/best-practices.md +0 -162
  233. package/skills/qa-test-reporter/references/iso-29119-reports.md +0 -236
  234. package/skills/qa-test-reporter/references/report-formats.md +0 -287
  235. package/skills/qa-test-reviewer/SKILL.md +0 -142
  236. package/skills/qa-test-reviewer/references/anti-patterns.md +0 -268
  237. package/skills/qa-test-reviewer/references/review-checklist.md +0 -93
  238. package/skills/qa-test-strategy/SKILL.md +0 -133
  239. package/skills/qa-test-strategy/references/entry-exit-criteria.md +0 -176
  240. package/skills/qa-test-strategy/references/risk-matrix.md +0 -102
  241. package/skills/qa-test-strategy/references/testing-types.md +0 -143
  242. package/skills/qa-testcase-from-docs/SKILL.md +0 -161
  243. package/skills/qa-testcase-from-docs/references/test-case-format.md +0 -196
  244. package/skills/qa-testcase-from-docs/references/test-design-techniques.md +0 -126
  245. package/skills/qa-testcase-from-docs/templates/test-case-template.md +0 -31
  246. package/skills/qa-testcase-from-ui/SKILL.md +0 -109
  247. package/skills/qa-testcase-from-ui/references/ui-element-patterns.md +0 -126
  248. package/skills/qa-testcase-from-ui/references/visual-analysis-guide.md +0 -146
  249. package/skills/qa-testcase-from-ui/templates/test-case-template.md +0 -31
  250. package/skills/qa-visual-regression-writer/SKILL.md +0 -175
  251. package/skills/qa-visual-regression-writer/references/best-practices.md +0 -154
  252. package/skills/qa-visual-regression-writer/references/config.md +0 -220
  253. package/skills/qa-visual-regression-writer/references/patterns.md +0 -213
  254. package/skills/qa-vitest-writer/SKILL.md +0 -141
  255. package/skills/qa-vitest-writer/references/assertions.md +0 -105
  256. package/skills/qa-vitest-writer/references/best-practices.md +0 -62
  257. package/skills/qa-vitest-writer/references/config.md +0 -127
  258. package/skills/qa-vitest-writer/references/patterns.md +0 -141
  259. package/skills/qa-webdriverio-writer/SKILL.md +0 -145
  260. package/skills/qa-webdriverio-writer/references/best-practices.md +0 -176
  261. package/skills/qa-webdriverio-writer/references/config.md +0 -240
  262. package/skills/qa-webdriverio-writer/references/patterns.md +0 -269
@@ -1,126 +0,0 @@
1
- # Shortcut API Patterns
2
-
3
- ## Base URL and Headers
4
-
5
- ```
6
- Base URL: https://api.app.shortcut.com/api/v3
7
- Headers:
8
- Shortcut-Token: <SHORTCUT_API_TOKEN>
9
- Content-Type: application/json
10
- ```
11
-
12
- ## Stories
13
-
14
- ### Create Story
15
-
16
- ```
17
- POST /api/v3/stories
18
- ```
19
-
20
- **Request body:**
21
- ```json
22
- {
23
- "name": "Login fails when password contains special chars",
24
- "description": "**Expected:** User can log in with special chars in password.\n**Actual:** 500 error.\n**Steps:** 1. Enter password with @#$ 2. Click Login",
25
- "story_type": "bug",
26
- "project_id": 123,
27
- "labels": [{"name": "auth"}, {"name": "severity-critical"}],
28
- "workflow_state_id": 50000001,
29
- "external_links": [
30
- {"url": "https://example.com/test-case/TC-001", "title": "Test Case TC-001"}
31
- ]
32
- }
33
- ```
34
-
35
- **Story types:** `bug`, `feature`, `chore`
36
-
37
- ### Get Story
38
-
39
- ```
40
- GET /api/v3/stories/{story_id}
41
- ```
42
-
43
- ### Update Story
44
-
45
- ```
46
- PUT /api/v3/stories/{story_id}
47
- ```
48
-
49
- **Partial update example:**
50
- ```json
51
- {
52
- "workflow_state_id": 50000002,
53
- "labels": [{"name": "verified"}],
54
- "description": "Original description + verification notes"
55
- }
56
- ```
57
-
58
- ### Search Stories
59
-
60
- ```
61
- GET /api/v3/search/stories?query=login&project_id=123
62
- ```
63
-
64
- Query supports text search, filters by project, epic, iteration, label.
65
-
66
- ## Epics
67
-
68
- ### List Epics
69
-
70
- ```
71
- GET /api/v3/epics
72
- ```
73
-
74
- Returns epics with `id`, `name`, `state`. Use to resolve epic by name for story creation.
75
-
76
- ### Link Story to Epic
77
-
78
- Include `epic_id` in create/update story request.
79
-
80
- ## Iterations
81
-
82
- ### List Iterations
83
-
84
- ```
85
- GET /api/v3/iterations
86
- ```
87
-
88
- Returns iterations (sprints) with `id`, `name`, `status`. Use to assign stories to current sprint.
89
-
90
- ### Assign Story to Iteration
91
-
92
- Include `iteration_id` in create/update story request.
93
-
94
- ## Workflows
95
-
96
- ### List Workflow States
97
-
98
- ```
99
- GET /api/v3/workflows
100
- ```
101
-
102
- Returns workflow states per project. Map QA status (e.g., "Open", "In Progress", "Done") to `workflow_state_id`.
103
-
104
- ## Labels
105
-
106
- Labels are created in Shortcut UI or via API. Use exact names when adding to stories:
107
-
108
- ```json
109
- "labels": [{"name": "auth"}, {"name": "severity-critical"}, {"name": "test-type-e2e"}]
110
- ```
111
-
112
- ## External Links
113
-
114
- Add links to test cases, requirements, evidence:
115
-
116
- ```json
117
- "external_links": [
118
- {"url": "https://example.com/test/TC-001", "title": "Test Case TC-001"},
119
- {"url": "https://example.com/req/REQ-42", "title": "Requirement REQ-42"}
120
- ]
121
- ```
122
-
123
- ## Rate Limits
124
-
125
- - 200 requests per minute
126
- - Throttle bulk operations; use batch endpoints when available
@@ -1,66 +0,0 @@
1
- # QA Field → Shortcut Field Mapping
2
-
3
- ## Bug Report (from qa-bug-ticket-creator)
4
-
5
- | QA Field | Shortcut Field | Notes |
6
- | -------- | -------------- | ----- |
7
- | Title | `name` | Direct mapping |
8
- | Description (expected/actual/steps) | `description` | Markdown; use headers for structure |
9
- | Severity | `labels` | e.g., `severity-critical`, `severity-major` |
10
- | Priority | `labels` | e.g., `priority-p1`, `priority-p2` |
11
- | Component/Module | `labels` | e.g., `auth`, `frontend`, `api` |
12
- | Environment | `description` | Append to description or comment |
13
- | Evidence (screenshots, logs) | `external_links` | Link to artifact URLs |
14
- | — | `story_type` | Always `bug` for bug reports |
15
-
16
- ## QA Task (from qa-task-creator)
17
-
18
- | QA Field | Shortcut Field | Notes |
19
- | -------- | -------------- | ----- |
20
- | Title | `name` | Direct mapping |
21
- | Description + acceptance criteria | `description` | Markdown |
22
- | Task type (Dev/QA/Docs/Enhancement) | `story_type` | Dev→feature, QA→chore, Docs→chore, Enhancement→feature |
23
- | Component | `labels` | Component label |
24
- | Links to bug/requirement | `external_links` | Add URL + title |
25
- | — | `story_type` | `feature` or `chore` per task type |
26
-
27
- ## Coverage Gap (from qa-coverage-analyzer)
28
-
29
- | QA Field | Shortcut Field | Notes |
30
- | -------- | -------------- | ----- |
31
- | Gap description (e.g., "Add tests for AuthService") | `name` | Concise |
32
- | Module/file, coverage % | `description` | Context |
33
- | Component | `labels` | e.g., `test-coverage-gap`, `auth` |
34
- | — | `story_type` | `chore` |
35
-
36
- ## Flaky Test (from qa-flaky-detector)
37
-
38
- | QA Field | Shortcut Field | Notes |
39
- | -------- | -------------- | ----- |
40
- | Test name + "flaky" | `name` | e.g., "Login E2E test flaky" |
41
- | Pattern, frequency | `description` | Flaky pattern details |
42
- | Component | `labels` | e.g., `flaky-test`, `auth` |
43
- | — | `story_type` | `bug` |
44
-
45
- ## Workflow State Mapping
46
-
47
- | QA Status | Shortcut workflow_state | Typical name |
48
- | --------- | ----------------------- | ------------ |
49
- | New/Open | Initial state | "To Do", "Backlog" |
50
- | In Progress | Mid-state | "In Progress", "Development" |
51
- | Ready for Test | Pre-done | "Ready for QA", "Review" |
52
- | Verified/Done | Done state | "Done", "Verified" |
53
-
54
- Resolve `workflow_state_id` from `GET /api/v3/workflows`; names vary by workspace.
55
-
56
- ## Label Conventions
57
-
58
- | Category | Examples |
59
- | -------- | -------- |
60
- | Severity | `severity-critical`, `severity-major`, `severity-minor` |
61
- | Priority | `priority-p1`, `priority-p2`, `priority-p3` |
62
- | Component | `auth`, `frontend`, `api`, `checkout` |
63
- | Test type | `test-type-unit`, `test-type-e2e`, `test-type-api` |
64
- | QA-specific | `test-coverage-gap`, `flaky-test`, `docs-update` |
65
-
66
- Create these labels in Shortcut if they don't exist.
@@ -1,162 +0,0 @@
1
- ---
2
- name: qa-spec-auditor
3
- description: Living documentation auditor that compares requirements vs UI/behavior vs API contract vs test results to detect spec drift, outdated docs, and undocumented features.
4
- output_dir: reports/audit
5
- dependencies:
6
- recommended:
7
- - qa-requirements-generator
8
- - qa-spec-writer
9
- ---
10
-
11
- # QA Spec Auditor
12
-
13
- ## Purpose
14
-
15
- Compare "how it should be" vs "how it is" after each release or sprint. Detect spec drift, outdated documentation, undocumented features, and regression set optimization opportunities. Produce actionable drift reports with task suggestions for qa-task-creator.
16
-
17
- ## Trigger Phrases
18
-
19
- - "Spec audit" / "Documentation audit for [release/sprint]"
20
- - "Spec drift" / "Detect drift between docs and implementation"
21
- - "Outdated documentation" / "Docs vs implementation comparison"
22
- - "Undocumented features" / "Find features not in specs"
23
- - "Requirements vs UI" / "Requirements vs API contract"
24
- - "Living documentation audit" / "Spec compliance check"
25
- - "Regression set optimization" / "Worn out tests" / "Test rotation"
26
-
27
- ## Comparison Dimensions
28
-
29
- | Dimension | Source A | Source B | Detects |
30
- |-----------|----------|----------|---------|
31
- | **Requirements ↔ UI/behavior** | Requirements, specs | Live UI (Playwright MCP) | UI doesn't match spec; missing flows |
32
- | **Requirements ↔ API contract** | Requirements, specs | OpenAPI, actual endpoints | API drift; undocumented endpoints |
33
- | **Requirements ↔ Test results** | Requirements | Test cases, RTM, execution | Untested requirements; orphan tests |
34
- | **Documentation ↔ Implementation** | Docs, README, wikis | Code, UI, API | Outdated docs; undocumented behavior |
35
-
36
- See `references/audit-checklist.md` for checklists per dimension.
37
-
38
- ## Detection Categories
39
-
40
- | Category | Description | Output Action |
41
- |----------|-------------|---------------|
42
- | **Outdated documentation** | Docs describe old behavior | Update docs |
43
- | **Undocumented features** | Implementation has features not in specs | Add to specs or create tests |
44
- | **Spec drift** | Behavior changed but docs not updated | Update docs or fix implementation |
45
- | **Regression set optimization** | "Worn out" tests (always pass, low value); suggest rotation | Suggest test rotation; prioritize high-value tests |
46
-
47
- See `references/drift-patterns.md` for common patterns and remediation.
48
-
49
- ## Output Deliverables
50
-
51
- 1. **Drift Report** — Per dimension: findings, severity, affected artifacts
52
- 2. **Action Items** — Update docs / fix implementation / create tests
53
- 3. **Task Suggestions** — Structured for qa-task-creator (doc updates, test creation, spec fixes)
54
- 4. **Regression Set Recommendations** — Tests to rotate, prioritize, or deprioritize
55
-
56
- ### Drift Report Template
57
-
58
- ```markdown
59
- # Spec Audit — [Release/Sprint]
60
-
61
- ## Summary
62
- | Dimension | Findings | Critical | Action Items |
63
- |-----------|----------|----------|--------------|
64
- | Req ↔ UI | N | X | [Count] |
65
- | Req ↔ API | N | X | [Count] |
66
- | Req ↔ Tests | N | X | [Count] |
67
- | Docs ↔ Impl | N | X | [Count] |
68
-
69
- ## Findings by Dimension
70
- ### Requirements ↔ UI
71
- - [Finding] — [Severity] — [Action]
72
- ### Requirements ↔ API
73
- - [Finding] — [Severity] — [Action]
74
- ### Requirements ↔ Tests
75
- - [Finding] — [Severity] — [Action]
76
- ### Documentation ↔ Implementation
77
- - [Finding] — [Severity] — [Action]
78
-
79
- ## Task Suggestions (for qa-task-creator)
80
- 1. [Task type] — [Description] — [Owner]
81
- 2. ...
82
-
83
- ## Regression Set Recommendations
84
- - Rotate: [Tests that are "worn out"]
85
- - Prioritize: [High-value tests]
86
- - Deprioritize: [Low-value, stable tests]
87
- ```
88
-
89
- ## Workflow
90
-
91
- 1. **Input:** Requirements, specs, OpenAPI/API docs, test cases/RTM, optional UI URL
92
- 2. **Requirements ↔ UI:** Use Playwright MCP to explore UI; compare flows, elements, validation to spec
93
- 3. **Requirements ↔ API:** Compare OpenAPI/spec to requirements; detect undocumented endpoints, schema drift
94
- 4. **Requirements ↔ Tests:** Validate RTM; find untested requirements, orphan tests
95
- 5. **Documentation ↔ Implementation:** Compare docs to code/UI/API; flag outdated sections
96
- 6. **Regression optimization:** Analyze test history; identify always-pass, low-value tests; suggest rotation
97
- 7. **Output:** Drift report, action items, task suggestions for qa-task-creator
98
-
99
- ## MCP Tools Used
100
-
101
- - **Playwright MCP (cursor-ide-browser):** UI exploration, compare live behavior to spec
102
- - **GitHub MCP:** Change tracking, PR/commit history for docs and code
103
-
104
- ## Integration with Other Skills
105
-
106
- | Need | Skill | Usage |
107
- |------|-------|-------|
108
- | Task creation | qa-task-creator | Convert action items to structured tasks |
109
- | Requirements source | qa-requirements-generator | Normalized requirements for comparison |
110
- | API contract | qa-api-contract-curator | OpenAPI for API dimension |
111
- | Test cases/RTM | qa-testcase-from-docs, qa-coverage-analyzer | Test mapping, coverage |
112
- | Spec writing | qa-spec-writer | Update specs when drift found |
113
-
114
- ## Scope
115
-
116
- **Can do (autonomous):**
117
- - Compare requirements vs UI (via Playwright MCP)
118
- - Compare requirements vs API contract (OpenAPI)
119
- - Compare requirements vs test results (RTM, coverage)
120
- - Compare documentation vs implementation
121
- - Detect outdated docs, undocumented features, spec drift
122
- - Produce drift report with action items
123
- - Suggest tasks for qa-task-creator
124
- - Recommend regression set optimization (test rotation)
125
- - Use GitHub MCP for change tracking
126
-
127
- **Cannot do (requires confirmation):**
128
- - Modify documentation or code directly
129
- - Change requirements without stakeholder approval
130
- - Override organizational doc/spec policies
131
-
132
- **Will not do (out of scope):**
133
- - Execute tests (consume results only)
134
- - Write or modify test automation
135
- - Deploy or change production systems
136
-
137
- ## Quality Checklist
138
-
139
- - [ ] All four comparison dimensions addressed
140
- - [ ] Drift report includes severity per finding
141
- - [ ] Action items are specific (update X, fix Y, create test Z)
142
- - [ ] Task suggestions formatted for qa-task-creator
143
- - [ ] Regression recommendations include rationale
144
- - [ ] No hardcoded secrets; URLs/config referenced
145
-
146
- ## Troubleshooting
147
-
148
- | Symptom | Likely Cause | Fix |
149
- |---------|--------------|-----|
150
- | UI comparison fails | Playwright MCP not available; auth required | Use API/docs comparison only; note "UI audit skipped" |
151
- | API contract missing | No OpenAPI; endpoints undocumented | Use qa-api-contract-curator first; manual endpoint list |
152
- | RTM incomplete | Requirements lack IDs; tests not traced | Use qa-requirements-generator; qa-testcase-from-docs for traceability |
153
- | Too many findings | Broad scope; noisy comparison | Focus on critical modules; prioritize by business impact |
154
- | Regression data missing | No test history | Use execution logs; flag "insufficient data" |
155
- | GitHub MCP errors | Token, permissions | Verify GitHub token; check repo access |
156
-
157
- ## Reference Files
158
-
159
- | Topic | Reference |
160
- |-------|-----------|
161
- | Audit checklist per dimension | `references/audit-checklist.md` |
162
- | Drift patterns and remediation | `references/drift-patterns.md` |
@@ -1,144 +0,0 @@
1
- # Spec Audit Checklist by Dimension
2
-
3
- ## Overview
4
-
5
- Use these checklists when auditing each comparison dimension. Tick items as verified; flag any mismatches as findings.
6
-
7
- ---
8
-
9
- ## 1. Requirements ↔ UI/Behavior
10
-
11
- ### Prerequisites
12
-
13
- - Requirements document with IDs and acceptance criteria
14
- - Live UI URL (or Playwright MCP target)
15
- - Optional: Screenshots, Figma links
16
-
17
- ### Checklist
18
-
19
- | # | Check | How to Verify | Finding Type |
20
- |---|-------|---------------|--------------|
21
- | 1 | All required flows exist in UI | Navigate each flow; verify steps | Missing flow |
22
- | 2 | UI elements match spec (labels, placeholders) | Compare text, ARIA, structure | Spec drift |
23
- | 3 | Validation rules match spec | Trigger invalid input; compare messages | Spec drift |
24
- | 4 | Required fields enforced | Omit required fields; verify blocking | Spec drift |
25
- | 5 | Error states documented and implemented | Trigger errors; compare to spec | Undocumented / Drift |
26
- | 6 | Navigation/structure matches spec | Compare menu, breadcrumbs, routes | Spec drift |
27
- | 7 | No extra flows not in spec | Explore UI; flag unknown flows | Undocumented feature |
28
- | 8 | Accessibility (if in spec) | axe-core, keyboard nav per WCAG | Spec drift |
29
-
30
- ### Output
31
-
32
- - List of requirements with UI mismatches
33
- - Severity: Critical (blocking), High (wrong behavior), Medium (cosmetic), Low (minor)
34
-
35
- ---
36
-
37
- ## 2. Requirements ↔ API Contract
38
-
39
- ### Prerequisites
40
-
41
- - Requirements with API expectations
42
- - OpenAPI spec or equivalent
43
- - Optional: Actual endpoint responses (from network traffic)
44
-
45
- ### Checklist
46
-
47
- | # | Check | How to Verify | Finding Type |
48
- |---|-------|---------------|--------------|
49
- | 1 | All required endpoints exist | Compare req IDs to OpenAPI paths | Missing endpoint |
50
- | 2 | Request/response schema matches spec | Compare JSON schema to requirements | Spec drift |
51
- | 3 | Status codes match spec | Document expected 200/400/404/etc. | Spec drift |
52
- | 4 | Authentication/authorization per spec | Verify auth headers, scopes | Spec drift |
53
- | 5 | No undocumented endpoints | List all OpenAPI paths; flag untraced | Undocumented feature |
54
- | 6 | Versioning matches (if applicable) | Check /v1/, /v2/ vs spec | Spec drift |
55
- | 7 | Error response format per spec | Trigger errors; compare structure | Spec drift |
56
- | 8 | Deprecated endpoints flagged | Check OpenAPI deprecation vs spec | Outdated doc |
57
-
58
- ### Output
59
-
60
- - Endpoints with mismatches
61
- - Undocumented endpoints
62
- - Schema drift details
63
-
64
- ---
65
-
66
- ## 3. Requirements ↔ Test Results
67
-
68
- ### Prerequisites
69
-
70
- - Requirements with IDs
71
- - RTM (Requirement → Test Case)
72
- - Test execution results (pass/fail, coverage)
73
-
74
- ### Checklist
75
-
76
- | # | Check | How to Verify | Finding Type |
77
- |---|-------|---------------|--------------|
78
- | 1 | Every requirement has ≥1 test | RTM lookup | Untested requirement |
79
- | 2 | Every test traces to ≥1 requirement | RTM reverse lookup | Orphan test |
80
- | 3 | Failed tests map to requirements | Cross-ref results to RTM | Coverage gap |
81
- | 4 | Test coverage matches risk | High-risk reqs have adequate coverage | Gap |
82
- | 5 | Execution status current | Last run date; stale tests | Outdated |
83
- | 6 | Automation status accurate | Manual vs automated flag | Outdated doc |
84
- | 7 | Test design technique diversity | Per qa-coverage-analyzer | Technique gap |
85
-
86
- ### Output
87
-
88
- - Untested requirements
89
- - Orphan tests
90
- - Stale or low-value tests
91
-
92
- ---
93
-
94
- ## 4. Documentation ↔ Implementation
95
-
96
- ### Prerequisites
97
-
98
- - README, wikis, internal docs
99
- - Codebase, UI, API (as implementation source)
100
-
101
- ### Checklist
102
-
103
- | # | Check | How to Verify | Finding Type |
104
- |---|-------|---------------|--------------|
105
- | 1 | Setup/install steps work | Follow README; verify success | Outdated doc |
106
- | 2 | API examples run | Execute doc examples; compare output | Outdated doc |
107
- | 3 | Config options match code | Compare doc to actual config/env | Outdated doc |
108
- | 4 | Architecture diagram matches code | Compare to structure, imports | Outdated doc |
109
- | 5 | Changelog/release notes current | Compare to git history | Outdated doc |
110
- | 6 | Deprecation notices accurate | Check code for deprecated flags | Outdated doc |
111
- | 7 | No significant features missing from docs | Code review vs doc scope | Undocumented feature |
112
- | 8 | Screenshots/UI examples current | Compare to live UI | Outdated doc |
113
-
114
- ### Output
115
-
116
- - Doc sections to update
117
- - Undocumented implementation details
118
- - Broken examples or steps
119
-
120
- ---
121
-
122
- ## 5. Regression Set Optimization (Bonus)
123
-
124
- ### Prerequisites
125
-
126
- - Test execution history (pass/fail over time)
127
- - Test-to-requirement mapping
128
- - Risk data (from qa-risk-analyzer)
129
-
130
- ### Checklist
131
-
132
- | # | Check | How to Verify | Recommendation |
133
- |---|-------|---------------|----------------|
134
- | 1 | "Worn out" tests | Always pass, never fail, many runs | Rotate out or reduce frequency |
135
- | 2 | High-value tests | Cover critical reqs, catch regressions | Prioritize; run first |
136
- | 3 | Low-value, stable tests | Low risk, always pass | Deprioritize |
137
- | 4 | Flaky tests | Intermittent failures | Fix or quarantine |
138
- | 5 | Missing coverage for changed code | Per qa-risk-analyzer impact | Add tests |
139
-
140
- ### Output
141
-
142
- - Tests to rotate
143
- - Tests to prioritize
144
- - Tests to deprioritize or remove
@@ -1,207 +0,0 @@
1
- # Common Spec Drift Patterns and Remediation
2
-
3
- ## Overview
4
-
5
- Spec drift occurs when documentation, requirements, or specs diverge from actual implementation. This reference catalogs common patterns and recommended remediation.
6
-
7
- ---
8
-
9
- ## Pattern 1: Behavior Changed, Docs Not Updated
10
-
11
- ### Description
12
-
13
- Implementation was modified (bug fix, enhancement, refactor) but requirements, specs, or user docs were not updated.
14
-
15
- ### Detection
16
-
17
- - Git history: code changed, doc files unchanged
18
- - Compare current behavior to doc description
19
- - User reports: "The docs say X but it does Y"
20
-
21
- ### Remediation
22
-
23
- | Owner | Action |
24
- |-------|--------|
25
- | **Tech writer / QA** | Update requirements, spec, or user docs to match implementation |
26
- | **Product** | Confirm if behavior change was intentional; if not, file bug |
27
- | **Dev** | Add "update docs" to DoD for behavior-changing PRs |
28
-
29
- ### Prevention
30
-
31
- - Include doc updates in PR checklist
32
- - Link requirements to implementation in traceability
33
- - Periodic spec audits (this skill)
34
-
35
- ---
36
-
37
- ## Pattern 2: Undocumented Feature
38
-
39
- ### Description
40
-
41
- A feature exists in the product (UI, API, behavior) but has no corresponding requirement, spec, or documentation.
42
-
43
- ### Detection
44
-
45
- - UI exploration: flows or elements not in requirements
46
- - API: endpoints not in OpenAPI or requirements
47
- - Code: features without doc references
48
-
49
- ### Remediation
50
-
51
- | Owner | Action |
52
- |-------|--------|
53
- | **Product / BA** | Add requirement; assess if intentional or technical debt |
54
- | **QA** | Create test cases; add to RTM |
55
- | **Tech writer** | Document in user docs, API docs |
56
- | **qa-task-creator** | Create tasks: "Add requirement for [feature]", "Document [endpoint]" |
57
-
58
- ### Prevention
59
-
60
- - Feature flags with doc requirement
61
- - API-first design: OpenAPI before implementation
62
- - Exploratory testing to catch gaps
63
-
64
- ---
65
-
66
- ## Pattern 3: Outdated Documentation
67
-
68
- ### Description
69
-
70
- Documentation describes old behavior, deprecated options, or incorrect steps. Implementation has moved on.
71
-
72
- ### Detection
73
-
74
- - Setup steps fail
75
- - API examples return different structure
76
- - Screenshots don't match UI
77
- - Changelog missing recent releases
78
-
79
- ### Remediation
80
-
81
- | Owner | Action |
82
- |-------|--------|
83
- | **Tech writer** | Update affected sections; verify against current implementation |
84
- | **Dev** | Update code comments, README, inline docs |
85
- | **QA** | Re-verify doc examples; report inaccuracies |
86
-
87
- ### Prevention
88
-
89
- - Doc review in release process
90
- - Automated checks: run doc examples in CI
91
- - Single source of truth (e.g., OpenAPI for API docs)
92
-
93
- ---
94
-
95
- ## Pattern 4: Requirements ↔ Test Gap
96
-
97
- ### Description
98
-
99
- - **Untested requirement:** Requirement has no test
100
- - **Orphan test:** Test has no requirement traceability
101
- - **Stale test:** Test passes but doesn't validate current behavior
102
-
103
- ### Detection
104
-
105
- - RTM gaps (qa-coverage-analyzer)
106
- - Test name/description doesn't match any requirement
107
- - Test steps outdated after behavior change
108
-
109
- ### Remediation
110
-
111
- | Gap Type | Action |
112
- |----------|--------|
113
- | **Untested requirement** | Create test (qa-testcase-from-docs); add to RTM |
114
- | **Orphan test** | Map to requirement or deprecate if redundant |
115
- | **Stale test** | Update test steps; re-validate against current behavior |
116
-
117
- ### Prevention
118
-
119
- - RTM maintained in same workflow as requirements
120
- - Test review when requirements change
121
- - Traceability in test case format
122
-
123
- ---
124
-
125
- ## Pattern 5: API Contract Drift
126
-
127
- ### Description
128
-
129
- - OpenAPI/spec doesn't match actual API responses
130
- - New parameters, fields, or endpoints not in spec
131
- - Deprecated fields still in spec but removed from API
132
-
133
- ### Detection
134
-
135
- - Contract testing (Pact, OpenAPI validator)
136
- - Manual comparison: actual response vs schema
137
- - Consumer integration failures
138
-
139
- ### Remediation
140
-
141
- | Owner | Action |
142
- |-------|--------|
143
- | **API owner** | Update OpenAPI to match implementation |
144
- | **qa-api-contract-curator** | Formalize contract from traffic or code |
145
- | **Consumer teams** | Update clients if breaking change |
146
-
147
- ### Prevention
148
-
149
- - OpenAPI generated from code (or vice versa)
150
- - Contract tests in CI
151
- - Versioning and deprecation policy
152
-
153
- ---
154
-
155
- ## Pattern 6: "Worn Out" Regression Tests
156
-
157
- ### Description
158
-
159
- Tests that always pass, run frequently, but rarely catch bugs. They consume time without adding value. Often cover stable, low-risk areas.
160
-
161
- ### Detection
162
-
163
- - Execution history: 100% pass over many runs
164
- - Low risk score (qa-risk-analyzer)
165
- - Redundant with other tests
166
-
167
- ### Remediation
168
-
169
- | Action | When |
170
- |--------|------|
171
- | **Rotate out** | Run less frequently (e.g., weekly vs every PR) |
172
- | **Consolidate** | Merge with similar tests |
173
- | **Deprioritize** | Run after high-risk tests |
174
- | **Remove** | If truly redundant and low value |
175
-
176
- ### Prevention
177
-
178
- - Risk-based test prioritization
179
- - Periodic test value assessment
180
- - Replace static tests with parameterized or generated tests for coverage
181
-
182
- ---
183
-
184
- ## Severity Guidelines
185
-
186
- | Severity | Criteria | Example |
187
- |----------|----------|---------|
188
- | **Critical** | Blocking; wrong behavior; security | Auth flow doesn't match spec; API returns wrong data |
189
- | **High** | Major discrepancy; user impact | Required validation missing; doc steps fail |
190
- | **Medium** | Noticeable drift; moderate impact | Extra field in API; outdated screenshot |
191
- | **Low** | Minor; cosmetic | Typo in doc; deprecated option still listed |
192
-
193
- ---
194
-
195
- ## Task Suggestion Format for qa-task-creator
196
-
197
- When producing task suggestions, use this structure:
198
-
199
- ```markdown
200
- ## Task: [Title]
201
- - **Type:** doc_update | spec_fix | test_creation | implementation_fix
202
- - **Dimension:** req_ui | req_api | req_tests | docs_impl
203
- - **Finding:** [Brief description]
204
- - **Action:** [Specific action]
205
- - **Artifacts:** [Files, IDs, URLs]
206
- - **Priority:** critical | high | medium | low
207
- ```