diff --git a/00-context/DEMOTEL_MASTER_CONTEXT.md/demotel_context.md b/00-context/DEMOTEL_MASTER_CONTEXT.md/demotel_context.md deleted file mode 100644 index 5d89050..0000000 --- a/00-context/DEMOTEL_MASTER_CONTEXT.md/demotel_context.md +++ /dev/null @@ -1,815 +0,0 @@ -# DEMOTEL MASTER CONTEXT -Version: 2.0 -Owner: Aloke Dey -Project: DemoTel -Date: 2026-09-23 - -=============================================================================== -SECTION 1 - PURPOSE OF THIS DOCUMENT -=============================================================================== - -This document serves as the authoritative bootstrap context for any AI assistant, -developer, architect, consultant, product owner or delivery manager joining the -DemoTel initiative. - -Any future AI assistant should read this document completely before providing -recommendations, generating code, proposing architecture changes or creating -delivery artifacts. - -This document should be treated as the source of project context. - -=============================================================================== -SECTION 2 - PROJECT SUMMARY -=============================================================================== - -Project Name: -DemoTel - -Type: -Fictional Broadband Service Provider - -Purpose: - -DemoTel is a realistic enterprise lab environment used to design, test and -demonstrate: - -- Telecom BSS/OSS capabilities -- AI-assisted delivery -- Agentic software engineering -- SDLC automation -- Knowledge management -- RAG architectures -- Workflow orchestration -- Automated document generation -- AI-driven software delivery - -Long-Term Vision: - -Create an AI Delivery Platform capable of transforming simple human language -requirements into complete software delivery outputs. - -Target flow: - -Business Idea - ↓ -BRD - ↓ -HLD - ↓ -LLD - ↓ -Features - ↓ -User Stories - ↓ -Code - ↓ -Tests - ↓ -Deployment - ↓ -Operations - -=============================================================================== -SECTION 3 - PROJECT OWNER PROFILE -=============================================================================== - -Name: -Aloke Dey - -Role: -Technical Delivery Manager - -Background: - -- Telecom OSS/BSS -- Digital Transformation -- Cloud Migration -- Program Delivery -- Architecture Governance -- AI Adoption -- Enterprise Delivery - -Preferred Working Style: - -- Step-by-step guidance -- Incremental implementation -- Architecture before coding -- Documentation driven delivery -- End-to-end traceability - -Avoid: - -- Large unexplained jumps -- Overcomplicated architectures -- Vendor lock-in -- Unnecessary commercial tooling - -=============================================================================== -SECTION 4 - BUSINESS MODEL -=============================================================================== - -Company Name: -DemoTel - -Industry: -Telecommunications - -Customer Type: -Retail Broadband Customers (B2C) - -Primary Products: - -- Fibre Broadband -- Broadband + Voice -- Future Streaming Bundles -- Future Security Services - -Customer Journey: - -Check Availability - ↓ -Select Package - ↓ -Place Order - ↓ -Payment - ↓ -Engineer Appointment - ↓ -Installation - ↓ -Service Activation - ↓ -Billing - ↓ -Support - -=============================================================================== -SECTION 5 - CORE BUSINESS DOMAINS -=============================================================================== - -The following business domains are considered strategic knowledge areas. - -1. Product Catalog - -Capabilities: - -- Product Creation -- Pricing -- Promotions -- Discounts - -2. Customer Management - -Capabilities: - -- Customer Profile -- Contact Details -- Consent -- Communication Preferences - -3. Order Management - -Capabilities: - -- Order Capture -- Order Decomposition -- Order Tracking - -4. Service Qualification - -Capabilities: - -- Postcode Check -- Network Availability -- Service Eligibility - -5. Workforce Management - -Capabilities: - -- Engineer Scheduling -- Appointment Booking -- Resource Allocation - -6. Provisioning - -Capabilities: - -- Network Configuration -- Service Provisioning -- Activation Requests - -7. Billing - -Capabilities: - -- Invoice Generation -- Payments -- Credit Control - -8. Service Assurance - -Capabilities: - -- Fault Management -- Incident Management -- Service Recovery - -9. Notification Management - -Capabilities: - -- Email -- SMS -- KCI Communications - -10. Knowledge Management - -Capabilities: - -- Document Management -- AI Search -- Organizational Knowledge - -=============================================================================== -SECTION 6 - INFRASTRUCTURE -=============================================================================== - -Hosting Platform: - -Hostinger VPS - -Infrastructure Strategy: - -Single VPS -Docker Based -Containerized Architecture - -Core Platform Components: - -Traefik -n8n -MongoDB -Qdrant -Gitea -PostgreSQL - -Purpose of Each Component - -Traefik - -Responsibilities: - -- Reverse Proxy -- SSL -- Routing -- Domain Management - -n8n - -Responsibilities: - -- Workflow Automation -- AI Orchestration -- Integrations -- RAG Pipelines - -MongoDB - -Responsibilities: - -- Operational Data -- Knowledge Metadata -- Demo Business Data - -Qdrant - -Responsibilities: - -- Embeddings -- Semantic Search -- RAG Retrieval - -Gitea - -Responsibilities: - -- Source Code -- Knowledge Repository -- Documentation -- Version Control - -PostgreSQL - -Responsibilities: - -- Future Applications -- Structured Data Storage - -=============================================================================== -SECTION 7 - CURRENT STATE OF ENVIRONMENT -=============================================================================== - -Status: - -Completed - -✅ VPS Provisioned - -✅ Domain Registered - -✅ Traefik Running - -✅ n8n Running - -✅ MongoDB Running - -✅ Qdrant Running - -✅ Gitea Running - -✅ Initial MongoDB Read Workflow - -✅ Initial MongoDB Write Workflow - -✅ Demo Customer Data Creation - -Current Operational Focus: - -Build Enterprise AI Workspace - -=============================================================================== -SECTION 8 - ARCHITECTURE PRINCIPLES -=============================================================================== - -Principle 1 - -Documentation First - -Business understanding precedes development. - -Principle 2 - -Repository As Source Of Truth - -Authoritative material belongs in Gitea. - -Principle 3 - -Open Source First - -Prefer open-source alternatives whenever practical. - -Principle 4 - -Container First - -Applications should be deployed as containers. - -Principle 5 - -API Driven - -Services communicate using APIs. - -Principle 6 - -AI Augmentation - -AI should accelerate delivery rather than replace governance. - -=============================================================================== -SECTION 9 - KNOWLEDGE MANAGEMENT STRATEGY -=============================================================================== - -Source Of Truth: - -Gitea - -Search Layer: - -Qdrant - -Operational Metadata: - -MongoDB - -Knowledge Flow: - -Document - ↓ -Gitea - ↓ -n8n - ↓ -Embedding - ↓ -Qdrant - ↓ -AI Retrieval - -Important Rule: - -Gitea stores master documents. - -Qdrant stores searchable embeddings. - -Qdrant is NOT the source of truth. - -=============================================================================== -SECTION 10 - DOCUMENT STANDARDS -=============================================================================== - -Mandatory Document Types - -BRD -HLD -LLD -API Specifications -Test Cases -Deployment Guides -Runbooks - -All major projects must follow standardized templates. - -=============================================================================== -SECTION 11 - TRACEABILITY FRAMEWORK -=============================================================================== - -Target Traceability Model - -Business Requirement - ↓ -Functional Requirement - ↓ -Epic - ↓ -Feature - ↓ -User Story - ↓ -Design - ↓ -Code - ↓ -Test - ↓ -Deployment - -Every generated artifact should preserve traceability. - -=============================================================================== -SECTION 12 - AI WORKSPACE VISION -=============================================================================== - -The platform is NOT intended to be a simple chatbot. - -Target Product Name: - -DemoTel AI Workspace - -Primary Capabilities: - -- Chat -- Knowledge Search -- Document Management -- Agent Management -- Delivery Automation -- Traceability - -=============================================================================== -SECTION 13 - ENTERPRISE UI STRATEGY -=============================================================================== - -Preferred Frontend Stack - -React -TypeScript -TailwindCSS -ShadCN -React Router -Framer Motion - -Preferred Look And Feel - -Microsoft Copilot -ChatGPT Enterprise -Claude Enterprise - -Layout - -+------------------------------------------------------+ -| Sidebar | Chat Workspace | Context Panel | -+------------------------------------------------------+ - -Sidebar - -- Home -- Chat -- Knowledge -- BRD -- HLD -- LLD -- Projects -- Agents -- Admin - -Main Area - -- Conversation -- Generated Outputs -- Citations - -Context Area - -- Documents -- Sources -- Agent Status -- Traceability - -=============================================================================== -SECTION 14 - CURRENT IMPLEMENTATION DIRECTION -=============================================================================== - -Decision: - -Build React frontend first. - -Reason: - -Visible progress. -Quick feedback. -Strong demo capability. - -Phase 1 Capabilities - -- Navigation -- Chat Interface -- Context Panel -- Responsive Layout - -No backend integration initially. - -Focus: - -Professional Enterprise UI - -=============================================================================== -SECTION 15 - BACKEND STRATEGY -=============================================================================== - -Phase 1 - -React - ↓ -n8n Webhooks - -No FastAPI. - -No Custom Middleware. - -Reason: - -Keep architecture simple. - -Phase 2 - -React - ↓ -n8n - ↓ -Knowledge Services - -Phase 3 - -React - ↓ -FastAPI - ↓ -Agent Services - -Introduce FastAPI only when complexity justifies it. - -=============================================================================== -SECTION 16 - AI AGENT ROADMAP -=============================================================================== - -Future Agents - -1. BRD Agent - -Responsibilities: - -- Requirement Analysis -- BRD Generation - -2. HLD Agent - -Responsibilities: - -- Solution Design -- Integration Identification - -3. LLD Agent - -Responsibilities: - -- Technical Design -- API Specifications - -4. Story Agent - -Responsibilities: - -- Epic Generation -- Feature Generation -- Story Generation - -5. Test Agent - -Responsibilities: - -- Test Case Creation -- Automation Assets - -6. Deployment Agent - -Responsibilities: - -- Docker Assets -- Deployment Scripts - -=============================================================================== -SECTION 17 - TARGET SDLC AUTOMATION MODEL -=============================================================================== - -User Prompt - -"Build customer onboarding portal" - -AI Performs - -Requirements - ↓ -BRD - ↓ -HLD - ↓ -LLD - ↓ -Stories - ↓ -Code - ↓ -Tests - ↓ -Deployment - -Human Governance Remains Mandatory. - -=============================================================================== -SECTION 18 - KNOWN DESIGN DECISIONS -=============================================================================== - -ADR-001 - -Use Gitea as source of truth. - -Status: -Approved - -ADR-002 - -Use MongoDB as operational database. - -Status: -Approved - -ADR-003 - -Use Qdrant for vector search. - -Status: -Approved - -ADR-004 - -Use n8n as orchestration platform. - -Status: -Approved - -ADR-005 - -Do not use FastAPI in Phase 1. - -Status: -Approved - -ADR-006 - -React + TypeScript + Tailwind for Enterprise UI. - -Status: -Approved - -ADR-007 - -Deploy applications as Docker containers. - -Status: -Approved - -ADR-008 - -Maintain traceability across all generated assets. - -Status: -Approved - -=============================================================================== -SECTION 19 - CURRENT PRIORITIES -=============================================================================== - -Priority 1 - -Enterprise AI Workspace UI - -Priority 2 - -Knowledge Repository - -Priority 3 - -RAG Search - -Priority 4 - -Document Generation - -Priority 5 - -Agent Framework - -Priority 6 - -End-To-End SDLC Automation - -=============================================================================== -SECTION 20 - OPEN BACKLOG -=============================================================================== - -Workspace UI - -- Create React Project -- Design Sidebar -- Design Chat Area -- Design Context Panel -- Add Dark Theme - -Knowledge - -- Create Knowledge Repository -- Define Metadata Standards -- Define Ingestion Standards - -RAG - -- Build Ingestion Workflow -- Define Embedding Strategy -- Build Search Workflow - -Agents - -- Define Agent Responsibilities -- Define Agent Interfaces - -Governance - -- Traceability Model -- Naming Standards -- Versioning Standards - -=============================================================================== -SECTION 21 - INSTRUCTIONS TO FUTURE AI ASSISTANTS -=============================================================================== - -You are assisting with the DemoTel initiative. - -Treat this document as authoritative context. - -When making recommendations: - -- Preserve current architecture direction. -- Respect approved ADRs. -- Avoid unnecessary complexity. -- Prefer open-source technologies. -- Provide incremental implementation steps. -- Maintain traceability. -- Align all designs with the long-term AI-powered SDLC vision. - -Before proposing major changes, verify compatibility with existing decisions. - -END OF DOCUMENT \ No newline at end of file