Skip to content

Getting Started with RequireKit

Welcome to RequireKit! This section will help you get up and running quickly with requirements management using EARS notation, BDD scenarios, and epic/feature hierarchy.

Quick Navigation

🚀 Quickstart

Get up and running in 5 minutes with a simple requirements workflow.

📦 Installation

Install RequireKit and set up your environment.

📝 Your First Requirements

Step-by-step walkthrough of gathering and formalizing your first requirements.

🔗 Integration with guardkit

Learn how RequireKit integrates with guardkit for complete requirements-to-implementation workflow.

What is RequireKit?

RequireKit is a requirements management toolkit that helps you:

  • Capture requirements through interactive Q&A sessions
  • Formalize them using EARS notation for clarity
  • Generate BDD/Gherkin scenarios for testing
  • Organize into epic/feature hierarchies for traceability
  • Export to PM tools (Jira, Linear, GitHub Projects)

Core Workflow

1. Gather Requirements          → /gather-requirements
2. Formalize with EARS          → /formalize-ears
3. Generate BDD Scenarios       → /generate-bdd
4. Create Epic                  → /epic-create "Title"
5. Create Feature               → /feature-create "Title" epic:EPIC-XXX
6. View Hierarchy               → /hierarchy-view EPIC-XXX

Prerequisites

  • Claude Code or compatible Claude environment
  • Git (for version control)
  • Text editor or IDE

Learning Path

Beginner

  1. Start with Quickstart
  2. Learn EARS Notation
  3. Try Your First Requirements

Intermediate

  1. Explore BDD Generation
  2. Learn Epic/Feature Hierarchy
  3. Review Commands Reference

Advanced

  1. Configure Integration with guardkit
  2. Set up PM Tool Export
  3. Explore Examples

Next Steps

👉 New to RequireKit? Start with the Quickstart Guide

👉 Ready to install? Follow the Installation Guide

👉 Want to understand concepts first? Read about EARS Notation

Questions? Check the FAQ or Troubleshooting Guide