SuperAPI AI 工具集

doc-itest

测试与质量

查看项目

更新于 10-16 06:54

技能介绍

用途

doc-itest 用于创建集成测试规范(Integration Test Specifications,简称 ITEST),作为 Layer 10 子类型工件,服务于组件交互、API 契约合规、序列流程验证以及集成级数据流检查。

该技能属于 vladm3105/aidoc-flow-framework 项目,子类型代码为 41(TSPEC.NN.41.SS),层级为 Layer 10。

主要能力

  • 生成符合 ITEST 契约的文档,包含六个必需部分:文档控制(Document Control)、测试范围(Test Scope)、测试用例索引(Test Case Index)、测试用例详情(Test Case Details)、CTR 覆盖矩阵(CTR Coverage Matrix)、可追溯性(Traceability)。
  • 支持 API 契约检查(@ctr)与集成需求检查(@sys)作为主要验证目标。
  • 支持跨组件的序列流与数据流验证。
  • 对复杂交互要求包含序列图。
  • 提供配套的验证命令,用于子类型校验、层级范围校验、质量评分校验、跨文档校验以及累积标签校验。

使用方式

在创建或编辑 ITEST 工件时使用 doc-itest。编写前需阅读以下规范参考文件:

  • ai_dev_ssd_flow/10_TSPEC/ITEST/ITEST-MVP-TEMPLATE.md
  • ai_dev_ssd_flow/10_TSPEC/ITEST/ITEST-MVP-TEMPLATE.yaml
  • ai_dev_ssd_flow/10_TSPEC/ITEST/ITEST_MVP_SCHEMA.yaml

文档需放置在嵌套文件夹结构中:

docs/10_TSPEC/ITEST/ITEST-NN_{slug}/ITEST-NN_{slug}.md

必需标签包括累积 Layer-10 标签:@brd、@prd、@ears、@bdd、@adr、@sys、@req、@spec(若存在则加 @ctr);类型特定必需标签为 @ctr、@sys。

验证命令如下:

# ITEST subtype validation
python ai_dev_ssd_flow/10_TSPEC/scripts/validate_itest.py docs/10_TSPEC/ITEST/

# Layer-wide TSPEC validation
bash ai_dev_ssd_flow/10_TSPEC/scripts/validate_all_tspec.sh docs/10_TSPEC/

# Quality score validation
bash ai_dev_ssd_flow/10_TSPEC/scripts/validate_tspec_quality_score.sh docs/10_TSPEC/

# Cross-document validation
python ai_dev_ssd_flow/scripts/validate_cross_document.py --document docs/10_TSPEC/ITEST/ITEST-NN_slug/ITEST-NN_slug.md --auto-fix

# Cumulative tag validation
python ai_dev_ssd_flow/scripts/validate_tags_against_docs.py --artifact ITEST-NN --expected-layers brd,prd,ears,bdd,adr,sys,req,spec --strict

适用场景

  • 创建或编辑仅涉及 ITEST 的工件。
  • API 契约检查(@ctr)与集成需求检查(@sys)为主要目标。
  • 核心目标是跨组件的序列流或数据流验证。

若需要多子类型编排(UTEST/ITEST/STEST/FTEST/PTEST/SECTEST),或主要进行跨子类型规范化或批量 TSPEC 工作,则应改用 doc-tspec。

限制与质量门槛

  • TASKS-Ready 阈值为 >=90%。
  • CTR 覆盖目标为模板对齐(基线 >=85%)。
  • 输出质量门槛要求:无模式或结构阻塞;所有必需 ITEST 部分齐全;@ctr 与 @sys 映射明确;复杂交互处体现序列或数据流检查;可追溯性包含必需累积标签;报告引用在适用时使用版本化命名。

相关技能

doc-itest-autopilot、doc-itest-validator、doc-itest-reviewer、doc-itest-fixer、doc-itest-audit、doc-tspec(多子类型回退路径)。

版本历史

版本 1.0,日期 2026-02-27,初始 ITEST 编写技能,对齐规范 ITEST MVP 模板、规则与模式,包含 TSPEC 共存路由与规范验证命令集。