​

Sparki Platform Documentation

​

Quick Links

• 🤖 Platform Automation - AI agent prompts for SRS-to-platform orchestration
• 🛠️ DevOps Optimization - CI/CD, cost, performance, security optimization prompts
• 📋 Requirements Management - Requirements extraction, validation, traceability
• 🎨 Frontend Development - Next.js, TypeScript, shadcn/ui, Zustand, TanStack Query
• 🔧 Backend Development - Go, Gin/Fiber, PostgreSQL, Redis, RabbitMQ, Kubernetes
• 🌐 Networking & Real-time - Rust, WebSockets, TCP/UDP, Tokio, Wireshark, 10k+ connections
• 📱 Mobile Development - React Native, Flutter, iOS/Android, offline-first, 60 FPS
• 🎯 Tasksets & Execution - Work blocks, execution strategies, progress reports
• 📚 Runbooks - Operational procedures and incident response
• 🏗️ System Architecture - Architecture docs and specifications

​

Overview

• automation/ - AI agent prompts and automation tools
  • prompts/ - SRS-to-platform orchestration (planning & issue creation)
  • devops-prompts/ - DevOps optimization (CI/CD, cost, performance, security)
  • requirements-prompts/ - Requirements management (extraction, validation, traceability)
  • frontend-prompts/ - Frontend development (Next.js, component architecture, state, data fetching, performance, a11y, testing, SEO)
  • backend-prompts/ - Backend development (Go, API architecture, concurrency, databases, message queues, caching, observability, containerization)
  • networking-prompts/ - Networking & real-time (Rust, WebSockets, TCP/UDP, protocols, Tokio async, Wireshark, load balancing, containerization)
  • mobile-prompts/ - Mobile development (React Native, Flutter, app architecture, UI design system, state management, persistence, native modules, 60 FPS performance, App/Play Store deployment)
• tasksets/ - Execution strategies and task breakdowns
• runbooks/ - Operational runbooks
  • devops/ - DevOps optimization procedures
  • requirements/ - Requirements management procedures
  • frontend/ - Frontend development procedures
  • backend/ - Backend development procedures
  • networking/ - Networking & real-time procedures
  • mobile/ - Mobile development procedures
• system/ - System architecture and specifications
• reports/ - Platform reports and analysis
• assets/ - Documentation assets (images, diagrams)

​

Directory Structure

