Cấu trúc Documentation

Tài liệu này mô tả cấu trúc tổ chức của tất cả các file .md và .sh trong project.

📁 Cấu trúc tổng quan

project-root/
├── docs/                          # Tài liệu chính của project
│   ├── guides/                   # Hướng dẫn và guidelines
│   ├── troubleshooting/          # Troubleshooting và bug fixes
│   ├── implementation/           # Implementation summaries
│   ├── requirements/             # Requirements và specifications
│   └── *.md                      # Tài liệu chính (API, Architecture, etc.)
│
├── scripts/                       # Utility scripts
│   ├── *.sh                      # Shell scripts
│   └── *.js                      # Node.js scripts
│
└── apps/
    ├── booking-service/
    │   └── docs/                  # Booking Service documentation
    ├── payment-service/
    │   └── docs/                  # Payment Service documentation
    └── field-service/
        └── docs/                  # Field Service documentation

📚 Chi tiết từng thư mục

`docs/guides/`

Chứa các hướng dẫn và guidelines:

QUICK_START_GUIDE.md - Hướng dẫn bắt đầu nhanh
QUICK_FIX.md - Các cách fix nhanh
CONTRIBUTING.md - Hướng dẫn đóng góp
CODE_QUALITY.md - Tiêu chuẩn chất lượng code

`docs/troubleshooting/`

Chứa các tài liệu về troubleshooting và bug fixes:

BUILD_TROUBLESHOOTING.md - Giải quyết vấn đề build
TYPESCRIPT_ERRORS_FIX.md - Fix lỗi TypeScript
TYPESCRIPT_FIX_GUIDE.md - Hướng dẫn fix TypeScript
TYPEORM_FIX_COMPLETE.md - Fix TypeORM
KEYCLOAK_LOGIN_FIX.md - Fix Keycloak login
HUSKY_FIX_SUMMARY.md - Fix Husky hooks
LINTING_FIXES.md - Fix linting
LINTING_SUMMARY.md - Tóm tắt linting
LINTING-FIXES-SUMMARY.md - Tóm tắt fix linting
WARNINGS_ANALYSIS.md - Phân tích warnings
COMPLETE_SOLUTION.md - Giải pháp tổng hợp

`docs/implementation/`

Chứa các tài liệu về implementation:

PHASE-4-IMPLEMENTATION-SUMMARY.md - Tóm tắt Phase 4
PHASE_3_COMPLETE.md - Hoàn thành Phase 3
BOOKING-SERVICE-FIX-SUMMARY.md - Fix summary cho Booking Service
PAYMENT-SERVICE-FIX-SUMMARY.md - Fix summary cho Payment Service

`docs/requirements/`

Chứa requirements và specifications (đã có sẵn):

01-OVERVIEW.md
02-FUNCTIONAL-REQUIREMENTS.md
03-NON-FUNCTIONAL-REQUIREMENTS.md
04-API-SPECIFICATIONS.md
05-DATABASE-SCHEMA.md
06-SYSTEM-DESIGN.md
07-SECURITY-REQUIREMENTS.md
08-DEPLOYMENT-REQUIREMENTS.md
CHECKLIST.md
IMPLEMENTATION-ROADMAP.md

`scripts/`

Chứa các utility scripts:

start-infra.sh - Khởi động infrastructure
stop-infra.sh - Dừng infrastructure
reset-infra.sh - Reset infrastructure
logs.sh - Xem logs
fix-typescript-cache.sh - Fix TypeScript cache
setup-code-quality.sh - Setup code quality tools
FIX_ALL_ERRORS.sh - Fix tất cả lỗi thường gặp
check-naming.js - Kiểm tra naming conventions
kill-ports.js - Kill processes trên ports

`apps/booking-service/docs/`

Tài liệu cụ thể cho Booking Service:

QUICK_START.md
PHASE3_IMPLEMENTATION.md
MIGRATION_SUCCESS.md
MIGRATION_GUIDE.md
IMPLEMENTATION_SUMMARY.md
AUTH_TESTING_GUIDE.md
AUTH_SETUP_COMPLETE.md
ARCHITECTURE.md
ADMIN_USER_GUIDE.md

`apps/payment-service/docs/`

Tài liệu cụ thể cho Payment Service:

PAYMENT_INTEGRATION.md

`apps/field-service/docs/`

Tài liệu cụ thể cho Field Service:

MISSING_FILES_FIXED.md
LINT_FIXES.md
COMPLETE_FIX_SUMMARY.md

🔍 Cách tìm kiếm tài liệu

Hướng dẫn bắt đầu: Xem docs/guides/
Gặp lỗi: Xem docs/troubleshooting/
Tìm hiểu implementation: Xem docs/implementation/
Requirements: Xem docs/requirements/
Service-specific: Xem apps/{service}/docs/
Scripts: Xem scripts/README.md

📝 Lưu ý

Mỗi thư mục đều có file README.md để mô tả nội dung
Tất cả file đã được tổ chức theo chức năng và mục đích sử dụng
Các file cũ đã được di chuyển từ root và các thư mục service vào cấu trúc mới