@edupia-tutor/spec-driven-docs 0.14.0

package/core/skills/qc/qa-runner/non-functional.md

@@ -0,0 +1,49 @@
+---
+version: 1.0
+updated: 2026-06-11
+ported_from: ai-automation-qc-base
+---
+
+# Gen Script — Non-Functional
+
+Skill **tự chứa**: convert TC non-functional (performance/security/accessibility/compatibility) → script/đo. Chỉ cần load file này.
+
+## Khi nào trigger
+- Convert TC non-functional (output qa-designer non-functional) sang script/kịch bản đo; TC đã Reviewed
+
+## Khi KHÔNG trigger
+- Kiểm thử chức năng → `functional/*` · tích hợp → `integration.md`
+
+## Quy ước script (bám CLAUDE.md)
+- Tiền đề: `.Test.md` đã Reviewed, có **ngưỡng đo cụ thể**. KHÔNG hardcode → `Env.*`/`CONFIG`.
+- Mỗi loại dùng công cụ phù hợp, gói trong fixture/helper:
+  - **Performance:** đo response time / throughput (pytest + timer, hoặc tích hợp k6/locust); assert ngưỡng.
+  - **Security:** test authZ (role không quyền → 403), input injection, PII không lộ, session/timeout, rate limit.
+  - **Accessibility:** axe-core/lighthouse qua Playwright; assert vi phạm = 0 ở mức WCAG mục tiêu.
+  - **Compatibility:** parametrize trình duyệt/thiết bị.
+- Assert theo **ngưỡng pass** trong TC bằng `expect()`/`assert`; bọc bước `with step("…")` (`from utils.steps import step`, **KHÔNG Allure**); marker `@pytest.mark.{performance,security,accessibility}`.
+
+## Phase 1 — Clarify
+Đọc `.Test.md` · loại + ngưỡng + công cụ · môi trường/tải mẫu · data đặc biệt.
+
+## Phase 2 — Generate
+Mỗi TC → 1 test đo + assert ngưỡng; đánh dấu test cần môi trường/tải riêng (`@pytest.mark.slow`).
+
+## Phase 3 — Verify
+`py_compile` + collect · chạy (môi trường phù hợp) · cập nhật Status TC + số đo thực tế.
+
+## Output
+Script `tests/<project>/non_functional/test_<feature>.py` + helper đo/scan. Bàn giao `qa-reviewer`.
+
+## Phase 4 — Report (bắt buộc sau khi chạy test)
+Report = **Playwright Trace viewer + pytest-html** (KHÔNG Allure, KHÔNG dashboard tự viết).
+
+1. Chạy test kèm pytest-html (trace đã bật sẵn ở conftest → mỗi test có `test-results/<nodeid>/trace.zip`):
+   ```bash
+   pytest tests/<project>/non_functional/test_<feature>.py --html=reports/<feature>/report.html --self-contained-html
+   ```
+2. Gửi cho người dùng:
+   - HTML report: `reports/<feature>/report.html` (self-contained, mở trực tiếp) + số đo thực tế.
+   - Trace từng test (debug step-by-step): `python3 -m playwright show-trace test-results/<nodeid>/trace.zip`.
+   - Tóm tắt: **TOTAL / PASS / FAIL / SKIP** + duration.
+3. TC Fail → mở trace tương ứng để xem timeline/DOM snapshot/network, phân loại script-bug vs product-gap; ghi mô tả lỗi tiếng Việt dễ hiểu + số đo vào Status/khối kết quả của `.Test.md`.

package/core/skills/qc/qa-runner/report/report.md

