MPAC SmartPOS Platform - Documentation Index

Version: 2.0 Last Updated: 2026-01-28 Status: Active Development

---

Overview

This directory contains the modular reference documentation for the MPAC SmartPOS Cloud Platform. The original comprehensive PRD has been split into focused, maintainable documents organized by domain and concern.

Master Document: ../new-PRD.md (Complete reference)

---

Quick Navigation

📋 Executive Summary

Strategic overview and system design

• Product Overview - Platform purpose and capabilities
• Scale Requirements - Performance and capacity targets
• System Architecture - High-level technical architecture

🏢 Business Domains

Core business capabilities and workflows

• Domain Catalog → - Complete domain reference
• Key domains:
  • Identity & Access Management - Authentication and authorization
  • Payment Gateway - Payment processing (mpac-pgw)
  • Device Management - Terminal lifecycle
  • Order & Bill Management - Order workflows
  • Payment Processing - Payment methods and flows
  • Settlement & Reconciliation - Financial settlement

⚙️ Technical Architecture

System design and implementation patterns

• Architecture Guide → - Complete technical reference
• Communication Patterns - Service integration
• Database Architecture - Data modeling
• Security Architecture - Security and compliance
• Performance & Scalability - Monitoring and optimization

🚀 Deployment & Infrastructure

Deployment strategy and environment management

• AWS Infrastructure - Cloud resources
• Deployment Strategy - Blue-green deployment
• Environments - Dev/staging/production
• CI/CD Pipeline - Automated workflows
• Observability Stack (mpac-obs) - Monitoring, logging, tracing

🔌 Integration Specifications

External integrations and SDK usage

• Frontend SDK - @cloudsky/mpac-pgw-sdk-js integration
• Android Bridge - Native bridge interface
• External Systems - Provider integrations

🧪 Testing Strategy

Quality assurance and testing approaches

• Unit Testing - Component-level tests
• Integration Testing - Service integration tests
• Load Testing - Performance validation
• Security Testing - Security validation

📚 Appendix

Reference materials and definitions

• Glossary - Terms and definitions
• API Reference - Endpoint documentation
• Data Model - ER diagrams and schemas
• Status Codes - Application status codes
• Configuration - Environment variables
• Support - Contact information

---

Document Structure

Each document follows a consistent template:

# [Document Title]

**Part of:** MPAC SmartPOS Cloud Platform - Product Requirements
**Version:** 2.0
**Last Updated:** 2026-01-28

---

## Overview
[Brief description]

## Table of Contents
[Section links]

---

[Content]

---

## See Also
[Cross-references]

**Navigation:** [↑ Back to Index](../README.md) | [← Previous] | [Next →]

---

Usage Patterns

For New Developers

1. Start with Product Overview
2. Read System Architecture
3. Explore relevant Business Domains
4. Review Technical Architecture

For Feature Development

1. Find relevant domain in Domain Catalog
2. Check API Reference
3. Review Database Architecture
4. Consult Testing Strategy

For DevOps/SRE

1. Review AWS Infrastructure
2. Understand Deployment Strategy
3. Check Performance Monitoring
4. Review CI/CD Pipeline

For Security Review

1. Read Security Architecture
2. Review IAM Domain
3. Check Security Testing
4. Consult API Reference

---

Maintenance

Adding New Content

• New business domains → 02-domains/[domain-name].md
• New technical patterns → 03-technical/[pattern-name].md
• New appendix entries → 07-appendix/[topic-name].md

Updating Documents

• Maintain version headers in each file
• Update cross-references when restructuring
• Keep master PRD in sync for reference

File Naming Convention

• Use kebab-case: payment-gateway.md
• Be descriptive: 2-3 words maximum
• Avoid underscores: ❌ payment_gateway.md

---

Statistics

• Total Documents: 42 files
• Directories: 7 categories
• Content Files: 35 documents
• Index Files: 4 README files

---

Navigation: ↑ Top | Master PRD →