Files
docs/archive/STRUCTURE.md
T
masoodafar-web 5965b98728 update
2026-01-03 18:27:49 +03:30

6.9 KiB

🗂️ ساختار نهایی مستندات FourSat

تاریخ: ۱۴ آذر ۱۴۰۴
نسخه: 2.0 Final


📁 ساختار کامل

totalDoc/
│
├── 📄 00-INDEX.md                      (14 KB) ⭐ فهرست اصلی
├── 📄 00-INDEX-NEW.md                  (15 KB) تحلیل اولیه
├── 📄 README.md                        (3.6 KB) راهنمای سریع
├── 📄 QUICK-REFERENCE.md               مرجع فوری
├── 📄 CONSOLIDATION-FINAL-REPORT.md    (15 KB) گزارش تجمیع
├── 📄 CLEANUP-NOTES.md                 یادداشت پاکسازی
├── 📄 FINAL-STATUS.md                  (370 خط) وضعیت نهایی
│
├── 📊 01-BUSINESS/                     (7 فایل) منطق کسب‌وکار
│   ├── network-commission-system.md
│   ├── discount-shop-business.md
│   ├── package-purchase-system.md
│   ├── daya-loan-integration.md
│   ├── balance-calculation-rules.md
│   ├── binary-tree-guide.md
│   └── manual-payment-system.md
│
├── 🏗️ 02-ARCHITECTURE/                 (1 فایل) معماری
│   └── README.md                       (Roadmap)
│
├── ⚙️ 03-BACKEND/                       (3 زیرپوشه)
│   │
│   ├── CMS/                            (9 فایل .md + docs/)
│   │   ├── README.md
│   │   ├── implementation-status.md    (3,059 خط)
│   │   ├── entity-guide.md
│   │   ├── api-coverage.md
│   │   ├── email-sms-configuration.md
│   │   ├── payment-gateway.md
│   │   ├── migration-network-parent-guide.md
│   │   ├── payment-architecture-pyms.md
│   │   └── docs/                       (7 فایل)
│   │       ├── README.md
│   │       ├── model.ndm2              (2.4 MB)
│   │       ├── model1.ndm2             (2.2 MB)
│   │       ├── network_crm_calculate.txt (28 KB)
│   │       └── update-pool-percent.sql (2 KB)
│   │
│   ├── BackOffice.BFF/                 (4 فایل .md + docs/)
│   │   ├── README.md
│   │   ├── handlers-status.md
│   │   ├── cms-integration.md
│   │   ├── discount-shop-integration.md
│   │   └── docs/                       (2 فایل)
│   │       ├── README.md
│   │       └── model.ndm2
│   │
│   └── FrontOffice.BFF/                (2 فایل .md + docs/)
│       ├── README.md
│       ├── protobuf-mismatch.md
│       └── docs/                       (3 فایل)
│           ├── README.md
│           ├── model.ndm2
│           └── CMS.sql
│
├── 🎨 04-FRONTEND/                      (2 زیرپوشه)
│   │
│   ├── BackOffice/                     (2 فایل)
│   │   ├── README.md
│   │   └── ui-status.md
│   │
│   └── FrontOffice/                    (5 فایل)
│       ├── README.md
│       ├── gap-analysis.md
│       ├── todo-commented-code.md
│       ├── progress-report.md
│       └── mudblazor-reference.md      (6,270 خط!)
│
├── ✅ 05-TASKS/                         (3 فایل)
│   ├── CURRENT-SPRINT.md               🔥 (21 task)
│   ├── BACKLOG.md
│   └── verification-template.md
│
├── 🚀 06-DEPLOYMENT/                    (2 فایل)
│   ├── quick-start.md
│   └── delivery-readiness.md
│
└── 📦 99-ARCHIVE/                       (15 فایل)
    ├── ARCHIVE-INDEX.md
    ├── REMAINING-TASKS-OLD-2024-12-02.md
    ├── network-club-commission-system-OLD.md
    ├── implementation-progress-fa-OLD.md
    ├── monitoring-alerts-partial-OLD.md
    ├── BACKOFFICE-UI-STATUS-OLD.md
    ├── BUSINESS-VERIFICATION-TEMPLATE-OLD.md
    ├── CMS-API-COVERAGE-OLD.md
    ├── QUICK-START-DEVELOPMENT-OLD.md
    ├── DELIVERY-READINESS-REPORT-OLD.md
    ├── REMAINING-TASKS-CONSOLIDATED-OLD.md
    ├── INDEX-OLD-v1.0.md
    ├── ANALYSIS-CONTRADICTIONS-AND-ISSUES.md
    ├── ENTITY-NAMING-REFACTORING-PLAN.md
    └── monitoring-alerts-consolidated-report.md

📊 آمار

فایل‌ها:

نوع تعداد
فایل‌های .md در Root 7
فایل‌های .md فعال 42
فایل‌های .md آرشیو 15
فایل‌های docs (غیر md) 7
جمع کل 71 فایل

پوشه‌ها:

پوشه زیرپوشه فایل‌ها
01-BUSINESS - 7
02-ARCHITECTURE - 1
03-BACKEND 3 18 (.md) + 7 (docs)
04-FRONTEND 2 7
05-TASKS - 3
06-DEPLOYMENT - 2
99-ARCHIVE - 15

🎯 فایل‌های کلیدی

برای شروع:

  1. 00-INDEX.md - نقطه شروع اصلی
  2. README.md - راهنمای سریع
  3. QUICK-REFERENCE.md - مرجع فوری

برای Development:

  1. 05-TASKS/CURRENT-SPRINT.md 🔥 - کارهای جاری
  2. 04-FRONTEND/FrontOffice/todo-commented-code.md - TODO ها
  3. 03-BACKEND/FrontOffice.BFF/protobuf-mismatch.md - مشکلات

برای گزارش:

  1. FINAL-STATUS.md - وضعیت نهایی پروژه
  2. CONSOLIDATION-FINAL-REPORT.md - گزارش تجمیع
  3. CLEANUP-NOTES.md - یادداشت پاکسازی

🗂️ راهنمای Navigation

بر اساس نقش:

Business Analyst:

cd 01-BUSINESS/
ls -l

Backend Developer:

cd 03-BACKEND/CMS/
cat implementation-status.md

Frontend Developer:

cd 04-FRONTEND/FrontOffice/
cat gap-analysis.md

Project Manager:

cat 05-TASKS/CURRENT-SPRINT.md
cat 06-DEPLOYMENT/delivery-readiness.md

DevOps:

cat 06-DEPLOYMENT/quick-start.md
ls 03-BACKEND/CMS/docs/  # Database models

📝 قوانین نگهداری

افزودن فایل جدید:

  1. تعیین دسته‌بندی (01-06)
  2. قرار دادن در پوشه مناسب
  3. بروزرسانی INDEX

آرشیو کردن:

  1. انتقال به 99-ARCHIVE/
  2. افزودن به ARCHIVE-INDEX.md
  3. ذکر دلیل و جایگزین

بروزرسانی:

  1. ویرایش فایل مربوطه
  2. بروزرسانی تاریخ
  3. Commit با پیام واضح

چک‌لیست کیفیت

  • سازماندهی: 7 پوشه منطقی
  • تمیزی: هیچ فایل اضافی در Root
  • مستندسازی: README برای هر بخش
  • لینک‌ها: INDEX کامل با لینک‌ها
  • آرشیو: 15 فایل با توضیحات
  • docs: فایل‌های طراحی سازماندهی شده

تاریخ ایجاد: ۱۴ آذر ۱۴۰۴
کیفیت: (5/5)
وضعیت: Production Ready