mcpField
R
requirement-workflow

requirement-workflow

github.com/learnwyDevelopment558 installsUpdated 21w ago
Repository

About requirement-workflow

requirement-workflow is a Spec-Driven Development skill that guides coding agents from request classification through implementation and verification. It selects a lightweight path for small changes and a staged specification lifecycle for larger or higher-risk work, with checkpoints and traceability.

Key features

  1. 01Classify scope and risk
  2. 02Choose agent or spec mode
  3. 03Create specs, tasks, and checklists
  4. 04Advance through gated workflow stages
  5. 05Trace code to acceptance criteria

Use cases

  1. 01Planning a medium or large feature
  2. 02Handling elevated-risk code changes
  3. 03Managing a small bug fix with a shorter flow

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/learnwy/skills --skill requirement-workflow

After installing, type/requirement-workflowin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

hooks.yaml
agents/
AGENTS.md
architecture-advisor.md
blocker-resolver.md
code-reviewer.md
domain-modeler.md
error-analyzer.md
iron-audit-pm.md
legacy-surgeon.md
mvp-freeze-architect.md
problem-definer.md
refactoring-guide.md
responsibility-modeler.md
risk-auditor.md
spec-by-example.md
story-mapper.md
tdd-coach.md
tech-design-reviewer.md
test-strategist.md
test-strategy-advisor.md
references/
QUICKREF.md
scripts/
advance.cjs
hooks.cjs
init.cjs
status.cjs
scripts/lib/
common.cjs

Details

From the project README

Requirement Workflow (SDD)

Structured development orchestrator based on Spec-Driven Development: define specs first, decompose into tasks, execute with quality gates, verify against acceptance criteria.

Core principle: Spec is the single source of truth. Code follows spec, not the other way around.

Prerequisites

  • Node.js >= 18
  • Writable project directory for workflow state files (.trae/workflow/)

Quick Start

User says anything about building/implementing/fixing →
  1. AI classifies the request (type + size + risk)
  2. AI runs: node init.cjs -r <root> -n <name> -t <type> -s <size> -k <risk>
  3. AI fills spec.md with structured requirements (EARS format)
  4. AI decomposes spec.md into tasks.md
  5. AI implements task by task, advancing stages
  6. AI verifies against checklist.md

Working Modes

This skill supports two modes, selected based on classification:

Agent Mode (Default)

For small/tiny scope or bugfix type: skip spec phase, go straight to implementation.

INIT → IMPLEMENTING → TESTING → DONE
Spec Mode (SDD)

For medium/large scope or elevated/critical risk: full SDD lifecycle.

INIT → DEFINING → PLANNING → DESIGNING → IMPLEMENTING → TESTING → DELIVERING → DONE

Classification Matrix

SignalTypeSizeRisk
"fix bug", "broken", "crash"bugfixtiny-smallnormal
"add feature", "implement", "build"featuresmall-largenormal
"refactor", "clean up", "reorganize"refactorsmall-mediumnormal
"tech debt", "upgrade", "migrate"tech-debtmedium-largeelevated
auth, payments, data, securityanyanyelevated-critical
>15 files estimatedanylargeelevated
Size Heuristics
SizeFilesDurationStages
tiny≤2<30minINIT → IMPLEMENTING → DONE
small3-530min-2hINIT → IMPLEMENTING → TESTING → DONE
medium6-152h-1dFull SDD
large>15>1dFull SDD + all checkpoints

SDD Lifecycle

Stage 1: INIT

Classify request, initialize workflow, create artifact directory.

node init.cjs -r <project_root> -n "<name>" -t <type> -s <size> -k <risk>

Output: workflow.yaml, empty spec.md, tasks.md, checklist.md

Stage 2: DEFINING (Spec Mode only)

Fill spec.md with structured requirements using EARS format:

# Feature Name

## Background
{Why this is needed — problem statement}

## Scope
- In: {what IS included}
- Out: {what is NOT included}

## Acceptance Criteria (EARS format)
- [ ] When <condition>, the system shall <response>
- [ ] While <state>, the system shall <behavior>
- [ ] Where <constraint>, the system shall <limit>

## Constraints
- {Performance, security, compatibility requirements}

## Out of Scope
- {Explicitly deferred items}

Checkpoint: If risk is elevated/critical, pause for user review of spec.md.

Hooks: pre_stage_DEFINING → iron-audit-pm, problem-definer, risk-auditor

Stage 3: PLANNING (Spec Mode only)

Decompose spec.md into tasks.md — every acceptance criterion maps to ≥1 task:

# Tasks

## Phase 1: Foundation
- [ ] Task 1.1: {description} [files: x, y]
- [ ] Task 1.2: {description} [files: z]

## Phase 2: Core Logic
- [ ] Task 2.1: {description} [files: a, b]

## Phase 3: Integration & Polish
- [ ] Task 3.1: {description} [files: c]

## Verification
- [ ] All acceptance criteria pass
- [ ] Lint clean
- [ ] Type check pass

