معيار البرمجة
أعراف كتابة المشاهد والأتمتة ومنطق البوابات بطريقة تظل قابلة للصيانة بعد سنوات.
أهم النقاط
- أعراف موحّدة عبر كل عائلات وحدات التحكم
- كل أتمتة يجب أن تحمل تعليقًا
- التحكم في الإصدارات إلزامي لإعدادات البوابات
- قيم افتراضية آمنة لكل مشغّل
الغرض
جعل كل إعدادات Smart Citizens مفهومة لأي مهندس دون معرفة قبلية.
النطاق
كل المشاهد والأتمتة وقواعد البوابات ولوحات العرض التي تسلّمها Smart Citizens.
مبادئ التصميم
مبدأ 1
القراءة أولًا — الوضوح قبل الذكاء
مبدأ 2
الحتمية — نفس المُطلق يعطي نفس النتيجة
مبدأ 3
الأمان الافتراضي — يعود المشغّل إلى حالة معرّفة عند الخطأ
مبدأ 4
قابلية العكس — كل أتمتة يمكن تعطيلها بنقرة
المتطلبات الهندسية
المتطلبات الهندسية
- الإعداد في مستودع Git خاص بكل موقع
- ترقيم دلالي لكل حزمة إعداد
- تعليقات على كل أتمتة تصف الغاية والمالك
- لا كلمات سر ثابتة في الشيفرة
- كل مشهد يملك نسخة تراجع موثّقة
أفضل الممارسات
التسمية
التسمية: فعل-اسم ('خفت الصالة إلى 30%')
التجميع
التجميع: تجميع الأتمتة حسب النظام لا الغرفة
الاختبار
الاختبار: كل أتمتة تمرّ باختبار جاف
المراجعة
المراجعة: كل دمج يتطلب مراجعة مهندس آخر
سير عمل التركيب
سير عمل التركيب
How it works
1. إعداد المستودع
استنساخ قالب الموقع وضبط المتغيرات.
2. المشاهد الأساسية
استيراد مكتبة المشاهد القياسية وترجمة الأسماء.
سير عمل الإعداد والبرمجة
سير عمل الإعداد والبرمجة
How it works
1. الكتابة
كتابة المشاهد والأتمتة وفق قواعد التسمية.
2. التعليق
إضافة الغاية والمالك والتاريخ في رأس كل أتمتة.
3. مراجعة النظير
مراجعة مهندس ثانٍ واعتماد طلب الدمج.
4. النشر
توسيم الحزمة وتوقيعها ونشرها على وحدة التحكم.
5. التحقق
مطابقة المجموع الاختباري على الوحدة مع الوسم.
خطوات التشغيل والاستلام
خطوات التشغيل والاستلام
How it works
1. اختبار جاف
تشغيل كل أتمتة جديدة يدويًا للتأكد من السلوك.
2. مراقبة سكون
مراقبة النظام 30 دقيقة بحثًا عن مطلقات غير مقصودة.
3. اختبار التراجع
الرجوع إلى الوسم السابق والتحقق من الحالة.
قائمة التحقق الفنية
قائمة التحقق الفنية
- كل الإعدادات في نظام إصدارات
- كل أتمتة تحمل رأس تعليق
- وسم تراجع موجود وموثّق
- لا كلمات سر ثابتة في الحزمة
- أتمتة بلا تعليق
- التعديل مباشرة على وحدة التحكم
- رموز API ثابتة
- الدمج دون مراجعة
قائمة ضمان الجودة
تدقيق التسمية
20% عشوائية من المشاهد تطابق الأعراف.
تغطية التعليقات
100% من الأتمتة لديها رأس تعليق.
اختبار التراجع
تم تنفيذ اختبار تراجع مرة على الأقل.
معايير القبول
| Feature | المستهدف | طريقة التحقق | الأولوية |
|---|---|---|---|
حزمة تحت الإصدارات | 100% | سجل Git | عالٍ |
مراجعة نظير | 100% من الدمجات | سجل المستودع | عالٍ |
اختبار تراجع | مرة لكل موقع | تقرير التشغيل | متوسط |
مصفوفة المخاطر
| Feature | الاحتمال | الأثر | إجراء التخفيف |
|---|---|---|---|
إصلاح عاجل دون مراجعة | متوسط | عالٍ | الدمج الطارئ يتطلب مراجعة خلال 24 ساعة |
تسريب سر في المستودع | منخفض | عالٍ | فحص أسرار قبل الدفع وحقن الأسرار عند النشر |
أخطاء شائعة واستكشاف الأعطال
استكشاف الأعطال
How it works
إطلاق غير متوقع
ابحث في المستودع عن أتمتة مرتبطة بشروط متقاطعة.
فشل التراجع
تأكد من وجود الوسم السابق ومن أن الإصدار على وحدة التحكم يقبل الوسم.
متطلبات التوثيق
متطلبات التوثيق
- ملف README للموقع
- دليل المشاهد
- فهرس الأتمتة
- دليل التراجع
الجدول الزمني للصيانة
الجدول الزمني للصيانة
How it works
شهريًا
مراجعة عدّادات إطلاق الأتمتة وإيقاف غير المستخدمة.
ربع سنوي
تدوير الأسرار ومفاتيح النشر.
الإصدار وسجل التغييرات
الإصدار 1.0
حالة الاعتماد: معتمَد · تاريخ النفاذ: 2026-01-15 · تاريخ آخر مراجعة: 2026-07-08
أعدّه / راجعه
أعدّه: Smart Citizens Engineering · راجعه: Dr. Ashraf Nouri
سجل التغييرات
v1.0 — 2026-07-08
Initial published edition. (Smart Citizens Engineering)
الأسئلة الشائعة
الأسئلة الشائعة
أي نظام إصدارات؟
Git على منظمة GitHub الهندسية لـ Smart Citizens، مستودع خاص لكل موقع.
كيف تُدار الأسرار؟
في خزينة Smart Citizens وتُحقن عند النشر، ولا تُودَع في المستودع.
Smart Citizens Engineering. "معيار البرمجة." Smart Citizens, 2026-01-15. https://ai.smartcitizens.ae/ar/standards/programming-standard.
Smart Citizens Engineering (2026). معيار البرمجة. Smart Citizens. Retrieved 2026-07-23, from https://ai.smartcitizens.ae/ar/standards/programming-standard
ابدأ خطتك الذكية مع Smart Citizens
تحدث مع مهندسي Smart Citizens للحصول على تصميم مخصص، تقدير ميزانية، وخارطة طريق للتشغيل.