platform-docs/
├── automation/              # AI agent prompts and automation
│   ├── prompts/             # SRS-to-platform orchestration prompts
│   │   ├── 00-master-orchestrator.xml
│   │   ├── 01-srs-to-architecture.xml
│   │   ├── 02-repository-creator.xml
│   │   ├── 03-issue-hierarchy-generator.xml
│   │   ├── 04-infrastructure-gap-analyzer.xml
│   │   ├── 05-execution-strategy-builder.xml
│   │   ├── 06-interface-contract-generator.xml
│   │   ├── 07-acceptance-criteria-generator.xml
│   │   ├── ORCHESTRATION_PLAYBOOK.md
│   │   └── README.md
│   ├── devops-prompts/      # DevOps optimization prompts
│   │   ├── 00-devops-orchestrator.xml
│   │   ├── 01-cicd-pipeline-audit.xml
│   │   ├── 02-infrastructure-cost-optimizer.xml
│   │   ├── 03-performance-profiler.xml
│   │   ├── 04-security-hardening.xml
│   │   ├── 05-observability-setup.xml
│   │   ├── 06-load-testing.xml
│   │   ├── DEVOPS_PLAYBOOK.md
│   │   └── README.md
│   ├── requirements-prompts/ # Requirements management prompts
│   │   ├── 00-requirements-orchestrator.xml
│   │   ├── 01-requirements-extraction.xml
│   │   ├── 02-requirements-validation.xml
│   │   ├── 03-traceability-matrix.xml
│   │   ├── 04-acceptance-criteria-generator.xml
│   │   ├── 05-requirements-gap-analysis.xml
│   │   ├── 06-requirements-coverage-analyzer.xml
│   │   ├── 07-requirements-change-impact.xml
│   │   ├── REQUIREMENTS_PLAYBOOK.md
│   │   └── README.md
│   ├── frontend-prompts/     # Frontend development prompts
│   │   ├── 00-frontend-orchestrator.xml
│   │   ├── 01-component-architecture.xml
│   │   ├── 02-state-management.xml
│   │   ├── 03-data-fetching.xml
│   │   ├── 04-performance-optimization.xml
│   │   ├── 05-accessibility-audit.xml
│   │   ├── 06-testing-setup.xml
│   │   ├── 07-seo-optimization.xml
│   │   ├── FRONTEND_PLAYBOOK.md
│   │   └── README.md
│   ├── backend-prompts/      # Backend development prompts
│   │   ├── 00-backend-orchestrator.xml
│   │   ├── 01-api-architecture.xml
│   │   ├── 02-concurrency-patterns.xml
│   │   ├── 03-database-integration.xml
│   │   ├── 04-message-queues.xml
│   │   ├── 05-caching-strategies.xml
│   │   ├── 06-observability-setup.xml
│   │   ├── 07-containerization.xml
│   │   ├── BACKEND_PLAYBOOK.md
│   │   └── README.md
│   ├── networking-prompts/   # Networking & real-time prompts
│   │   ├── 00-networking-orchestrator.xml
│   │   ├── 01-websocket-architecture.xml
│   │   ├── 02-network-protocols.xml
│   │   ├── 03-concurrency-runtime.xml
│   │   ├── 04-performance-optimization.xml
│   │   ├── 05-protocol-analysis.xml
│   │   ├── 06-load-balancing.xml
│   │   ├── 07-testing-monitoring.xml
│   │   ├── 08-containerization.xml
│   │   ├── NETWORKING_PLAYBOOK.md
│   │   └── README.md
│   ├── mobile-prompts/       # Mobile development prompts
│   │   ├── 00-mobile-orchestrator.xml
│   │   ├── 01-app-architecture.xml
│   │   ├── 02-ui-design-system.xml
│   │   ├── 03-state-management.xml
│   │   ├── 04-data-persistence.xml
│   │   ├── 05-network-apis.xml
│   │   ├── 06-native-modules.xml
│   │   ├── 07-performance-optimization.xml
│   │   ├── 08-testing-deployment.xml
│   │   ├── MOBILE_PLAYBOOK.md
│   │   └── README.md
│   └── README.md
├── tasksets/                # Execution strategies and progress
│   ├── TASKSET_EXECUTION_STRATEGY.md
│   ├── ARCHITECTURAL_GAPS_SUMMARY.md
│   └── README.md
├── runbooks/                # Operational procedures
│   ├── devops/              # DevOps optimization runbooks
│   │   ├── CICD_OPTIMIZATION_RUNBOOK.md
│   │   ├── COST_OPTIMIZATION_RUNBOOK.md
│   │   ├── PERFORMANCE_OPTIMIZATION_RUNBOOK.md
│   │   ├── SECURITY_HARDENING_RUNBOOK.md
│   │   ├── OBSERVABILITY_RUNBOOK.md
│   │   └── LOAD_TESTING_RUNBOOK.md
│   ├── requirements/        # Requirements management runbooks
│   │   ├── REQUIREMENTS_GATHERING_RUNBOOK.md
│   │   └── REQUIREMENTS_VALIDATION_RUNBOOK.md
│   ├── frontend/            # Frontend development runbooks
│   │   ├── COMPONENT_ARCHITECTURE_RUNBOOK.md
│   │   ├── STATE_MANAGEMENT_RUNBOOK.md
│   │   ├── DATA_FETCHING_RUNBOOK.md
│   │   ├── PERFORMANCE_OPTIMIZATION_RUNBOOK.md
│   │   ├── ACCESSIBILITY_RUNBOOK.md
│   │   └── TESTING_RUNBOOK.md
│   ├── backend/             # Backend development runbooks
│   │   ├── API_ARCHITECTURE_RUNBOOK.md
│   │   ├── CONCURRENCY_PATTERNS_RUNBOOK.md
│   │   ├── DATABASE_INTEGRATION_RUNBOOK.md
│   │   ├── MESSAGE_QUEUES_RUNBOOK.md
│   │   ├── CACHING_RUNBOOK.md
│   │   ├── OBSERVABILITY_RUNBOOK.md
│   │   └── CONTAINERIZATION_RUNBOOK.md
│   ├── networking/          # Networking & real-time runbooks
│   │   ├── WEBSOCKET_ARCHITECTURE_RUNBOOK.md
│   │   ├── NETWORK_PROTOCOLS_RUNBOOK.md
│   │   ├── CONCURRENCY_RUNTIME_RUNBOOK.md
│   │   ├── PERFORMANCE_OPTIMIZATION_RUNBOOK.md
│   │   ├── PROTOCOL_ANALYSIS_RUNBOOK.md
│   │   ├── LOAD_BALANCING_RUNBOOK.md
│   │   └── TESTING_MONITORING_RUNBOOK.md
│   ├── mobile/              # Mobile development runbooks
│   │   ├── APP_ARCHITECTURE_RUNBOOK.md
│   │   ├── UI_DESIGN_SYSTEM_RUNBOOK.md
│   │   ├── STATE_MANAGEMENT_RUNBOOK.md
│   │   ├── DATA_PERSISTENCE_RUNBOOK.md
│   │   ├── NETWORK_APIS_RUNBOOK.md
│   │   ├── NATIVE_MODULES_RUNBOOK.md
│   │   ├── PERFORMANCE_OPTIMIZATION_RUNBOOK.md
│   │   └── TESTING_DEPLOYMENT_RUNBOOK.md
│   └── ...
├── system/                  # System architecture and specs
│   ├── architecture/
│   ├── monetisation/
│   ├── rift/
│   └── spec/
├── reports/                 # Platform reports
├── assets/                  # Images, diagrams, media
└── README.md

