DonggangChen

specification_validation

2
2
# Install this skill:
npx skills add DonggangChen/antigravity-agentic-skills --skill "specification_validation"

Install specific skill from multi-skill repository

# Description

Spec validation, implementation comparison and completeness check guide.

# SKILL.md


name: specification_validation
router_kit: DevOpsKit
description: Spec validation, implementation comparison and completeness check guide.
metadata:
skillport:
category: quality
tags: [architecture, automation, best practices, clean code, coding, collaboration, compliance, debugging, design patterns, development, documentation, efficiency, git, optimization, productivity, programming, project management, quality assurance, refactoring, software engineering, specification validation, standards, testing, utilities, version control, workflow] - quality


βœ… Specification Validation

Spec validation and completeness check guide.


πŸ“‹ Table of Contents

  1. Validation Framework
  2. Completeness Check
  3. Consistency Check
  4. Implementation Comparison

1. Validation Framework

Validation Dimensions

Dimension Description Check
Completeness Are all requirements defined? No missing fields
Consistency Are there conflicting definitions? Consistency
Correctness Are requirements correct? Domain correctness
Clarity Is there ambiguity? Clear definitions
Testability Can it be tested? Measurable criteria

Validation Checklist

- [ ] Are all use cases defined?
- [ ] Are error cases specified?
- [ ] Are edge cases considered?
- [ ] Is acceptance criteria clear?
- [ ] Are dependencies defined?
- [ ] Are there non-functional requirements?

2. Completeness Check

Required Sections

## Spec Completeness Template

### 1. Overview
- [ ] Problem statement
- [ ] Goals ve objectives
- [ ] Success metrics

### 2. Functional Requirements
- [ ] User stories / use cases
- [ ] Input/output specifications
- [ ] Business rules

### 3. Non-Functional Requirements
- [ ] Performance requirements
- [ ] Security requirements
- [ ] Scalability requirements

### 4. Technical Details
- [ ] Architecture decisions
- [ ] API contracts
- [ ] Data models

### 5. Edge Cases & Errors
- [ ] Error handling
- [ ] Fallback behavior
- [ ] Validation rules

Gap Analysis

Missing: [Field Name]
Impact: High / Medium / Low
Recommendation: [Recommended Action]

3. Consistency Check

Cross-Reference Matrix

Requirement UI Spec API Spec DB Schema Test Spec
User Login βœ… βœ… βœ… ⚠️
Password Reset βœ… ❌ ⚠️ ❌

Conflict Detection

## Conflict Report

**Conflict ID:** C-001
**Location:** API Spec vs UI Spec
**Description:** 
- API: `email` field max 100 chars
- UI: `email` input allows 255 chars

**Resolution:** Align to 100 chars (API standard)

4. Implementation Comparison

Spec vs Code Comparison

# Endpoints defined in Spec
grep -r "POST\|GET\|PUT\|DELETE" spec.md

# Endpoints present in Code
grep -r "@Post\|@Get\|@Put\|@Delete" src/

# Compare
diff spec_endpoints.txt code_endpoints.txt

Implementation Status

Feature Spec Implemented Tested Notes
Login βœ… βœ… βœ…
Signup βœ… βœ… ⚠️ E2E test missing
Password Reset βœ… ❌ ❌ In Backlog

Specification Validation v1.1 - Enhanced

πŸ”„ Workflow

Source: IREB Requirements Engineering & IEEE 29148 Standard

Phase 1: Structural Integrity (Completeness)

  • [ ] Template Compliance: Does spec document comply with defined template (e.g. Volere, IEEE 830)?
  • [ ] Missing Sections: Are mandatory sections (Security, Performance, Error Handling) skipped?
  • [ ] TBD Check: Are there any "TBD" (To Be Defined) or "???" left in the document? Search and clean.

Phase 2: Content Quality (Clarity & Consistency)

  • [ ] Ambiguity Audit: Replace vague expressions like "Fast", "Beautiful", "As much as possible" with measurable values like "Under 200ms", "Material Design", "99% uptime".
  • [ ] Term Consistency: Are different terms used for the same concept? (e.g. User vs Customer). Create Glossary.
  • [ ] Conflict Check: Are there contradictions between business rules? (e.g. "Everyone can see" vs "Only admin can see").

Phase 3: Verify & Validate

  • [ ] Traceability: Does every requirement have a source (Business Goal) and a test (Test Case)?
  • [ ] Stakeholder Approval: Did all relevant stakeholders (Dev, QA, Product) read and approve the document?
  • [ ] Feasibility: Did technical team give "This is doable" approval?

Checkpoints

Phase Verification
1 Is every requirement atomic (expressing a single thing)?
2 Is document under version control? (Is there a Change Log?).
3 Are requirement priorities (MoSCoW) determined?

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.