Skip to content

NatBrian/AgenticReqToDesign

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AgenticReqToDesign

Project Description

AgenticReqToDesign is an agentic pipeline that automates the process of transforming business requirements into technical design documents. The pipeline uses multiple AI agents to orchestrate the workflow from initial business prompts to comprehensive technical specifications.

Features

  • Business Requirement Generation: Creates detailed business requirement documents
  • Business Flow Validation: Validates requirements and creates end-to-end business flows
  • Technical Design: Generates high-level design (HLD) and detailed technical specifications
  • Multi-Agent Collaboration: Uses specialized agents for coordination, business analysis, architecture, and technical writing
  • Artifact Management: Centralized storage and tracking of all generated documents

Setup Instructions

  1. Prerequisites:

    • Python 3.7+
    • Required packages listed in requirements.txt
  2. Installation:

    pip install -r requirements.txt
  3. Environment Variables: Create a .env file with the following variables:

    OPENROUTER_API_KEY=your_openrouter_api_key
    GEMINI_API_KEY=your_gemini_api_key
    

Usage

  1. Run the Pipeline:

    python main.py
  2. Customize Input: Modify the business_prompt variable in the main function to specify your business requirements.

  3. Output:

    • Generated artifacts
    • Logs
    • Final bundle and individual artifacts are saved with timestamps

Architecture

The system consists of several specialized agents:

  • Coordinator: Orchestrates the entire workflow
  • Product Owner: Generates comprehensive business requirements
  • Business Analyst: Validates requirements and creates business flows
  • Solution Architect: Creates high-level design documents
  • Frontend Writer: Generates frontend technical specifications
  • Backend Writer: Creates backend technical specifications

About

Agentic AI transforming Business Requirements into Technical Detailed Design

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published