@@ -0,0 +1,37 @@
+---
+version: 1.1
+updated: 2026-06-11
+ported_from: ai-automation-qc-base
+---
+
+# Report — Playwright Trace + pytest-html (stack chuẩn)
+
+Skill **tự chứa**: sinh report sau khi chạy test. Stack chuẩn dự án dùng **Playwright
+Trace viewer** + **pytest-html** (KHÔNG Allure, KHÔNG dashboard tự viết). Chỉ cần load file này.
+
+## Khi nào trigger
+- Sau khi chạy test cần xuất report / xem lại bằng chứng (trace, screenshot).
+
+## Cơ chế (đã dựng sẵn ở tests/conftest.py)
+- **Trace viewer**: fixture `context` (root conftest) gọi `context.tracing.start(screenshots=True, snapshots=True, sources=True)`; teardown lưu `test-results/<nodeid>/trace.zip`.
+  - Xem: `python3 -m playwright show-trace test-results/<...>/trace.zip` → timeline + DOM snapshot + network + console (UI giống Playwright report bản JS).
+- **pytest-html**: 1 file HTML self-contained. Hook `pytest_runtest_makereport` (root conftest) đính screenshot full-page khi FAIL/SKIP.
+  - Mặc định `reports/report.html` (pytest.ini). Theo feature: `--html=reports/<feature>/report.html --self-contained-html`.
+
+## Quy trình
+1. Chạy test với report theo feature:
+   ```
+   python3 -m pytest tests/<project>/<file>.py \
+       --html=reports/<feature>/report.html --self-contained-html
+   ```
+   (Trace tự bật trong conftest → test-results/<nodeid>/trace.zip cho mọi test.)
+2. Báo path:
+   - HTML: `reports/<feature>/report.html` (on WSL, the Windows-accessible path is `\\wsl.localhost\<distro>\<repo-path>\reports\<feature>\report.html`).
+   - Trace TC fail: `test-results/<nodeid>/trace.zip` + lệnh `playwright show-trace`.
+   - Tóm tắt TOTAL / PASS / FAIL / SKIP + duration.
+
+## Nguyên tắc
+- KHÔNG dùng Allure, KHÔNG sinh dashboard HTML tự viết (đã bỏ utils/html_report.py & cộng sự).
+- Evidence trung thực: trace + screenshot phản ánh đúng lần run; FAIL/gap giữ nguyên.
+- `reports/` và `test-results/` đã gitignore (artifact nặng) — không commit.
+- Interpreter `python3`; browser = the system/installed Chromium configured via `browser_type_launch_args` in the root conftest (see the qc-playwright module) — do not hard-code a binary path.

package/core/skills/setup-ai-first/SKILL.md

