|
| 1 | +--- |
| 2 | +title: Authoring Executable Test Cases with Spry Axiom |
| 3 | +description: Detailed guide for QC teams to structure Markdown test documentation using the Spry Axiom engine. |
| 4 | +icon: FileCheck |
| 5 | +index: 4 |
| 6 | +--- |
| 7 | + |
| 8 | +import { Callout } from 'fumadocs-ui/components/callout'; |
| 9 | +import { Steps, Step } from 'fumadocs-ui/components/steps'; |
| 10 | +import { Tabs, Tab } from 'fumadocs-ui/components/tabs'; |
| 11 | + |
| 12 | +The **Spry engine** uses a Heading-to-Role classification system. It treats Markdown headings as functional nodes in a database rather than just text styles. This enables automated SQL telemetry and audit-ready reporting. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +<Callout type="info"> |
| 17 | + **Visualize Structure:** To see the structure using the Spry Axiom Web-UI, use the command or navigation: `spry axiom web-ui [markdown file path]` |
| 18 | +</Callout> |
| 19 | + |
| 20 | +## 1. The Core Architecture |
| 21 | + |
| 22 | +Every file must begin with a `doc-classify` YAML block. This maps the visual depth of a heading (`#`, `##`, etc.) to a specific **Assurance Role**. |
| 23 | + |
| 24 | +### Role Definitions |
| 25 | +- **Project**: The high-level objective/repository. |
| 26 | +- **Strategy**: Governance (e.g., ISO27001, SOC2, CMMC compliance). |
| 27 | +- **Plan**: Tactical execution window (e.g., Sprint 24, Q1 Release). |
| 28 | +- **Suite**: Logical grouping of functionality. |
| 29 | +- **Case**: The specific test logic and expected behavior. |
| 30 | +- **Evidence**: The lowest level containing logs, screenshots, or checkmarks. |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## 2. Selection of Hierarchy Models |
| 35 | + |
| 36 | +Depending on your project's complexity, you must choose one of the four standard models. **Consistency is key**: do not skip heading levels within a file. |
| 37 | + |
| 38 | +| Model | H1 | H2 | H3 | H4 | H5 | H6 | |
| 39 | +| :--- | :--- | :--- | :--- | :--- | :--- | :--- | |
| 40 | +| **Small** | Project | Case | Evidence | - | - | - | |
| 41 | +| **Medium** | Project | Suite | Case | Evidence | - | - | |
| 42 | +| **Large** | Project | Plan | Suite | Case | Evidence | - | |
| 43 | +| **Complex** | Project | Strategy | Plan | Suite | Case | Evidence | |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 3. Implementation Samples |
| 48 | + |
| 49 | +<Tabs items={['Small', 'Medium', 'Large', 'Complex']}> |
| 50 | + <Tab value="Small"> |
| 51 | + ### Small Model |
| 52 | + *Use for simple unit-level checks or quick smoke tests.* |
| 53 | + |
| 54 | + [View Full Template (qf-small.md)](/qf-small.md) |
| 55 | + |
| 56 | + ```md |
| 57 | + --- |
| 58 | + doc-classify: |
| 59 | + - select: heading[depth="1"] |
| 60 | + role: project |
| 61 | + - select: heading[depth="2"] |
| 62 | + role: case |
| 63 | + - select: heading[depth="3"] |
| 64 | + role: evidence |
| 65 | + --- |
| 66 | + |
| 67 | + # API Validation Project |
| 68 | + ## Verify User Endpoint returns 200 |
| 69 | + ### Evidence |
| 70 | + - [x] Response status is 200 OK. |
| 71 | + ``` |
| 72 | + </Tab> |
| 73 | + |
| 74 | + <Tab value="Medium"> |
| 75 | + ### Medium Model |
| 76 | + *The industry standard for feature-based regression testing.* |
| 77 | + |
| 78 | + [View Full Template (qf-medium.md)](/qf-medium.md) |
| 79 | + |
| 80 | + ```md |
| 81 | + --- |
| 82 | + doc-classify: |
| 83 | + - select: heading[depth="1"] |
| 84 | + role: project |
| 85 | + - select: heading[depth="2"] |
| 86 | + role: suite |
| 87 | + - select: heading[depth="3"] |
| 88 | + role: case |
| 89 | + - select: heading[depth="4"] |
| 90 | + role: evidence |
| 91 | + --- |
| 92 | + |
| 93 | + # E-Commerce Dashboard |
| 94 | + ## Checkout Flow |
| 95 | + ### TC-102: Guest Checkout with Credit Card |
| 96 | + #### Evidence |
| 97 | + - [x] Item added to cart. |
| 98 | + ``` |
| 99 | + </Tab> |
| 100 | + |
| 101 | + <Tab value="Large"> |
| 102 | + ### Large Model |
| 103 | + *Use when managing multiple execution plans or sprints.* |
| 104 | + |
| 105 | + [View Full Template (qf-large.md)](/qf-large.md) |
| 106 | + |
| 107 | + ```md |
| 108 | + --- |
| 109 | + doc-classify: |
| 110 | + - select: heading[depth="1"] |
| 111 | + role: project |
| 112 | + - select: heading[depth="2"] |
| 113 | + role: plan |
| 114 | + - select: heading[depth="3"] |
| 115 | + role: suite |
| 116 | + - select: heading[depth="4"] |
| 117 | + role: case |
| 118 | + - select: heading[depth="5"] |
| 119 | + role: evidence |
| 120 | + --- |
| 121 | + |
| 122 | + # Finance App |
| 123 | + ## Sprint 45 - Payment Rails |
| 124 | + ### International Wire Transfers |
| 125 | + #### TC-W-01: Transfer to EU IBAN |
| 126 | + ##### Evidence |
| 127 | + - [x] Currency conversion applied correctly. |
| 128 | + ``` |
| 129 | + </Tab> |
| 130 | + |
| 131 | + <Tab value="Complex"> |
| 132 | + ### Complex Model |
| 133 | + *Mandatory for high-compliance environments (SOC2/CMMC).* |
| 134 | + |
| 135 | + [View Full Template (qf-complex.md)](/qf-complex.md) |
| 136 | + |
| 137 | + ```md |
| 138 | + --- |
| 139 | + doc-classify: |
| 140 | + - select: heading[depth="1"] |
| 141 | + role: project |
| 142 | + - select: heading[depth="2"] |
| 143 | + role: strategy |
| 144 | + - select: heading[depth="3"] |
| 145 | + role: plan |
| 146 | + - select: heading[depth="4"] |
| 147 | + role: suite |
| 148 | + - select: heading[depth="5"] |
| 149 | + role: case |
| 150 | + - select: heading[depth="6"] |
| 151 | + role: evidence |
| 152 | + --- |
| 153 | + |
| 154 | + # Opsfolio Infrastructure |
| 155 | + ## CMMC Level 2 Compliance |
| 156 | + ### Annual Security Audit 2025 |
| 157 | + #### Access Control (AC) |
| 158 | + ##### AC.L2-3.1.1: Limit Access |
| 159 | + ###### Evidence |
| 160 | + - [x] RBAC configuration verified. |
| 161 | + ``` |
| 162 | + </Tab> |
| 163 | +</Tabs> |
| 164 | + |
| 165 | +--- |
| 166 | + |
| 167 | +## 4. Advanced Metadata & Overrides |
| 168 | + |
| 169 | +To make your QC reports more powerful, you can use **HFM (Header Frontmatter)** blocks or **ID tags** (`@id`) directly under headings. |
| 170 | + |
| 171 | +- **ID Tagging**: Use `@id unique-id` to link cases across different documents. |
| 172 | +- **YAML Overrides**: Change the status or assignee of a specific case inline. |
| 173 | + |
| 174 | +```md |
| 175 | +### Verify Password Complexity |
| 176 | +@id TC-AUTH-09 |
| 177 | +{ |
| 178 | + "role": "case", |
| 179 | + "priority": "high", |
| 180 | + "status": "passed", |
| 181 | + "assignee": "QC_Lead" |
| 182 | +} |
| 183 | + |
| 184 | +``` |
| 185 | + |
| 186 | +--- |
| 187 | + |
| 188 | +## 5. QC Authoring Rules |
| 189 | + |
| 190 | +<Steps> |
| 191 | +<Step> |
| 192 | +**Never Skip Levels**: If you are using the Medium model, don't jump from `#` directly to `###`. |
| 193 | +</Step> |
| 194 | +<Step> |
| 195 | +**One Project Per File**: Only one H1 (`#`) is allowed per document to ensure clean telemetry. |
| 196 | +</Step> |
| 197 | +<Step> |
| 198 | +**Evidence at the Leaf**: Always ensure the `evidence` role is the lowest level of your heading hierarchy. |
| 199 | +</Step> |
| 200 | +<Step> |
| 201 | +**GFM Compliance**: Use standard GitHub Flavored Markdown for checkboxes (`- [x]`) and tables. |
| 202 | +</Step> |
| 203 | +</Steps> |
| 204 | + |
| 205 | +<Callout type="info"> |
| 206 | +Properly structured files allow Qualityfolio to automatically build **Traceability Matrices** used for coverage reporting and risk analysis. |
| 207 | +</Callout> |
| 208 | + |
| 209 | + |
| 210 | + |
0 commit comments