Back to Details

quality-advisor

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

quality-advisor

quality-advisor

Purpose

用途

Provide proactive quality guidance during artifact creation by monitoring section completion, detecting anti-patterns, and validating compliance with SDD standards.
Problem Solved: Documentation quality varies based on user expertise. Issues are typically found after artifact creation during validation, causing rework.
Solution: Real-time quality monitoring that identifies issues during creation, suggests improvements, and validates compliance before the artifact is complete.
通过监控章节完成情况、检测反模式以及验证是否符合SDD标准，在文档制品创建过程中提供主动式质量指导。
解决的问题：文档质量因用户专业水平而异。问题通常在制品创建完成后的验证阶段才被发现，导致返工。
解决方案：实时质量监控，在创建过程中识别问题、提出改进建议，并在制品完成前验证合规性。

When to Use This Skill

何时使用该Skill

Use quality-advisor when:
  • Creating a new documentation artifact
  • Reviewing an artifact before submission
  • Want to check compliance with template requirements
  • Need guidance on common mistakes to avoid
  • Validating cumulative tagging compliance
Do NOT use when:
  • Full traceability validation needed (use trace-check)
  • Validating entire project (use doc-validator)
  • Non-SDD documentation
使用quality-advisor的场景：
  • 创建新的文档制品时
  • 提交前审核制品时
  • 想要检查是否符合模板要求时
  • 需要指导以避免常见错误时
  • 验证累积标签合规性时
请勿使用的场景：
  • 需要完整可追溯性验证时（使用trace-check）
  • 验证整个项目时（使用doc-validator）
  • 非SDD类文档时

Skill Inputs

Skill输入参数

InputTypeRequiredDescription
artifact_contentstringYesCurrent content of artifact being created
artifact_typestringYesType of artifact (BRD, PRD, SPEC, etc.)
artifact_idstringNoDocument ID if assigned (e.g., PRD-00)
check_levelstringNoLevel of checks: "quick", "standard" (default), "strict"
输入参数类型是否必填描述
artifact_contentstring是当前正在创建的制品内容
artifact_typestring是制品类型（BRD、PRD、SPEC等）
artifact_idstring否已分配的文档ID（例如：PRD-00）
check_levelstring否检查级别："quick"（快速）、"standard"（标准，默认）、"strict"（严格）

Skill Workflow

Skill工作流程

Step 1: Identify Template Requirements

步骤1：识别模板要求

Load requirements for the specified artifact type:
Template Requirements by Type (per LAYER_REGISTRY v1.6):
LayerArtifactRequired SectionsMin TagsSpecial Requirements
1BRDDocument Control, Purpose, Stakeholders, Objectives, Requirements, Traceability0None
2PRDDocument Control, Problem, Goals, Non-Goals, User Needs, Features, KPIs, Traceability1 (@brd)KPIs must be quantitative
3EARSDocument Control, Requirements (WHEN-THE-SHALL), Traceability2 (@brd, @prd)EARS syntax validation
4BDDFeature, Scenarios, Tags3 (@brd, @prd, @ears)Gherkin syntax
5ADRDocument Control, Context, Decision, Rationale, Consequences, Traceability4 (@brd, @prd, @ears, @bdd)Decision must be explicit
6SYSDocument Control, System Requirements, Traceability5Technical specifications
7REQDocument Control, Requirement, Acceptance Criteria, Traceability6Atomic requirement
8CTRDocument Control, Interfaces, Data Models, Contract Clauses, Traceability7Dual-file format (md+yaml)
9SPECid, description, methods, traceability7YAML format
10TSPECDocument Control, Test Cases, Coverage, Traceability8UTEST/ITEST/STEST/FTEST types
11TASKSDocument Control, Tasks, Dependencies, Traceability9Actionable TODOs
Note: Layers 12-14 (CODE, TESTS, VALIDATION) are execution layers, not documentation artifacts.
加载指定制品类型的要求：
按类型划分的模板要求（基于LAYER_REGISTRY v1.6）：
层级制品必填章节最少标签数特殊要求
1BRDDocument Control, Purpose, Stakeholders, Objectives, Requirements, Traceability0无
2PRDDocument Control, Problem, Goals, Non-Goals, User Needs, Features, KPIs, Traceability1 (@brd)KPIs必须可量化
3EARSDocument Control, Requirements (WHEN-THE-SHALL), Traceability2 (@brd, @prd)EARS语法验证
4BDDFeature, Scenarios, Tags3 (@brd, @prd, @ears)Gherkin语法
5ADRDocument Control, Context, Decision, Rationale, Consequences, Traceability4 (@brd, @prd, @ears, @bdd)决策必须明确
6SYSDocument Control, System Requirements, Traceability5技术规格要求
7REQDocument Control, Requirement, Acceptance Criteria, Traceability6原子化需求
8CTRDocument Control, Interfaces, Data Models, Contract Clauses, Traceability7双文件格式（md+yaml）
9SPECid, description, methods, traceability7YAML格式
10TSPECDocument Control, Test Cases, Coverage, Traceability8UTEST/ITEST/STEST/FTEST类型
11TASKSDocument Control, Tasks, Dependencies, Traceability9可执行的TODO项
注意：层级12-14（CODE、TESTS、VALIDATION）为执行层级，不属于文档制品。

