Tirsvad
b5e5613a38
The Version History row of each of the six checklists that gained criteria (QC-DCD, QC-PY, QC-CL, QC-CPP, QC-CS, QC-SH) is Accepted, and the Proposed row becomes Deprecated. Each row says it was accepted by the author as stand-in for S02 (Coding Standards Governance) and that the delta re-review is a draft confirmed by the author as stand-in, not independently. The acceptance takes effect when a reviewer merges this pull request.
SQA-QC-Checklists
Quality-criteria (QC) checklists used by TirSystem to review project
documents and source code. Each checklist is one Markdown file, qc-<type>.md,
with an ID such as QC-BC-001. Every criterion is tagged with an
ISO/IEC 25010:2023 quality characteristic.
Contents
- Business and analysis: Business Case, Stakeholder Analysis, KPI, Business Model Canvas, BPMN, Governance, Milestones and gateways
- Requirements and design: Use Case Diagram, Use Case, User Story, Domain Model, SSD, Operation Contract, Sequence Diagram, DCD, ERD, ADR
- Cross-cutting: Language and Domain (applies to every artifact type written in the Product Owner's language), Domain Dictionary
- Source code: Python, C, C++, C#
Use
Review a document against the checklist for its type: tick each criterion,
record the outcome in a review record, and fix or justify every failed
criterion. Checklists link to each other through their CrossReference row,
for example a Use Case checklist points back to the Stakeholder Analysis one.
The programming checklists assume your team has written down its own coding conventions for the language; they check that code follows them.
Used as a submodule
git submodule add https://github.com/TirSystem/SQA-QC-Checklists.git qc
License
CC BY-SA 4.0. You may share and adapt the checklists, including commercially, if you credit TirSystem and release your adaptation under the same license.
The canonical repository is on git.tirsystem.com; this GitHub repository is a
read-only mirror.