doc-tspec_skill
- Python
9
GitHub Stars
1
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill vladm3105/aidoc-flow-framework --skill doc-tspec- SKILL.md20.1 KB
Overview
This skill creates Test Specifications (TSPEC) as Layer 10 artifacts to define unit, integration, smoke, and functional test cases for Test-Driven Development. It enforces element ID formats, traceability to upstream artifacts, and type-specific coverage and readiness targets. Use it to produce test documents that feed TASKS and implementation work.
How this skill works
The skill guides authors through a validated TSPEC authoring workflow: verify upstream artifacts, pick a TSPEC type (UTEST/ITEST/STEST/FTEST), reserve an ID, and populate mandatory sections like Document Control, Test Scope, Test Case Index, Test Case Details, Coverage Matrix, and Traceability. It enforces naming and element ID patterns (TSPEC.NN.TT.SS), mandates cumulative upstream tags, and provides type-specific validation scripts and quality checks.
When to use it
- You have completed BRD through SPEC (Layers 1–9) and need to define tests before coding
- You follow a Test-Driven Development workflow and want TASKS-ready test specs
- You must produce unit, integration, smoke, or functional test artifacts with traceability
- You need to enforce coverage targets and document error cases and pseudocode
- You want standardized TSPEC files that feed downstream TASKS and code work
Best practices
- Always verify and reference only existing upstream artifacts; do not invent or placeholder missing docs
- Complete the Document Control section first, including SPEC reference and TASKS-Ready Score
- Assign Element IDs using the TSPEC.NN.TT.SS pattern and ensure element type code matches document folder
- Include I/O tables, pseudocode, and explicit error cases for each test case; add sequence diagrams for complex integrations
- Keep cumulative traceability tags from Layers 1–9 and update the TSPEC traceability matrix file
Example use cases
- Write UTEST files to specify unit tests for a new authentication module with function and branch coverage targets
- Create ITEST documents describing API contract validation and mock strategies between services
- Author STEST smoke checks for post-deployment health with <5 minute execution and rollback steps
- Produce FTEST files mapping system-level scenarios to SYS requirements and performance thresholds
- Generate a TSPEC-00 index or traceability-template exempt from validation for project scaffolding
FAQ
Use TSPEC.NN.TT.SS where TT is 40/41/42/43 for UTEST/ITEST/STEST/FTEST respectively.
What traceability tags are mandatory?
Include cumulative tags from Layers 1–9: @brd, @prd, @ears, @bdd, @adr, @sys, @req, @spec (add @ctr if CTR exists).
Can I use placeholders for missing upstream docs?
No. Reference only existing documents; use null only if the artifact genuinely does not exist and skip related tests if necessary.
Are there automated checks?
Yes. Use the provided type-specific validation scripts and the combined quality score scripts to run Tier 1 errors, warnings, and info checks.