Requirement Guide

Requirement Guide

A conversational requirement clarification tool that guides users through structured questioning across six dimensions and assembles a structured requirement document from the gathered answers.

Features

• Structured Questioning — Six preset dimensions drive a guided dialogue
• Session Management — Track active, completed, and abandoned sessions
• Required vs Optional — Distinguish mandatory elements from nice-to-haves
• Document Generation — Assemble a requirement document with completeness scoring
• Persistence — Save/load sessions and documents as JSON for resumable workflows
• Thread-Safe — Concurrent calls do not corrupt session state
• Zero Dependencies — Pure standard library (only pytest for tests)

Question Dimensions

Installation

openclaw skills install requirement-guide

Quick Start

from src import RequirementGuide

guide = RequirementGuide()

# Start a guided session
session = guide.start_session("Inventory Management System")

# Ask questions and process answers
question = guide.ask_question(session.id)
print(question.text)            # "What is the project name?"
answer = guide.process_answer(session.id, "StockFlow")
print(answer.processed)         # True

# Continue the dialogue...
while True:
    q = guide.ask_question(session.id)
    if q is None:
        break
    guide.process_answer(session.id, "..." if q.required else "-")

# Generate the requirement document
doc = guide.generate_document(session.id)
print(doc.title)                # "Inventory Management System"
print(doc.completeness)         # 1.0

API

RequirementGuide

Data Models

• Session — id, topic, status, questions_asked, answers, elements
• Question — id, dimension, text, required
• Answer — question_id, content, processed
• RequirementDocument — title, elements, completeness
• SessionStatus — ACTIVE, COMPLETED, ABANDONED

Testing

cd d:\openclaw-skills\business-stack\requirement-guide
python -m pytest tests/ -v --tb=short

License

MIT License — Free for personal and commercial use.

Author

Terr123123