Rule: Each task must be atomic (completable independently) and traceable to a spec item.

Hooks: pre_stage_PLANNING → story-mapper, mvp-freeze-architect

Stage 4: DESIGNING (Spec Mode only)

Create design.md (only for medium+ size) with architecture decisions:

  • Component structure
  • Data flow
  • API contracts
  • Key trade-offs

Checkpoint: If risk is elevated/critical, pause for user review.

Hooks: pre_stage_DESIGNING → domain-modeler, architecture-advisor, responsibility-modeler

Stage 5: IMPLEMENTING

Execute tasks from tasks.md sequentially. For each task:

  1. Read the task description
  2. Implement the change
  3. Mark task as [x] in tasks.md
  4. Run relevant tests if available

Hooks: pre_stage_IMPLEMENTING → tdd-coach

Stage 6: TESTING

Run full test suite. Update checklist.md:

# Checklist

## Code Quality
- [ ] Implementation complete
- [ ] Lint clean (run lint command)
- [ ] Type check pass (run typecheck command)

## Tests
- [ ] Unit tests pass
- [ ] Integration tests pass (if applicable)

## Acceptance Criteria
- [ ] AC 1: {criterion from spec} — verified
- [ ] AC 2: {criterion from spec} — verified

## Review
- [ ] Self-review complete
- [ ] No TODO/FIXME left unresolved

Hooks: pre_stage_TESTING → test-strategy-advisor, test-strategist, code-reviewer

Stage 7: DELIVERING (Spec Mode only)

Final verification against spec.md. Ensure every acceptance criterion has been met.

Hooks: post_stage_DELIVERING → code-reviewer, tech-design-reviewer

Stage 8: DONE

Workflow complete. Summary output:

  • What was delivered
  • Files changed
  • Tests passed
  • Time elapsed

Stage Advancement

# Check current status
node status.cjs -r <project_root>

# Advance to next stage
node advance.cjs -r <project_root>

# Force advance (skip checkpoint)
node advance.cjs -r <project_root> --force

Hooks System

Hooks are agents/skills that run at stage transitions. Three scopes:

ScopeFilePriority
Globalhooks.yaml (skill dir)Lowest
Project.trae/workflow/hooks.yamlMedium
Workflowworkflow.yaml (in workflow dir)Highest
Hook Points
HookWhenDefault Agents
pre_stage_DEFININGBefore filling speciron-audit-pm, risk-auditor
pre_stage_PLANNINGBefore task decompositionstory-mapper, mvp-freeze-architect
pre_stage_DESIGNINGBefore architecturedomain-modeler, architecture-advisor
pre_stage_IMPLEMENTINGBefore codingtdd-coach
pre_stage_TESTINGBefore test phasetest-strategy-advisor, code-reviewer
post_stage_DELIVERINGAfter final checktech-design-reviewer
# List hooks
node hooks.cjs -r <project_root> list

# Add a hook
node hooks.cjs -r <project_root> add pre_stage_TESTING -n my-validator --type skill

Quality Gates

Checkpoint Rules
StageCheckpoint When
DEFININGrisk = elevated or critical
PLANNINGsize = large or risk ≥ elevated
DESIGNINGsize ≥ medium or risk ≥ elevated
TESTINGalways (all risk levels)

At checkpoints, AI pauses and asks user for confirmation before advancing.

SDD Traceability Rule

Every line of code must trace back to:

  1. A task in tasks.md
  2. Which traces to an acceptance criterion in spec.md

If you find yourself writing code not covered by any task — stop and update tasks.md first.

Error Handling

IssueSolution
User gives vague requestClassify as feature/small, use Agent Mode, refine during implementation
Spec is incompleteAdd missing acceptance criteria before advancing to PLANNING
Task is too largeBreak into sub-tasks, each ≤1 file change
Tests fail during TESTINGStay in TESTING, fix issues, re-run
Checkpoint rejected by userStay in current stage, revise artifacts per feedback
Workflow abandonedNo cleanup needed, state persists in .trae/workflow/

Scripts

ScriptPurpose
init.cjsInitialize workflow with classification
advance.cjsAdvance to next stage
status.cjsShow current workflow status
hooks.cjsManage hook registrations
lib/common.cjsShared YAML utilities

Agents

See AGENTS.md for the full registry. Key agents by phase:

PhaseAgentMethodology
DEFININGiron-audit-pmPRD audit, DNA extraction
DEFININGrisk-auditorRisk scanning
DEFININGproblem-definerWeinberg problem analysis
PLANNINGstory-mapperPatton story mapping
PLANNINGmvp-freeze-architectScope freezing
DESIGNINGdomain-modelerDDD/Evans modeling
DESIGNINGarchitecture-advisorQuality attributes
IMPLEMENTINGtdd-coachBeck TDD cycle
TESTINGtest-strategistCrispin test strategy
TESTINGcode-reviewerCode review
DELIVERINGtech-design-reviewerArchitecture review

References

Comments

Markdown supported