پلتفرم
Platform Documentation
این بخش شامل معماری کلان سیستم، استانداردهای مهندسی، دیاگرامهای معماری و قراردادهای سطح پلتفرم است. مستندات اینجا متعلق به یک تیم خاص نیست — مرجع رسمی تصمیمات و قواعد فراتیمی هستند.
معماری سیستم
| سند | توضیح |
|---|---|
| معماری پروژه | معماری Monorepo، لایهها، سرویسها و اصول معماری |
استانداردهای مهندسی
عمومی
| سند | توضیح |
|---|---|
| استایل گاید | نمای کلی تمام استانداردها — راهنمای یکپارچه |
| خط مشی زبان | زبان رسمی کد، موارد مجاز فارسی، ممنوعیتها |
| قراردادهای نامگذاری | فایلها، دیتابیس، env vars، Docker، NATS، API |
| ساختار مخزن | ساختار استاندارد سرویس، monorepo |
| نسخهبندی | Semantic Versioning، پیشانتشار، تگگذاری |
| امنیت | رازها، parameterized queries، JWT، cookies |
مستندات و ارتباطات
| سند | توضیح |
|---|---|
| مستندات سرویس | فایلهای اجباری docs/، قوانین بهروزرسانی |
| الگوی README | ساختار اجباری README.md |
| تغییرات (CHANGELOG) | ساختار Keep a Changelog |
قراردادهای API و رویداد
| سند | توضیح |
|---|---|
| استاندارد رویداد | استاندارد رسمی طراحی و انتشار رویدادها در NATS |
| قرارداد رویداد | پوسته استاندارد NATS، فیلدها، versioning payload |
توسعه و کیفیت
| سند | توضیح |
|---|---|
| تست | واحد و یکپارچه، CI، پوشش، قوانین |
| استاندارد لاگنویسی | JSON ساختاریافته، سطوح، قوانین PII |
| تعریف انجام شده (DoD) | چکلیست کامل پذیرش Feature/PR |
چرخه عمر سرویس
| سند | توضیح |
|---|---|
| بلوپرینت | الزامات پیش از توسعه، تأیید تیمی |
| دمو (پیشنمایش) | HTML/CSS ساده، قوانین فنی |
| گیت | فرمت کامیت، برنچ، workflow، PR |
دیاگرامهای معماری
| سند | توضیح |
|---|---|
| جریان کلی | معماری سطح بالا — ارتباط کانتینرها و لایهها |
| جریان رویدادها | معماری رویدادمحور با NATS JetStream |
سرویسهای جدید
| سند | توضیح |
|---|---|
| درگاه ورودی (gateway) | درگاه API Gateway واحد، مسیریابی و امنیت لبه پلتفرم |
| سرویس ارز (currency-service) | تنها مرجع نرخ ارز و تبدیل مبلغ در پلتفرم |
| سرویس تسویه (settlement-service) | کمیسیون، تسویه فروشنده و مدیریت refund |
مخاطبان این مستندات
- معماران سیستم (System Architects)
- توسعهدهندگان تمام تیمها
- مهندسان پلتفرم (Platform Engineers)
- رهبران فنی (Technical Leads)