​

🚀 Getting Started

​

For Platform Planning (SRS → Platform)

1. Start here: automation/prompts/ORCHESTRATION_PLAYBOOK.md
2. What you get:
   • 15-25 GitHub repositories with consistent labels
   • 200-350 hierarchical issues (Epic → Feature → Task)
   • Complete execution strategy (15-20 work blocks, 16-week timeline)
   • API contracts and YAML acceptance criteria
3. Time: 18-32 hours total

​

For DevOps Optimization (Existing Platforms)

1. Start here: automation/devops-prompts/DEVOPS_PLAYBOOK.md
2. What you get:
   • 30-60% faster CI/CD builds (dependency caching, parallelization)
   • 20-40% infrastructure cost reduction (rightsizing, spot instances)
   • p95 latency <200ms (database optimization, caching)
   • Zero critical CVEs (automated security hardening)
   • Complete observability (Prometheus, Grafana, Loki, Tempo)
   • Validated capacity (load testing, auto-scaling)
3. Time: 2-4 weeks for complete optimization

​

For Requirements Management (Any Project)

1. Start here: automation/requirements-prompts/REQUIREMENTS_PLAYBOOK.md
2. What you get:
   • Requirements catalog (50-500 requirements in structured YAML)
   • >80% quality score (validated against SMART criteria)
   • >70% traceability (requirements ↔ issues ↔ code ↔ tests)
   • Given/When/Then acceptance criteria (testable specifications)
   • Gap analysis (missing requirements identified)
   • Test coverage analysis (untested requirements highlighted)
   • Change impact assessment (<2 hours per change)
3. Time: 20-35 hours for complete lifecycle

​

For Frontend Development (Next.js Applications)

1. Start here: automation/frontend-prompts/FRONTEND_PLAYBOOK.md
2. What you get:
   • Design system with shadcn/ui and custom theming
   • State management with Zustand (clean, no prop drilling)
   • Data fetching with TanStack Query (70% fewer API calls via caching)
   • Lighthouse >90 (Performance, Accessibility, SEO)
   • WCAG 2.1 AA compliant (keyboard nav, screen reader tested)
   • >80% test coverage (Vitest, React Testing Library, Playwright)
   • Bundle <200KB (optimized images, fonts, code splitting)
3. Time: 2-4 weeks for complete frontend setup

​

For Backend Development (Go Microservices)

1. Start here: automation/backend-prompts/BACKEND_PLAYBOOK.md
2. What you get:
   • High-performance API (1000+ req/sec, p95 <100ms) with Gin or Fiber
   • Concurrency patterns (worker pools, pipelines, context cancellation)
   • Database layer (PostgreSQL, MongoDB, Redis with connection pooling)
   • Message queues (RabbitMQ, Kafka, NATS for async operations)
   • Caching layer (80%+ hit rate, Redis with invalidation)
   • Full observability (Zap logging, Prometheus metrics, OpenTelemetry tracing)
   • Production container (<50MB Docker image, Kubernetes deployment)
3. Time: 3-5 weeks for complete backend setup

​

For Networking & Real-time (Rust/Zig Systems)

1. Start here: automation/networking-prompts/NETWORKING_PLAYBOOK.md
2. What you get:
   • WebSocket server (10,000+ concurrent connections, p99 <10ms latency)
   • Network protocols (TCP/UDP, custom binary protocols with zero-copy)
   • Async runtime (Tokio with actor patterns, efficient task scheduling)
   • Performance (100,000+ msg/sec, <100MB + 10KB/conn memory)
   • Protocol analysis (Wireshark dissectors, tcpdump debugging)
   • Load balancing (HAProxy/NGINX with sticky sessions)
   • Full observability (Prometheus, OpenTelemetry, latency histograms)
   • Optimized container (<20MB Docker image with scratch/Alpine)
3. Time: 4-6 weeks for complete networking stack

​

For Mobile Development (React Native & Flutter)

1. Start here: automation/mobile-prompts/MOBILE_PLAYBOOK.md
2. What you get:
   • Navigation (React Navigation 6+ or GoRouter for Flutter)
   • Design system (design tokens, themes, light/dark mode)
   • State management (Redux Toolkit for RN, Riverpod for Flutter)
   • Offline-first (AsyncStorage, SQLite, Realm/Hive with sync)
   • Native features (camera, location, push notifications, biometrics)
   • 60 FPS performance (FlatList optimization, Reanimated, Rive)
   • Bundle <30MB (RN) / <20MB (Flutter) (release builds)
   • App/Play Store ready (Detox/Patrol E2E, CI/CD, TestFlight/beta)
3. Time: 4-6 weeks for complete cross-platform app

​

Building Documentation

# Install MkDocs (optional)
pip install mkdocs mkdocs-material

# Serve locally
mkdocs serve

# Build static site
mkdocs build

​

Contributing

1. Create a branch for your changes
2. Update relevant documentation
3. Submit a pull request

​

Related Repositories

• api-engine
• web-app
• observability-storm

​

License