Loading...
Loading...
Compare original and translation side by side
| Input | Type | Required | Description |
|---|---|---|---|
| artifact_content | string | Yes | Current content of artifact being created |
| artifact_type | string | Yes | Type of artifact (BRD, PRD, SPEC, etc.) |
| artifact_id | string | No | Document ID if assigned (e.g., PRD-00) |
| check_level | string | No | Level of checks: "quick", "standard" (default), "strict" |
| 输入参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| artifact_content | string | 是 | 当前正在创建的制品内容 |
| artifact_type | string | 是 | 制品类型(BRD、PRD、SPEC等) |
| artifact_id | string | 否 | 已分配的文档ID(例如:PRD-00) |
| check_level | string | 否 | 检查级别:"quick"(快速)、"standard"(标准,默认)、"strict"(严格) |
| Layer | Artifact | Required Sections | Min Tags | Special Requirements |
|---|---|---|---|---|
| 1 | BRD | Document Control, Purpose, Stakeholders, Objectives, Requirements, Traceability | 0 | None |
| 2 | PRD | Document Control, Problem, Goals, Non-Goals, User Needs, Features, KPIs, Traceability | 1 (@brd) | KPIs must be quantitative |
| 3 | EARS | Document Control, Requirements (WHEN-THE-SHALL), Traceability | 2 (@brd, @prd) | EARS syntax validation |
| 4 | BDD | Feature, Scenarios, Tags | 3 (@brd, @prd, @ears) | Gherkin syntax |
| 5 | ADR | Document Control, Context, Decision, Rationale, Consequences, Traceability | 4 (@brd, @prd, @ears, @bdd) | Decision must be explicit |
| 6 | SYS | Document Control, System Requirements, Traceability | 5 | Technical specifications |
| 7 | REQ | Document Control, Requirement, Acceptance Criteria, Traceability | 6 | Atomic requirement |
| 8 | CTR | Document Control, Interfaces, Data Models, Contract Clauses, Traceability | 7 | Dual-file format (md+yaml) |
| 9 | SPEC | id, description, methods, traceability | 7 | YAML format |
| 10 | TSPEC | Document Control, Test Cases, Coverage, Traceability | 8 | UTEST/ITEST/STEST/FTEST types |
| 11 | TASKS | Document Control, Tasks, Dependencies, Traceability | 9 | Actionable TODOs |
| 层级 | 制品 | 必填章节 | 最少标签数 | 特殊要求 |
|---|---|---|---|---|
| 1 | BRD | Document Control, Purpose, Stakeholders, Objectives, Requirements, Traceability | 0 | 无 |
| 2 | PRD | Document Control, Problem, Goals, Non-Goals, User Needs, Features, KPIs, Traceability | 1 (@brd) | KPIs必须可量化 |
| 3 | EARS | Document Control, Requirements (WHEN-THE-SHALL), Traceability | 2 (@brd, @prd) | EARS语法验证 |
| 4 | BDD | Feature, Scenarios, Tags | 3 (@brd, @prd, @ears) | Gherkin语法 |
| 5 | ADR | Document Control, Context, Decision, Rationale, Consequences, Traceability | 4 (@brd, @prd, @ears, @bdd) | 决策必须明确 |
| 6 | SYS | Document Control, System Requirements, Traceability | 5 | 技术规格要求 |
| 7 | REQ | Document Control, Requirement, Acceptance Criteria, Traceability | 6 | 原子化需求 |
| 8 | CTR | Document Control, Interfaces, Data Models, Contract Clauses, Traceability | 7 | 双文件格式(md+yaml) |
| 9 | SPEC | id, description, methods, traceability | 7 | YAML格式 |
| 10 | TSPEC | Document Control, Test Cases, Coverage, Traceability | 8 | UTEST/ITEST/STEST/FTEST类型 |
| 11 | TASKS | Document Control, Tasks, Dependencies, Traceability | 9 | 可执行的TODO项 |
undefinedundefined
**Completion Scoring**:
```yaml
section_completion:
document_control:
present: true
complete: true
score: 100%
problem_statement:
present: true
complete: true
score: 100%
goals:
present: true
complete: partial
score: 60%
issues:
- "Goal G-003 missing success metric"
- "Goals not prioritized (P0, P1, P2)"
kpis:
present: true
complete: false
score: 30%
issues:
- "KPI 'user adoption' lacks quantitative target"
- "No performance metrics defined"
traceability:
present: true
complete: partial
score: 70%
issues:
- "Missing @brd tag (required for Layer 2)"
- "Downstream artifacts section empty"
overall_score: 72%
**完成度评分**:
```yaml
section_completion:
document_control:
present: true
complete: true
score: 100%
problem_statement:
present: true
complete: true
score: 100%
goals:
present: true
complete: partial
score: 60%
issues:
- "目标G-003缺失成功指标"
- "目标未按优先级划分(P0、P1、P2)"
kpis:
present: true
complete: false
score: 30%
issues:
- "KPI '用户采用率'缺乏可量化目标"
- "未定义性能指标"
traceability:
present: true
complete: partial
score: 70%
issues:
- "缺失@brd标签(层级2必填)"
- "下游制品章节为空"
overall_score: 72%| ID | Name | Description | Severity | Detection |
|---|---|---|---|---|
| AP-001 | Missing Document Control | No version/status metadata | Error | Section not found |
| AP-002 | Placeholder Text | | Warning | Regex match |
| AP-003 | Vague Acceptance Criteria | No measurable outcomes | Warning | Missing numbers/percentages |
| AP-004 | Missing Traceability Tags | Required upstream tags absent | Error | Tag count check |
| AP-005 | Broken Internal Links | | Error | Link validation |
| AP-006 | ID Format Violation | Non-standard document ID | Error | Regex match |
| AP-007 | Empty Required Section | Section header present but no content | Warning | Content length check |
| AP-008 | Orphan Artifact | No upstream references | Warning | Traceability check |
| AP-009 | Missing Anchor | Document lacks primary anchor ID | Warning | Anchor detection |
| AP-010 | Duplicate ID Reference | Same ID referenced multiple times | Info | Duplicate check |
| AP-011 | Section Count Mismatch | | Error | SEC-E001 validation |
| AP-012 | Cross-Reference Title Mismatch | Link text differs from target section heading | Error | XREF-E001/E002 validation |
| AP-013 | Mixed ID Notation | Document uses both hyphen (TYPE-NN) and dot (TYPE.NN) formats | Error | IDPAT-E003 validation |
| AP-014 | Diagram-Text Inconsistency | Mermaid diagram components don't match prose claims | Warning | DIAG-E001/W001 validation |
| AP-015 | Undefined Acronym | Acronym used without first-use definition | Error | TERM-E002 validation |
| AP-016 | Count Mismatch | Stated count (e.g., "18 requirements") differs from itemized total | Error | COUNT-E001 validation |
| AP-017 | Forward Reference to Non-Existent Document | Upstream doc references specific downstream IDs (e.g., PRD→ADR-01) | Error | FWDREF-E001 validation |
anti_patterns_detected:
- id: AP-004
name: Missing Traceability Tags
severity: error
location: "Section 7: Traceability"
details: "PRD requires @brd tag (Layer 2 cumulative requirement)"
suggestion: "Add '@brd: BRD.NN.EE.SS' to Traceability section"
- id: AP-003
name: Vague Acceptance Criteria
severity: warning
location: "Section 6: KPIs"
details: "KPI 'improve user experience' has no measurable target"
suggestion: "Add quantitative metric: 'User satisfaction ≥4.0/5.0'"
- id: AP-002
name: Placeholder Text
severity: warning
location: "Section 4: User Needs, line 45"
details: "Found placeholder '[TBD]'"
suggestion: "Replace with actual user need or remove section"| ID | Name | 描述 | 严重程度 | 检测方式 |
|---|---|---|---|---|
| AP-001 | Missing Document Control | 缺失版本/状态元数据 | 错误 | 未找到对应章节 |
| AP-002 | Placeholder Text | 内容中包含 | 警告 | 正则匹配 |
| AP-003 | Vague Acceptance Criteria | 无可衡量的结果 | 警告 | 缺失数字/百分比 |
| AP-004 | Missing Traceability Tags | 缺失必填的上游标签 | 错误 | 标签数量检查 |
| AP-005 | Broken Internal Links | | 错误 | 链接验证 |
| AP-006 | ID Format Violation | 非标准文档ID | 错误 | 正则匹配 |
| AP-007 | Empty Required Section | 章节标题存在但无内容 | 警告 | 内容长度检查 |
| AP-008 | Orphan Artifact | 无上游引用 | 警告 | 可追溯性检查 |
| AP-009 | Missing Anchor | 文档缺失主锚点ID | 警告 | 锚点检测 |
| AP-010 | Duplicate ID Reference | 同一ID被多次引用 | 信息 | 重复项检查 |
| AP-011 | Section Count Mismatch | | 错误 | SEC-E001验证 |
| AP-012 | Cross-Reference Title Mismatch | 链接文本与目标章节标题不符 | 错误 | XREF-E001/E002验证 |
| AP-013 | Mixed ID Notation | 文档同时使用连字符(TYPE-NN)和点(TYPE.NN)格式 | 错误 | IDPAT-E003验证 |
| AP-014 | Diagram-Text Inconsistency | Mermaid图组件与文字描述不符 | 警告 | DIAG-E001/W001验证 |
| AP-015 | Undefined Acronym | 首字母缩写词未在首次使用时定义 | 错误 | TERM-E002验证 |
| AP-016 | Count Mismatch | 声明的数量(例如:"18项需求")与分项统计总数不符 | 错误 | COUNT-E001验证 |
| AP-017 | Forward Reference to Non-Existent Document | 上游文档引用了不存在的下游特定ID(例如:PRD→ADR-01) | 错误 | FWDREF-E001验证 |
anti_patterns_detected:
- id: AP-004
name: Missing Traceability Tags
severity: error
location: "第7章:可追溯性"
details: "PRD需要@brd标签(层级2累积要求)"
suggestion: "在可追溯性章节添加'@brd: BRD.NN.EE.SS'"
- id: AP-003
name: Vague Acceptance Criteria
severity: warning
location: "第6章:KPIs"
details: "KPI '提升用户体验'无可衡量目标"
suggestion: "添加量化指标:'用户满意度≥4.0/5.0'"
- id: AP-002
name: Placeholder Text
severity: warning
location: "第4章:用户需求,第45行"
details: "发现占位符'[TBD]'"
suggestion: "替换为实际用户需求或删除该章节"cumulative_tag_requirements:
BRD:
layer: 1
required_tags: []
tag_count: 0
PRD:
layer: 2
required_tags: [@brd]
tag_count: 1
EARS:
layer: 3
required_tags: [@brd, @prd]
tag_count: 2
BDD:
layer: 4
required_tags: [@brd, @prd, @ears]
tag_count: 3
ADR:
layer: 5
required_tags: [@brd, @prd, @ears, @bdd]
tag_count: 4
SYS:
layer: 6
required_tags: [@brd, @prd, @ears, @bdd, @adr]
tag_count: 5
REQ:
layer: 7
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys]
tag_count: 6
CTR:
layer: 8
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req]
tag_count: 7
SPEC:
layer: 9
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req]
optional_tags: [@ctr]
tag_count: 7
TSPEC:
layer: 10
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req, @spec]
optional_tags: [@ctr]
tag_count: 8
TASKS:
layer: 11
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req, @spec, @tspec]
optional_tags: [@ctr]
tag_count: 9tag_validation:
artifact_type: PRD
layer: 2
required_tags: ["@brd"]
found_tags: []
missing_tags: ["@brd"]
status: fail
message: "Layer 2 artifact requires @brd tag"
fix_suggestion: |
Add to Traceability section:
```
@brd: BRD.001.003
```cumulative_tag_requirements:
BRD:
layer: 1
required_tags: []
tag_count: 0
PRD:
layer: 2
required_tags: [@brd]
tag_count: 1
EARS:
layer: 3
required_tags: [@brd, @prd]
tag_count: 2
BDD:
layer: 4
required_tags: [@brd, @prd, @ears]
tag_count: 3
ADR:
layer: 5
required_tags: [@brd, @prd, @ears, @bdd]
tag_count: 4
SYS:
layer: 6
required_tags: [@brd, @prd, @ears, @bdd, @adr]
tag_count: 5
REQ:
layer: 7
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys]
tag_count: 6
CTR:
layer: 8
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req]
tag_count: 7
SPEC:
layer: 9
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req]
optional_tags: [@ctr]
tag_count: 7
TSPEC:
layer: 10
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req, @spec]
optional_tags: [@ctr]
tag_count: 8
TASKS:
layer: 11
required_tags: [@brd, @prd, @ears, @bdd, @adr, @sys, @req, @spec, @tspec]
optional_tags: [@ctr]
tag_count: 9tag_validation:
artifact_type: PRD
layer: 2
required_tags: ["@brd"]
found_tags: []
missing_tags: ["@brd"]
status: fail
message: "层级2制品需要@brd标签"
fix_suggestion: |
在可追溯性章节添加:
```
@brd: BRD.001.003
```doc-namingdoc-namingnaming_conventions:
# Document ID format
document_id_format: "{TYPE}-{NN}" # e.g., PRD-01
filename_format: "{TYPE}-{NN}_{slug}.md" # e.g., PRD-01_authentication.md
# Element ID format (unified)
element_id_format: "{TYPE}.{NN}.{TT}.{SS}" # e.g., PRD.01.09.01
# Threshold tag format
threshold_format: "@threshold: {TYPE}.{NN}.{key}" # e.g., @threshold: PRD.01.perf.auth.p99
slug_rules:
- lowercase
- underscores for spaces
- no special characters
- descriptive of contentnaming_validation:
document_id: PRD-01
id_format_valid: true
filename: "PRD-01_authentication.md"
filename_valid: true
element_ids:
total: 24
valid: 22
invalid: 2
issues:
- "PRD.01.25.01 - code 25 not valid for PRD"
- "US-001 - deprecated pattern, use PRD.01.09.SS"
threshold_tags:
total: 8
valid: 7
invalid: 1
issues:
- "perf.auth.p99 - missing TYPE.NN prefix"
legacy_patterns_detected: 1doc-namingdoc-namingdoc-namingnaming_conventions:
# 文档ID格式
document_id_format: "{TYPE}-{NN}" # e.g., PRD-01
filename_format: "{TYPE}-{NN}_{slug}.md" # e.g., PRD-01_authentication.md
# 元素ID格式(统一)
element_id_format: "{TYPE}.{NN}.{TT}.{SS}" # e.g., PRD.01.09.01
# 阈值标签格式
threshold_format: "@threshold: {TYPE}.{NN}.{key}" # e.g., @threshold: PRD.01.perf.auth.p99
slug_rules:
- 小写字母
- 用下划线代替空格
- 无特殊字符
- 内容描述清晰naming_validation:
document_id: PRD-01
id_format_valid: true
filename: "PRD-01_authentication.md"
filename_valid: true
element_ids:
total: 24
valid: 22
invalid: 2
issues:
- "PRD.01.25.01 - 代码25对PRD无效"
- "US-001 - 已弃用格式,请使用PRD.01.09.SS"
threshold_tags:
total: 8
valid: 7
invalid: 1
issues:
- "perf.auth.p99 - 缺失TYPE.NN前缀"
legacy_patterns_detected: 1doc-namingquality_report:
artifact_id: PRD-00
artifact_type: PRD
check_timestamp: 2025-11-29T14:30:00Z
check_level: standard
overall_status: warning
quality_score: 72%
summary:
errors: 1
warnings: 3
info: 1
passed_checks: 12
section_completion:
complete: 5
partial: 2
missing: 0
score: 85%
anti_patterns:
- severity: error
count: 1
details: "Missing @brd tag"
- severity: warning
count: 3
details: "Vague KPIs, placeholder text, incomplete goals"
tag_compliance:
status: fail
required: 1
found: 0
missing: ["@brd"]
naming_compliance:
status: pass
all_checks_passed: true
recommendations:
high_priority:
- "Add @brd tag to Traceability section (required for Layer 2)"
medium_priority:
- "Add quantitative targets to KPIs"
- "Remove [TBD] placeholder from User Needs section"
- "Prioritize goals with P0, P1, P2 labels"
low_priority:
- "Consider adding more downstream artifact references"
next_steps:
- "Fix error-level issues before submission"
- "Address warnings for quality improvement"
- "Run trace-check after completion for full validation"quality_report:
artifact_id: PRD-00
artifact_type: PRD
check_timestamp: 2025-11-29T14:30:00Z
check_level: standard
overall_status: warning
quality_score: 72%
summary:
errors: 1
warnings: 3
info: 1
passed_checks: 12
section_completion:
complete: 5
partial: 2
missing: 0
score: 85%
anti_patterns:
- severity: error
count: 1
details: "缺失@brd标签"
- severity: warning
count: 3
details: "模糊的KPIs、占位符文本、未完成的目标"
tag_compliance:
status: fail
required: 1
found: 0
missing: ["@brd"]
naming_compliance:
status: pass
all_checks_passed: true
recommendations:
high_priority:
- "在可追溯性章节添加@brd标签(层级2必填)"
medium_priority:
- "为KPIs添加量化目标"
- "删除用户需求章节中的[TBD]占位符"
- "用P0、P1、P2标签对目标划分优先级"
low_priority:
- "考虑添加更多下游制品引用"
next_steps:
- "提交前修复错误级问题"
- "处理警告以提升质量"
- "完成后运行trace-check进行完整验证"quality_status: in_progress
current_score: 65%
blocking_issues:
- "Missing Document Control section at top"
- "No traceability section found"
improvement_suggestions:
- "Add Document Control table before Section 1"
- "Create Section 7: Traceability with @brd tag"
- "Add measurable KPIs (currently vague)"
completion_estimate: "3 sections need attention"quality_status: in_progress
current_score: 65%
blocking_issues:
- "文档顶部缺失Document Control章节"
- "未找到可追溯性章节"
improvement_suggestions:
- "在第1章前添加Document Control表格"
- "创建第7章:可追溯性并添加@brd标签"
- "添加可衡量的KPIs(当前描述模糊)"
completion_estimate: "有3个章节需要处理"submission_readiness: not_ready
blocking_issues:
- severity: error
issue: "Missing @req tag (required for Layer 10)"
- severity: error
issue: "YAML syntax error at line 45"
warnings:
- "verification section references non-existent BDD-015"
- "id field uses camelCase instead of snake_case"
recommendation: "Fix 2 errors before submission"submission_readiness: not_ready
blocking_issues:
- severity: error
issue: "缺失@req标签(层级10必填)"
- severity: error
issue: "第45行存在YAML语法错误"
warnings:
- "验证章节引用了不存在的BDD-015"
- "id字段使用了驼峰命名,应使用蛇形命名"
recommendation: "提交前修复2个错误"artifact_type: REQ
layer: 7
tag_compliance: pass
required_tags:
- "@brd: BRD.01.01.01 ✓"
- "@prd: PRD.01.07.01 ✓"
- "@ears: EARS.01.24.01 ✓"
- "@bdd: BDD.01.13.01 ✓"
- "@adr: ADR-02 ✓"
- "@sys: SYS.01.25.01 ✓"
tag_count: "6/6 required tags present"
status: "Ready for downstream artifacts"artifact_type: REQ
layer: 7
tag_compliance: pass
required_tags:
- "@brd: BRD.01.01.01 ✓"
- "@prd: PRD.01.07.01 ✓"
- "@ears: EARS.01.24.01 ✓"
- "@bdd: BDD.01.13.01 ✓"
- "@adr: ADR-02 ✓"
- "@sys: SYS.01.25.01 ✓"
tag_count: "6/6个必填标签已存在"
status: "可用于下游制品"| Integration | Description |
|---|---|
| Element ID format, threshold tags, legacy pattern detection |
| Invoked during Phase 3 (artifact generation) for real-time guidance |
| Structural validation (use quality-advisor for creation, validator for post-creation) |
| Content review (use quality-advisor for creation, reviewer for final QA) |
| Shares validation logic for traceability checks |
| Uses project context for reference validation |
| 集成项 | 描述 |
|---|---|
| 元素ID格式、阈值标签、遗留模式检测 |
| 在第3阶段(制品生成)调用,提供实时指导 |
| 结构验证(创建阶段使用quality-advisor,创建完成后使用validator) |
| 内容审核(创建阶段使用quality-advisor,最终QA使用reviewer) |
| 共享可追溯性检查的验证逻辑 |
| 使用项目上下文进行引用验证 |
| Metric | Target |
|---|---|
| Quick check latency | <100ms |
| Standard check latency | <500ms |
| Strict check latency | <1s |
| False positive rate | <5% |
| 指标 | 目标值 |
|---|---|
| 快速检查延迟 | <100ms |
| 标准检查延迟 | <500ms |
| 严格检查延迟 | <1s |
| 误报率 | <5% |
@prd: PRD.000.003
@adr: ADR-000@prd: PRD.000.003
@adr: ADR-000| Source | Type | Reference |
|---|---|---|
| PRD-00 | Product Requirements | PRD-00 |
| ADR-000 | Architecture Decision | ADR-000 |
| 来源 | 类型 | 参考链接 |
|---|---|---|
| PRD-00 | 产品需求 | PRD-00 |
| ADR-000 | 架构决策 | ADR-000 |
| Artifact | Type | Reference |
|---|---|---|
| doc-* skills | Skill Consumer | Quality checks during creation |
| 制品 | 类型 | 参考链接 |
|---|---|---|
| doc-* skills | Skill消费者 | 创建过程中的质量检查 |
| Version | Date | Changes |
|---|---|---|
| 1.1.0 | 2026-02-08 | Updated layer assignments per LAYER_REGISTRY v1.6; Added CTR (L8), TSPEC (L10); Fixed SPEC to L9, TASKS to L11; Integrated doc-naming skill for element ID validation |
| 1.0.0 | 2025-11-29 | Initial release |
| 版本 | 日期 | 变更内容 |
|---|---|---|
| 1.1.0 | 2026-02-08 | 根据LAYER_REGISTRY v1.6更新层级分配;新增CTR(层级8)、TSPEC(层级10);修正SPEC为层级9、TASKS为层级11;集成doc-naming skill用于元素ID验证 |
| 1.0.0 | 2025-11-29 | 初始版本 |