Step 2: Check Section Completion

步骤2：检查章节完成情况

Verify all required sections are present and populated:
Section Detection:
python
undefined
验证所有必填章节是否存在且已填充内容：
章节检测：
python
undefined

Section patterns by type

Section patterns by type

SECTION_PATTERNS = { "document_control": r"## Document Control", "problem_statement": r"## \d+. Problem", "goals": r"## \d+. Goals", "non_goals": r"## \d+. Non-Goals", "traceability": r"## \d+. Traceability|## 7. Traceability", "kpis": r"## \d+. KPIs|## KPIs", "acceptance_criteria": r"### Acceptance Criteria|## Acceptance", }

**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%
SECTION_PATTERNS = { "document_control": r"## Document Control", "problem_statement": r"## \d+. Problem", "goals": r"## \d+. Goals", "non_goals": r"## \d+. Non-Goals", "traceability": r"## \d+. Traceability|## 7. Traceability", "kpis": r"## \d+. KPIs|## KPIs", "acceptance_criteria": r"### Acceptance Criteria|## Acceptance", }

**完成度评分**：
```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%

Step 3: Detect Anti-Patterns

步骤3：检测反模式

Identify common documentation mistakes:
Anti-Pattern Catalog:
IDNameDescriptionSeverityDetection
AP-001Missing Document ControlNo version/status metadataErrorSection not found
AP-002Placeholder Text
[TBD]
, 
TODO
, 
XXX
in content		WarningRegex match
AP-003Vague Acceptance CriteriaNo measurable outcomesWarningMissing numbers/percentages
AP-004Missing Traceability TagsRequired upstream tags absentErrorTag count check
AP-005Broken Internal Links
[ID](path)
links with invalid paths		ErrorLink validation
AP-006ID Format ViolationNon-standard document IDErrorRegex match
AP-007Empty Required SectionSection header present but no contentWarningContent length check
AP-008Orphan ArtifactNo upstream referencesWarningTraceability check
AP-009Missing AnchorDocument lacks primary anchor IDWarningAnchor detection
AP-010Duplicate ID ReferenceSame ID referenced multiple timesInfoDuplicate check
AP-011Section Count Mismatch
total_sections
metadata differs from actual section files		ErrorSEC-E001 validation
AP-012Cross-Reference Title MismatchLink text differs from target section headingErrorXREF-E001/E002 validation
AP-013Mixed ID NotationDocument uses both hyphen (TYPE-NN) and dot (TYPE.NN) formatsErrorIDPAT-E003 validation
AP-014Diagram-Text InconsistencyMermaid diagram components don't match prose claimsWarningDIAG-E001/W001 validation
AP-015Undefined AcronymAcronym used without first-use definitionErrorTERM-E002 validation
AP-016Count MismatchStated count (e.g., "18 requirements") differs from itemized totalErrorCOUNT-E001 validation
AP-017Forward Reference to Non-Existent DocumentUpstream doc references specific downstream IDs (e.g., PRD→ADR-01)ErrorFWDREF-E001 validation
Anti-Pattern Detection Output:
yaml
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"
识别常见的文档编写错误：
反模式目录：
IDName描述严重程度检测方式
AP-001Missing Document Control缺失版本/状态元数据错误未找到对应章节
AP-002Placeholder Text内容中包含
[TBD]
、
TODO
、
XXX
警告正则匹配
AP-003Vague Acceptance Criteria无可衡量的结果警告缺失数字/百分比
AP-004Missing Traceability Tags缺失必填的上游标签错误标签数量检查
AP-005Broken Internal Links
[ID](path)
链接路径无效		错误链接验证
AP-006ID Format Violation非标准文档ID错误正则匹配
AP-007Empty Required Section章节标题存在但无内容警告内容长度检查
AP-008Orphan Artifact无上游引用警告可追溯性检查
AP-009Missing Anchor文档缺失主锚点ID警告锚点检测
AP-010Duplicate ID Reference同一ID被多次引用信息重复项检查
AP-011Section Count Mismatch
total_sections
元数据与实际章节文件数量不符		错误SEC-E001验证
AP-012Cross-Reference Title Mismatch链接文本与目标章节标题不符错误XREF-E001/E002验证
AP-013Mixed ID Notation文档同时使用连字符（TYPE-NN）和点（TYPE.NN）格式错误IDPAT-E003验证
AP-014Diagram-Text InconsistencyMermaid图组件与文字描述不符警告DIAG-E001/W001验证
AP-015Undefined Acronym首字母缩写词未在首次使用时定义错误TERM-E002验证
AP-016Count Mismatch声明的数量（例如："18项需求"）与分项统计总数不符错误COUNT-E001验证
AP-017Forward Reference to Non-Existent Document上游文档引用了不存在的下游特定ID（例如：PRD→ADR-01）错误FWDREF-E001验证
反模式检测结果：
yaml
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: "替换为实际用户需求或删除该章节"

Step 4: Validate Cumulative Tagging

步骤4：验证累积标签合规性

Check tag hierarchy compliance:
Tag Hierarchy by Layer (per LAYER_REGISTRY v1.6):
yaml
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: 9
Tag Validation Output:
yaml
tag_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
    ```
