Skip to content

rizethereum/claude-code-requirements-builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Claude Requirements Gathering System

An intelligent requirements gathering system for Claude Code that progressively builds context through automated discovery, asks simple yes/no questions, and generates comprehensive requirements documentation.

🎯 Overview

This system transforms the requirements gathering process by:

  • Codebase-Aware Questions: AI analyzes your code first, then asks informed questions
  • Simple Yes/No Format: All questions are yes/no with smart defaults - just say "idk" to use defaults
  • Two-Phase Questioning: 5 high-level questions for context, then 5 expert questions after code analysis
  • Automated Documentation: Generates comprehensive specs with specific file paths and patterns
  • Product Manager Friendly: No code knowledge required to answer questions

πŸš€ Quick Start

# Start gathering requirements for a new feature
/requirements-start add user profile picture upload

# Check progress and continue
/requirements-status

# View current requirement details
/requirements-current

# List all requirements
/requirements-list

# End current requirement gathering
/requirements-end

# Quick reminder if AI strays off course
/remind

πŸ“ Repository Structure

claude-requirements/
β”œβ”€β”€ commands/                     # Claude command definitions
β”‚   β”œβ”€β”€ requirements-start.md    # Begin new requirement
β”‚   β”œβ”€β”€ requirements-status.md   # Check progress (alias: current)
β”‚   β”œβ”€β”€ requirements-current.md  # View active requirement
β”‚   β”œβ”€β”€ requirements-end.md      # Finalize requirement
β”‚   β”œβ”€β”€ requirements-list.md     # List all requirements
β”‚   └── requirements-remind.md   # Remind AI of rules
β”‚
β”œβ”€β”€ requirements/                 # Requirement documentation storage
β”‚   β”œβ”€β”€ .current-requirement     # Tracks active requirement
β”‚   β”œβ”€β”€ index.md                 # Summary of all requirements
β”‚   └── YYYY-MM-DD-HHMM-name/   # Individual requirement folders
β”‚       β”œβ”€β”€ metadata.json        # Status and progress tracking
β”‚       β”œβ”€β”€ 00-initial-request.md    # User's original request
β”‚       β”œβ”€β”€ 01-discovery-questions.md # 5 context questions
β”‚       β”œβ”€β”€ 02-discovery-answers.md   # User's answers
β”‚       β”œβ”€β”€ 03-context-findings.md    # AI's code analysis
β”‚       β”œβ”€β”€ 04-detail-questions.md    # 5 expert questions
β”‚       β”œβ”€β”€ 05-detail-answers.md      # User's detailed answers
β”‚       └── 06-requirements-spec.md   # Final requirements
β”‚
└── examples/                     # Example requirements

πŸ”„ How It Works

Phase 1: Initial Setup & Codebase Analysis

User: /requirements-start add export functionality to reports

AI analyzes the entire codebase structure to understand the architecture, tech stack, and patterns.

Phase 2: Context Discovery Questions

The AI asks 5 yes/no questions to understand the problem space:

Q1: Will users interact with this feature through a visual interface?
(Default if unknown: YES - most features have UI components)

User: yes

Q2: Does this feature need to work on mobile devices?
(Default if unknown: YES - mobile-first is standard)

User: idk
AI: βœ“ Using default: YES

[Continues through all 5 questions before recording answers]

Phase 3: Targeted Context Gathering (Autonomous)

AI autonomously:

  • Searches for specific files based on discovery answers
  • Reads relevant code sections
  • Analyzes similar features in detail
  • Documents technical constraints and patterns

Phase 4: Expert Requirements Questions

With deep context, asks 5 detailed yes/no questions:

Q1: Should we use the existing ExportService at services/ExportService.ts?
(Default if unknown: YES - maintains architectural consistency)

User: yes

Q2: Will PDF exports need custom formatting beyond the standard template?
(Default if unknown: NO - standard template covers most use cases)

User: no

[Continues through all 5 questions before recording answers]

Phase 5: Requirements Documentation

