Docs

Requirements Engine

From knowledge base and documents to functional specs and ClickUp-ready backlogs — with humans reviewing every artifact.

The Requirements Engine converts product knowledge — knowledge-base articles, Markdown, HTML, PDFs, DOCX, URLs — into a functional specification and a structured backlog.

Pipeline

  • Ingest sources into a canonical KnowledgeArticle model.
  • Extract requirement candidates, capabilities, workflows, actors, and rules.
  • Build a product map / knowledge graph and a FunctionalSpecification.
  • Plan epics, stories, and tasks with traceability.
  • Export Markdown/backlog artifacts ready for ClickUp (via MCP or review).

Why it is powerful

It compresses weeks of analysis into a repeatable pipeline — without pretending the model “understands your company” by magic. You choose the source, the strictness mode, and which artifacts become work.

You stay the pilot

  • CLI flags control ingest-only, strict validation, and filters.
  • Validators surface inconsistencies instead of silently inventing scope.
  • LLM gateways (Ollama, Claude, OpenAI, stub) are swappable tools behind ports.

Stack highlights

TypeScript, hexagonal architecture, Vitest, AJV, Cheerio/Crawlee for ingestion, multi-provider LLM adapters.