检查标签层级合规性：
按层级划分的标签层级（基于LAYER_REGISTRY v1.6）：
yaml
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: 9
标签验证结果：
yaml
tag_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
    ```

Step 5: Check Naming Conventions

步骤5：检查命名规范

Validate document ID, element ID, and filename conventions per 
doc-naming
skill.
Naming Rules (see 
doc-naming
skill for complete standards):
yaml
naming_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 content
Naming Validation Output:
yaml
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 - 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: 1
Reference: See 
doc-naming
skill for complete element type codes and validation rules.
根据
doc-naming
skill验证文档ID、元素ID和文件名规范。
命名规则（完整标准请查看
doc-naming
skill）：
yaml
naming_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:
    - 小写字母
    - 用下划线代替空格
    - 无特殊字符
    - 内容描述清晰
命名验证结果：
yaml
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: 1
参考：完整的元素类型代码和验证规则请查看
doc-naming
skill。

Step 6: Generate Quality Report

步骤6：生成质量报告

Assemble comprehensive quality assessment:
Quality Report Format:
yaml
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: "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"
整合全面的质量评估结果：
质量报告格式：
yaml
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进行完整验证"

Example Usage

使用示例

Example 1: Mid-Creation Check

示例1：创建过程中检查

User Request: "Check quality of my PRD in progress"
Quality Feedback:
yaml
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"
用户请求："检查我正在编写的PRD的质量"
质量反馈：
yaml
quality_status: in_progress
current_score: 65%
blocking_issues:
  - "文档顶部缺失Document Control章节"
  - "未找到可追溯性章节"
improvement_suggestions:
  - "在第1章前添加Document Control表格"
  - "创建第7章：可追溯性并添加@brd标签"
  - "添加可衡量的KPIs（当前描述模糊）"
completion_estimate: "有3个章节需要处理"

Example 2: Pre-Submission Review

示例2：提交前审核

User Request: "Is this SPEC ready for submission?"
Quality Assessment:
yaml
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"
用户请求："这份SPEC是否可以提交？"
质量评估：
yaml
submission_readiness: not_ready
blocking_issues:
  - severity: error
    issue: "缺失@req标签（层级10必填）"
  - severity: error
    issue: "第45行存在YAML语法错误"
warnings:
  - "验证章节引用了不存在的BDD-015"
  - "id字段使用了驼峰命名，应使用蛇形命名"
recommendation: "提交前修复2个错误"

Example 3: Quick Compliance Check

示例3：快速合规性检查

User Request: "Quick check on tag compliance for this REQ"
Tag Check Output:
yaml
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"
用户请求："快速检查这份REQ的标签合规性"
标签检查结果：
yaml
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 with Other Skills

与其他Skill的集成

IntegrationDescription
doc-naming
Element ID format, threshold tags, legacy pattern detection
doc-*-autopilot
Invoked during Phase 3 (artifact generation) for real-time guidance
doc-*-validator
Structural validation (use quality-advisor for creation, validator for post-creation)
doc-*-reviewer
Content review (use quality-advisor for creation, reviewer for final QA)
trace-check
Shares validation logic for traceability checks
context-analyzer
Uses project context for reference validation
集成项描述
doc-naming
元素ID格式、阈值标签、遗留模式检测
doc-*-autopilot
在第3阶段（制品生成）调用，提供实时指导
doc-*-validator
结构验证（创建阶段使用quality-advisor，创建完成后使用validator）
doc-*-reviewer
内容审核（创建阶段使用quality-advisor，最终QA使用reviewer）
trace-check
共享可追溯性检查的验证逻辑
context-analyzer
使用项目上下文进行引用验证

Quality Gates

质量门禁

Definition of Done

完成定义

  • All required sections identified
  • Section completion scored
  • Anti-patterns detected and reported
  • Cumulative tagging validated
  • Naming conventions checked
  • Quality report generated
  • Actionable recommendations provided
  • 已识别所有必填章节
  • 已完成章节完成度评分
  • 已检测并报告反模式
  • 已验证累积标签合规性
  • 已检查命名规范
  • 已生成质量报告
  • 已提供可执行的建议

Performance Targets

性能指标

MetricTarget
Quick check latency<100ms
Standard check latency<500ms
Strict check latency<1s
False positive rate<5%
指标目标值
快速检查延迟<100ms
标准检查延迟<500ms
严格检查延迟<1s
误报率<5%

Traceability

可追溯性

Required Tags:
markdown
@prd: PRD.000.003
@adr: ADR-000
必填标签：
markdown
@prd: PRD.000.003
@adr: ADR-000

Upstream Sources

上游来源

SourceTypeReference
PRD-00Product RequirementsPRD-00
ADR-000Architecture DecisionADR-000
来源类型参考链接
PRD-00产品需求PRD-00
ADR-000架构决策ADR-000

Downstream Artifacts

下游制品

ArtifactTypeReference
doc-* skillsSkill ConsumerQuality checks during creation
制品类型参考链接
doc-* skillsSkill消费者创建过程中的质量检查

Version History

版本历史

VersionDateChanges
1.1.02026-02-08Updated 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.02025-11-29Initial release
Status: Active Author: AI Dev Flow Framework Team
版本日期变更内容
1.1.02026-02-08根据LAYER_REGISTRY v1.6更新层级分配；新增CTR（层级8）、TSPEC（层级10）；修正SPEC为层级9、TASKS为层级11；集成doc-naming skill用于元素ID验证
1.0.02025-11-29初始版本
状态：活跃 作者：AI Dev Flow框架团队