Generates comprehensive spec with:

  • Problem statement and solution overview
  • Functional requirements from all 10 answers
  • Technical requirements with specific file paths
  • Implementation patterns to follow
  • Acceptance criteria

πŸ“‹ Command Reference

/requirements-start [description]

Begins gathering requirements for a new feature or change.

Example:

/requirements-start implement dark mode toggle

/requirements-status or /requirements-current

Shows current requirement progress and continues gathering.

Output:

πŸ“‹ Active Requirement: dark-mode-toggle
Phase: Discovery Questions
Progress: 3/5 questions answered

Next: Q4: Should this sync across devices?

/requirements-end

Finalizes current requirement, even if incomplete.

Options:

  1. Generate spec with current info
  2. Mark incomplete for later
  3. Cancel and delete

/requirements-list

Shows all requirements with their status.

Output:

βœ… COMPLETE: dark-mode-toggle (Ready for implementation)
πŸ”΄ ACTIVE: user-notifications (Discovery 3/5)
⚠️ INCOMPLETE: data-export (Paused 3 days ago)

/remind or /requirements-remind

Reminds AI to follow requirements gathering rules.

Use when AI:

  • Asks open-ended questions
  • Starts implementing code
  • Asks multiple questions at once

🎯 Features

Smart Defaults

Every question includes an intelligent default based on:

  • Best practices
  • Codebase patterns
  • Context discovered

Progressive Questioning

  • Phase 1: Analyzes codebase structure first
  • Phase 2: 5 high-level questions for product managers
  • Phase 3: Autonomous deep dive into relevant code
  • Phase 4: 5 expert questions based on code understanding

Automatic File Management

  • All files created automatically
  • Progress tracked between sessions
  • Can resume anytime

Integration Ready

  • Links to development sessions
  • References PRs and commits
  • Searchable requirement history

πŸ’‘ Best Practices

For Users

  1. Be Specific: Clear initial descriptions help AI ask better questions
  2. Use Defaults: "idk" is perfectly fine - defaults are well-reasoned
  3. Stay Focused: Use /remind if AI goes off track
  4. Complete When Ready: Don't feel obligated to answer every question

For Requirements

  1. One Feature at a Time: Keep requirements focused
  2. Think Implementation: Consider how another AI will use this
  3. Document Decisions: The "why" is as important as the "what"
  4. Link Everything: Connect requirements to sessions and PRs

πŸ”§ Installation

  1. Clone this repository:
git clone https://github.com/rizethereum/claude-code-requirements-builder.git
  1. Copy the commands to your project:
cp -r commands ~/.claude/commands/
# OR for project-specific
cp -r commands /your/project/.claude/commands/
  1. Create requirements directory:
mkdir -p requirements
touch requirements/.current-requirement
  1. Add to .gitignore if needed:
requirements/

πŸ“š Examples

Feature Development

/requirements-start add user avatar upload
# AI analyzes codebase structure
# Answer 5 yes/no questions about the feature
# AI autonomously researches relevant code
# Answer 5 expert yes/no questions
# Get comprehensive requirements doc with file paths

Bug Fix Requirements

/requirements-start fix dashboard performance issues
# Answer questions about scope
# AI identifies problematic components
# Answer questions about acceptable solutions
# Get targeted fix requirements

UI Enhancement

/requirements-start improve mobile navigation experience
# Answer questions about current issues
# AI analyzes existing navigation
# Answer questions about desired behavior
# Get detailed UI requirements

🀝 Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Add new commands or improve existing ones
  4. Submit a pull request

Ideas for Contribution

  • Add requirement templates for common features
  • Create requirement validation commands
  • Build requirement-to-implementation tracking
  • Add multi-language question support

πŸ“„ License

MIT License - Feel free to use and modify for your projects.

πŸ™ Acknowledgments

Inspired by @iannuttall's claude-sessions project, which pioneered the concept of structured session management for Claude Code.


Remember: Good requirements today prevent confusion tomorrow!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published