Add the SQA and QC framework and project instructions

Mount the framework as a submodule at framework/ (v0.4.0), add AGENTS.md and
the installed skill copies for Codex CLI (.agents/skills) and Claude Code
(.claude/skills).
This commit is contained in:
2026-10-07 23:49:15 +08:00
parent 0d3f30355a
commit 7c0ed0dcc5
117 changed files with 5706 additions and 0 deletions
+45
View File
@@ -0,0 +1,45 @@
# SQA Review Record (RC)
One record per review of a specific artifact instance against its QC
checklist. Create one for **every** artifact instance in the project.
- **File:** `docs/sqa/reviews/rc-<NNN>-<instance-slug>.md`
- **ID:** `RC-NNN`, sequential across all artifact types (the registry's
Next Available Version for `RC`).
- **Create:** `new-artifact.sh RC --file docs/sqa/reviews/rc-NNN-<slug>.md
--cite <INSTANCE-ID>=<instance path> --cite QC-<SHORT>-001=framework/qc/<checklist>.md`
## Required sections (after Metadata / Version History)
- **Artifact Under Review** — links to the instance and to the QC checklist
used, the scope (`full review`, or `delta re-review` with the criteria
covered, the reason and the earlier record), the artifact's language and
domain (its `Language` and `Domain` rows, `n/a` for a technical type) and
the language reviewer (a stakeholder ID, or `none`).
- **Checklist Results** — `# | Criterion | Status (Pass/Fail/N-A) |
Evidence/Notes`, one row per criterion copied from the QC checklist, in
the same order.
- **Language and Domain Results** — only for an artifact of a type written in
the PO language: the rows of `QC-LANG-001`, same columns and order. `N-A` is
not allowed for criteria 3, 5 and 9.
- **Overall Verdict** — Go / Go-with-conditions / No-Go, with rationale.
- **Action Items** — `Action | Owner | Due`. `Owner` is a stakeholder ID from
the project's Stakeholder Analysis, never a role name. Every `Fail` and
every condition gets an item.
## After the review
- The reviewer must not be the artifact's author (see governance). For a
PO-language artifact the reviewer must read its language and know its
domain, or a second reviewer, the language reviewer, does and is named on
the record; see `process/review-checklist-process.md`.
- The record is in English. Quote evidence that is the artifact's own wording
in its language, with a short gloss.
- Add or update the instance's row in the Traceability Matrix, including
this `RC-*` in "Last Reviewed".
- On **Go**, set the reviewed artifact's latest `## Version History` row to
`Accepted` and the row before it to `Deprecated` (`Approved` is not a
status). On Go-with-conditions the status stays `Proposed` until the action
items are closed. If the change is refused for good, set the row to
`Rejected` (the earlier `Accepted` row stays).
- Step-by-step narrative: `framework/process/review-checklist-process.md`.