@@ -0,0 +1,216 @@
+---
+description: Sets up the Spec-Driven Development framework in any backend project from scratch. Trigger when: "/setup-ai-first", "setup spec-driven workflow", "initialize ai-first framework", "cài đặt framework", "khởi tạo spec-driven", "set up this workflow", "how do I start using this framework".
+---
+
+# /setup-ai-first — Initialize Spec-Driven Docs in a Project
+
+Walk the user through a one-time setup that creates all required directories, installs CLAUDE.md, and verifies the environment.
+
+## Precondition Check
+
+First, ask: "Bạn đang ở project nào? Cho tôi đường dẫn root của project."
+
+Check if already set up:
+- If `.claude/commands/` exists with `.md` files → report "Already set up. Run `/validate-traces` to check status."
+- If `specs/` exists → offer to re-initialize or skip
+
+## Step 1 — Create Directory Structure
+
+Create the following directories (skip if already exist):
+
+```
+{project-root}/
+├── specs/
+│   ├── product-definition/   # Output of /define-product
+│   └── domain-knowledge/     # Business dictionary + core entities
+├── .trace/                   # Traceability state (.trace/{domain}/{prd-slug}/{UC-ID}.tsv)
+└── .agent/
+    └── review/               # Output of /refine-prd ({prd-slug}-findings.yaml)
+```
+
+**Feature-package layout** — per-feature artifacts are NOT pre-created here; each command
+creates its own folder on demand under `specs/{domain}/{prd-slug}/`:
+
+```
+specs/{domain}/{prd-slug}/
+├── prd.md                    # /generate-prd
+├── bdd/                      # /generate-bdd (.feature files)
+├── tech-docs/                # /generate-tech-docs
+└── design-spec/              # /generate-design-spec (FE/App only)
+```
+
+Report each directory created or already existing.
+
+## Step 2 — Copy Slash Commands
+
+Tell the user:
+
+> "Framework này đã cài slash commands vào Claude tự động qua skill system.
+> Nếu bạn muốn dùng commands trực tiếp trong Claude Code project (`.claude/commands/`), chạy lệnh sau:"
+
+```bash
+# Copy all commands from plugin to project
+mkdir -p {project-root}/.claude/commands
+cp {plugin-dir}/commands/*.md {project-root}/.claude/commands/
+```
+
+Note: The `.claude/commands/` copies are optional. Skills in this framework work without them.
+
+## Step 3 — Create CLAUDE.md
+
+Check if `{project-root}/CLAUDE.md` exists:
+- If yes: ask "CLAUDE.md đã tồn tại. Merge template vào hay bỏ qua?"
+- If no: create from template in `templates/architecture.template.md`
+
+After creating, instruct:
+> "Mở CLAUDE.md và điền vào các placeholder `{{...}}` với thông tin dự án của bạn.
+> Đặc biệt quan trọng: §1 (project overview) và §3 (coding standards)."
+
+## Step 4 — Create project-context.yaml
+
+Create `{project-root}/.agent/project-context.yaml`:
+
+```yaml
+# Project context for AI-First workflow
+# Fill in all fields before starting
+
+project:
+  name: "{{PROJECT_NAME}}"
+  description: "{{ONE_LINE_DESCRIPTION}}"
+
+tech_stack:
+  language: "{{LANGUAGE}}"           # e.g. Java 21, Python 3.12, Node.js 20
+  framework: "{{FRAMEWORK}}"         # e.g. Spring Boot 3.x, FastAPI, NestJS
+  build_tool: "{{BUILD_TOOL}}"       # e.g. Gradle, Maven, npm
+  test_framework: "{{TEST_FW}}"      # e.g. JUnit 5, pytest, Jest
+  orm: "{{ORM}}"                     # e.g. Hibernate/JPA, SQLAlchemy, Prisma
+  database: "{{DATABASE}}"           # e.g. PostgreSQL, MySQL, MongoDB
+
+conventions:
+  build_command: "{{BUILD_COMMAND}}"   # e.g. ./gradlew build -x test
+  test_command: "{{TEST_COMMAND}}"     # e.g. ./gradlew test
+  service_run: "{{RUN_COMMAND}}"       # e.g. ./gradlew bootRun
+  ticket_prefix: "{{TICKET_PREFIX}}"  # e.g. PROJ, FEAT, PD
+
+domains: []  # List your business domains, e.g. [rental, payment, user]
+```
+
+## Step 5 — Verify Setup
+
+Run a quick check:
+- [ ] `specs/` directory exists
+- [ ] `.trace/` directory exists
+- [ ] `.agent/project-context.yaml` exists
+- [ ] `CLAUDE.md` exists
+
+Report:
+```
+/setup-ai-first Complete ✅
+
+Directories created: {N}
+Files created:
+  ✅ CLAUDE.md (needs customization)
+  ✅ .agent/project-context.yaml (needs customization)
+```
+
+# Report Footer — Standard Command Output Format
+
+Every command report must end with this standard footer section.
+
+## Status Badge
+
+Choose one based on outcome:
+- `✅ Complete` — all steps succeeded, no issues found
+- `❌ Failed` — command could not complete due to a blocking error
+- `⚠️ Warnings` — completed with non-blocking issues that should be reviewed
+
+## Output Artifacts
+
+List every file created or modified by this command:
+```
+Output Artifacts:
+  {created|updated} {file-path} ({brief description})
+  {created|updated} {file-path} ({brief description})
+```
+
+If no files were written (e.g., review or analysis commands) → write `Output Artifacts: none (read-only)`.
+
+## Pipeline Position
+
+Print a one-line map of the pipeline with the CURRENT command's phase marked `◀ bạn ở đây`,
+so the user always sees where this command sits in the end-to-end flow:
+
+```
+Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
+```
+
+Find the current command in this phase legend and mark **its** phase in the map above:
+
+| Phase | Commands |
+|-------|----------|
+| Discovery | `/define-product` |
+| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
+| Design Spec | `/generate-design-spec` |
+| BDD | `/generate-bdd` · `/review-context` (BDD) |
+| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
+| Code | `/generate-code` · `/review-code` |
+| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
+| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
+| Trace Audit | `/validate-traces` |
+
+For a **review command**, also append the 3-step review loop with the current step marked, e.g.:
+`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
+
+**Cross-cutting commands** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
+`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) sit outside the linear pipeline —
+**omit the Pipeline line entirely** for these (do not force-fit them onto the map).
+
+## Next Command Suggestion
+
+Suggest the logical next command based on workflow phase:
+
+| Current command         | Suggest next                                  |
+|-------------------------|-----------------------------------------------|
+| /setup-ai-first         | `/define-product` to start your first feature |
+| /define-product         | `/generate-prd {product-definition-file}`     |
+| /generate-prd           | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
+| /refine-prd             | Open Review Board → update PRD → `/review-context {prd-file}` |
+| /review-context (PRD)   | FE/App: `/generate-design-spec {prd-file}` (then BDD after sign-off); BE: `/generate-bdd {prd-file}` directly; fix PRD if NEEDS_FIX |
+| /generate-design-spec   | Designer review → Figma links confirmed → PO + Designer sign-off → `/generate-bdd {prd-file}` |
+| /generate-bdd           | `/review-context {feature-file}` to verify coverage |
+| /review-context (BDD)   | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
+| /qc-analyze             | `/qc-plan {UC-ID}` (resolve 🔴 blocker gaps first) |
+| /qc-plan                | `/qc-design-test {UC-ID}`                     |
+| /qc-design-test         | `/qc-review {UC-ID}` (test-case review)       |
+| /qc-review (test-case)  | `/qc-run-test {UC-ID}` if APPROVED; fix TCs if NEEDS_FIX |
+| /qc-run-test            | `/qc-report {UC-ID}` then `/qc-review {UC-ID}` (script review) |
+| /qc-review (script)     | `/qc-report {UC-ID}` then create PR if APPROVED |
+| /qc-report              | `/validate-traces {UC-ID}` to refresh Living Docs (qc_status) |
+| /generate-tech-docs     | `/review-tech-docs {tech-design-file}`        |
+| /review-tech-docs       | `/generate-code {feature-file}` if APPROVED; fix doc if NEEDS_FIX |
+| /generate-code          | First gen → `/review-code {UC-ID}`; re-gen → `/dev-gen-test {UC-ID}` |
+| /dev-gen-test         | `/dev-run-test {UC-ID}`                          |
+| /dev-run-test (passing)    | `/review-code {UC-ID}`                        |
+| /dev-run-test (failing)    | `/fix-bug {ticket-id}` or `/debug {error}`    |
+| /review-code            | `/dev-smoke-test {UC-ID}` or create PR            |
+| /dev-smoke-test             | Create PR and link to ticket                  |
+| /validate-traces        | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; all OK → create PR |
+| /fix-bug                | Create PR and link to ticket                  |
+| /debug                  | `/fix-bug {ticket-id}` if fix needed          |
+| /report-bug             | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
+| /propose-scenario       | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
+| /learn                  | Continue working — lesson applies on next command |
+| /sync                   | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
+| /update-framework       | Review `git diff .agent/`, commit; `/sync` for project content |
+
+Format the footer as:
+```
+---
+Status   : {badge}
+{Output Artifacts block}
+Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
+           (review cmd) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
+Next     : {suggested command with example arguments}
+```
+*(Omit the `Pipeline` line for cross-cutting commands listed above.)*
+