Test Artifact Models
Qualityfolio interprets Markdown-based test artifacts using a strict heading-role classification model. Each heading level maps to a defined assurance role, allowing the execution engine to accurately understand artifact structure, intent, and execution or
Assurance Roles
The following roles are used across all hierarchy models:
- project – Top-level context for the work
- strategy – Governance or compliance strategy
- plan – Tactical execution plan
- suite – Logical grouping of related tests
- case – Individual test case
- evidence – Proof of execution and results
These mappings power:
- Execution hierarchy
- Evidence extraction
- SQL telemetry
- Cross-layer traceability
- Audit-ready reporting
YAML Frontmatter Configuration
All hierarchy models are configured using YAML frontmatter via the doc-classify schema.
Example:
doc-classify:
- select: heading[depth="1"]
role: project
- select: heading[depth="2"]
role: caseSupported Hierarchy Models
Qualityfolio supports four hierarchy models based on documentation complexity:
- Small
- Medium
- Large
- Complex
Small Model (qf-small.md)
Purpose
Designed for lightweight and standalone validations.
Structure
# Project
## Case
### EvidenceRole Mapping
doc-classify:
- select: heading[depth="1"]
role: project
- select: heading[depth="2"]
role: case
- select: heading[depth="3"]
role: evidenceBest For
- Simple UI or API checks
- One-flow validations
- Minimal evidence requirements
Medium Model (qf-medium.md)
Purpose
Adds logical grouping using test suites.
Structure
# Project
## Suite
### Case
#### EvidenceRole Mapping
doc-classify:
- select: heading[depth="1"]
role: project
- select: heading[depth="2"]
role: suite
- select: heading[depth="3"]
role: case
- select: heading[depth="4"]
role: evidenceBest For
- Regression packs
- Feature-level testing
- Multi-step validations
Large Model (qf-large.md)
Purpose
Built for enterprise test repositories with formal planning.
Structure
# Project
## Plan
### Suite
#### Case
##### EvidenceRole Mapping
doc-classify:
- select: heading[depth="1"]
role: project
- select: heading[depth="2"]
role: plan
- select: heading[depth="3"]
role: suite
- select: heading[depth="4"]
role: case
- select: heading[depth="5"]
role: evidenceBest For
- Multi-plan repositories
- DevSecOps pipelines
- Modular test architecture
Complex Model (qf-complex.md)
Purpose
Designed for high-compliance and audit-heavy environments.
Structure
# Project
## Strategy
### Plan
#### Suite
##### Case
###### EvidenceRole Mapping
doc-classify:
- select: heading[depth="1"]
role: project
- select: heading[depth="2"]
role: strategy
- select: heading[depth="3"]
role: plan
- select: heading[depth="4"]
role: suite
- select: heading[depth="5"]
role: case
- select: heading[depth="6"]
role: evidenceBest For
- SOC2, ISO27001, CMMC, PCI-DSS
- Regulatory audits
- Governance-heavy programs
How Qualityfolio Uses Hierarchies
The Spry runbook engine converts Markdown into structured assurance data.
Execution Order
Heading depth controls parent → child execution flow.
Evidence Handling
All evidence blocks are treated as first-class audit artifacts.
SQL Telemetry
Structured records are generated for:
- project
- strategy
- plan
- suite
- case
- evidence
Traceability Graph
Qualityfolio automatically builds traceability matrices used for:
- Coverage reporting
- Compliance mapping
- Risk analysis
- Dashboards
Metadata Overrides
You can override default roles using HFM blocks.
Example:
doc-classify:
role: issue
issue_id: BUG-CMMC-001
test_case_id: TC-CMMC-0005
title: "No incorrect or partial percentage is shown"
status: openBest Practices
- Do not skip heading levels
- Always include valid YAML frontmatter
- Keep evidence only at the lowest level
- Use meaningful, concise headings
- Prefer Complex and Large models for compliance work
How is this guide?
Last updated on