/
/
/
/
Internal Implementation Notes شامل نکات فنی و جزئیات پیاده‌سازی داخلی Provider است که برای توسعه‌دهندگان و افراد فنی مورد استفاده قرار می‌گیرد. این بخش مربوط به رفتارهای داخلی سیستم است و ممکن است با تغییر نسخه یا معماری داخلی GraphBPMS تغییر کند.
محتوای پیشرفته / فنی
این صفحه برای کاربران عمومی طراحی نشده است و اطلاعات آن باید فقط توسط تیم‌های فنی و توسعه‌دهندگان استفاده شود.
Internal Implementation Notes چیست؟
در کنار استفاده معمول از Provider، برخی جزئیات مربوط به نحوه پیاده‌سازی داخلی، ارتباط بین اجزای سیستم و رفتارهای وابسته به Runtime وجود دارند که برای توسعه و نگهداری سیستم اهمیت دارند.
این اطلاعات باید جدا از راهنمای عمومی Provider نگهداری شوند تا کاربران هنگام انجام کارهای روزمره با جزئیات غیرضروری مواجه نشوند.
موارد قابل ثبت در Internal Notes
| موضوع | توضیح |
|---|---|
| رفتار داخلی اجرا | جزئیات مربوط به نحوه پردازش داخلی Provider |
| وابستگی نسخه‌ای | مواردی که ممکن است در Buildهای مختلف تغییر کنند |
| Transport داخلی | نحوه انتقال داخلی اطلاعات بین بخش‌های سیستم |
| Helperهای داخلی | اجزای داخلی مورد استفاده در فرآیند اجرا |
مرز اطلاعات عمومی و Internal Notes
اطلاعات عمومی باید به کاربر کمک کند Provider را ایجاد، تنظیم و استفاده کند. در مقابل، Internal Notes برای درک معماری داخلی و نگهداری سیستم استفاده می‌شود.
Wiki عمومی
↓
Advanced / Technical Notes
↓
Implementation Details
برچسب‌گذاری محتوای پیشرفته
برای جلوگیری از اشتباه در استفاده از اطلاعات داخلی، این محتوا باید با برچسب‌های مشخص نمایش داده شود.
برچسب‌های پیشنهادی
- پیشرفته
- فنی
- وابسته به نسخه
- وابسته به استقرار
مواردی که نباید در این بخش قرار گیرند
- اطلاعاتی که برای کاربر عادی در ایجاد یا استفاده از Provider لازم نیست.
- رفتارهای تأییدنشده یا حدس‌زده‌شده درباره Runtime.
- API یا Helper داخلی که به‌عنوان قرارداد رسمی معرفی نشده است.
- اطلاعات حساس محیط‌های واقعی.
نکات نگهداری Internal Notes
- هر رفتار وابسته به نسخه با برچسب مشخص شود.
- تغییرات معماری داخلی در این بخش ثبت شوند.
- اطلاعات عمومی و فنی از یکدیگر جدا نگه داشته شوند.
- قبل از انتشار، محتوای داخلی توسط تیم فنی تأیید شود.
Warning
جزئیات Internal Implementation نباید به‌عنوان قابلیت رسمی یا API عمومی GraphBPMS معرفی شود. این اطلاعات صرفاً برای نگهداری و توسعه داخلی سیستم است.