Tirsvad
304ec7751b
New criteria, appended after the existing ones (nothing renumbered or changed): - DRY in all five qc-programming-* checklists (python, c, cpp, csharp, shell) - dependency rule in all but shell (imports, includes or references point inward, no cycles; in C also one responsibility per module) - SOLID in python, cpp and csharp - qc-dcd.md criterion 9: dependencies between classes and packages point inward (cycles stay with criterion 8) Each is tagged with an ISO/IEC 25010 characteristic, and the criterion Notes name the rule in the framework's coding-conventions skill, which defines it once. Each checklist has a new Proposed Version History row for S02, who accepts coding-standard changes. Common Defects gain a bullet per criterion.
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.