Architecture¶

RequireKit system architecture and design overview.

System Overview¶

RequireKit is a requirements management toolkit using: - EARS notation for clear requirements - BDD/Gherkin for test scenarios - Markdown files for storage - Claude agents for automation

Architecture Layers¶

1. User Interface Layer¶

Slash commands (/gather-requirements, /formalize-ears)
Interactive Q&A sessions
Command-line interface

2. Agent Layer¶

requirements-analyst: Gathers and formalizes requirements
bdd-generator: Generates Gherkin scenarios
Specialized agents for EARS patterns

3. Storage Layer¶

Markdown files with YAML frontmatter
Git-friendly plain text format
Hierarchical directory structure

4. Integration Layer¶

Marker file detection for guardkit
PM tool metadata in frontmatter
Bidirectional package detection

Data Flow¶

User Command
    ↓
Claude Agent
    ↓
Process/Generate
    ↓
Markdown Files
    ↓
PM Tools / guardkit

Design Principles¶

Technology Agnostic: Markdown outputs work with any system
No Hard Dependencies: Standalone with optional integration
Version Control Friendly: Plain text, Git-compatible
Human Readable: Markdown is readable without tools
Composable: Works alone or with guardkit

Key Decisions¶

See Architecture Decision Records for detailed decision rationale.

For complete architecture details, see docs/architecture/ARCHITECTURE-SUMMARY.md.