Files
2026-02-16 13:58:02 +09:00

2.2 KiB

name: ipa-validator description: Core IPA validation engine — checks documentation consistency, ID cross-references, and traceability chain across SRD, UI_SPEC, API_SPEC, and DB_DESIGN. Activated automatically by ipa-validate, ipa-all, and ipa-init. Trigger phrases: "validate ipa documentation", "check id consistency", "ipa traceability check".

Overview

Core validation logic for IPA documentation. Validates ID consistency, cross-reference integrity, status tracking, and traceability chain completeness. Used by ipa-validate, ipa-all, and ipa-init internally.

When to Use

  • Invoked automatically by ipa-validate, ipa-all, ipa-init
  • When explicitly checking IPA doc validity
  • After generating or editing any IPA document

Don't Use When

  • IPA docs do not yet exist
  • Only a quick command reference is needed (use ipa-help)

Required Docs

  • docs/SRD.md — System Requirement Definition
  • docs/UI_SPEC.md — UX Specification (Basic Design)
  • docs/API_SPEC.md — Interface Specification (Detail Design)
  • docs/DB_DESIGN.md — Database Design (Detail Design)

Validation Rules

  1. Docs Exist — All four required IPA docs present
  2. ID Extraction — Parse FR-xx, S-xx, E-xx from SRD tables
  3. Cross-Reference Validation — Every ID referenced in other docs must exist in SRD
  4. Status Tracking — API_SPEC Endpoint Matrix must have valid status values
  5. Traceability Chain — Each FR-xx must map to Screen + Endpoint + Table
  6. Orphan Detection — IDs in detail docs not referenced in SRD indicate scope creep

Workflow

  1. Check docs exist — stop and report if any missing
  2. Extract IDs — parse all ID types from SRD
  3. Validate refs — check cross-references in UI_SPEC, API_SPEC, DB_DESIGN
  4. Check status — verify Endpoint Matrix status column
  5. Generate report — output validation results with counts, gaps, and recommendations

Output

Validation report with:

  • ID consistency check result
  • Traceability chain check result
  • Cross-reference validation result
  • Status tracking validation result
  • Recommendations for fixing gaps

Usage

# Run validation via ipa-validate
ipa-validate

# Or invoke directly
"Validate IPA docs"
"Check IPA traceability"