التحقق
فحوص النموذج
شغّل 75 فحصًا قائمًا على القواعد ومجموعات القواعد الخاصة بك على النموذج كله، وضيّق النتائج حسب الخطورة والفئة والقاعدة والتسمية، وأصلحها في مكانها، وتجاهل المقصود منها، وحدّد مدى صرامة كل قاعدة.
في هذه الصفحة
نظرة عامة
يشغّل التحقق ← فحوص النموذج فهرسًا من القواعد على كل عنصر في المشروع ويسرد ما تجده كل قاعدة. وتبحث القواعد عن الثغرات التي تجعل النموذج صعب الثقة أو المراجعة: الأسماء والأرقام المفقودة، والعناصر المنعزلة، والإجراءات التي لا يؤديها أحد، والواجهات التي لا تحمل شيئًا، والمتطلبات غير المخصصة أو غير المتحقق منها، والمخاطر دون خطة معالجة، والمقاييس التي لا تبلغ عتبتها.
تعمل الفحوص مجددًا كلما تغيّر النموذج، لذا تتفق دائمًا الصفحة والبطاقة فحوص النموذج في الرئيسية والشارة على التحقق.
المفاهيم
- القاعدة: فحص واحد له رقم (مثلًا Requirement.10)، وعنوان يسمّي ما يجده، وبيان لما يبدو عليه النموذج الجيد، وإصلاح. وتُجمَّع القواعد حسب الفئة التي تفحصها: Global (كل عنصر)، وAction، وAsset، وConduit، وInput/Output، وRequirement، وRisk، وTest Case، وMeasure.
- النتيجة: عنصر واحد يخالف قاعدة واحدة. ويمكن أن تسمّي النتيجة عناصر مرتبطة، مثل الأسماء المكررة أو أبناء أصل.
- الخطورة: تبلّغ كل قاعدة بوصفها خطأ أو تحذير، أو تُضبط على تجاهل فلا تعمل. والافتراضي هو Warning، باستثناء قاعدتي LML 2.0 Global.10 وGlobal.11 في مشروع تسبق نسخة مخططه الهيكلي LML 2.0 (انظر القواعد).
- النتيجة المتجاهَلة: نتيجة قبلتها لعنصر واحد. فلم تعد تُحتسب، ويسردها إظهار المتجاهَل مع استعادة.
- الفحص المنطبق: قاعدة عملت على عنصر واحد على الأقل من فئتها. ويعدّ سطر الرأس كم فحصًا منطبقًا ليست له نتيجة.
- مجموعة القواعد: مجموعة مسمّاة من قواعدك الخاصة، مخزنة في المشروع وتُفعَّل أو تُوقف ككل. وتعمل قواعدها مع الفحوص المدمجة، وتستخدم نتائجها القائمة نفسها و«إصلاح» و«تجاهل». انظر مجموعات القواعد.
طريقة استخدامها
شغّل الفحوص قبل كل مراجعة، وبعد استيراد كبير، وكلما عرضت الرئيسية أخطاء فحص النموذج. فهي تجيب عن سؤال واحد: ما الذي يحتاج إلى انتباه في النموذج قبل أن يقرأه شخص آخر؟
العمل على النتائج
- افتح التحقق ← فحوص النموذج. يعرض سطر الرأس مثلًا “84% من الفحوص المنطبقة ناجحة”، يليه عدد الأخطاء والتحذيرات والتغيّر منذ آخر تشغيل.
- القائمة مجمّعة حسب القاعدة، والأخطاء أولًا. انقر عنوان قاعدة لفتحها؛ ويشرح وصفها سبب أهمية القاعدة.
- لكل نتيجة، انقر إصلاح. يعرض مربع حوار الإصلاح العنصر والقاعدة والإصلاح المقترح: حقلًا لملئه، أو علاقات لإضافتها، أو مكررات لدمجها، أو زرًا يفتح العنصر أو مخططه.
- احفظ الإصلاح. فتختفي النتيجة وتتحدث الأعداد.
- عندما تكون النتيجة مقصودة (مثلًا إجراء مُعاد استخدامه تحت أصلين)، انقر تجاهل.
التركيز على مجال واحد
- في الأوجه على اليمين، حدّد الأخطاء تحت الخطورة لرؤية الأخطاء فقط.
- حدّد فئة تحت الفئة (فئة العنصر صاحب النتيجة)، أو قاعدة تحت القاعدة أو تسمية تحت التسمية. وتُجمع التحديدات في وجه واحد بـ OR؛ وتُجمع الأوجه بـ AND. وتعرض كل قيمة عدد نتائجها.
- اكتب في تصفية النتائج لمطابقة اسم عنصر أو عنوان قاعدة.
- انقر مسح الأوجه لإظهار كل شيء مجددًا.
مراجعة نتائج عنصر واحد معًا
- اختر التجميع حسب الكيان بجوار عامل التصفية.
- يُسرد كل عنصر مرة واحدة مع كل نتائجه، بترتيب الأرقام. ويعرض العنصر الذي فيه خطأ الشارة خطأ في عنوانه.
مثال عملي: المشروع التوضيحي CubeSat EO-1
- افتح المشروع التوضيحي CubeSat EO-1 وانتقل إلى التحقق ← فحوص النموذج.
- حدّد Requirement تحت الفئة. وتُظهر القواعد المتبقية أي المتطلبات ليس لها أصل، أو تخصيص (Requirement.8)، أو حالة اختبار تتحقق منها (Requirement.10).
- افتح Requirement.10، وانقر إصلاح على نتيجة، واربط حالة الاختبار التي تتحقق منها. فتغادر النتيجة القائمة، ويرتفع سطر الرأس.
- اختر التجميع حسب الكيان لرؤية كل النتائج المتبقية لمتطلب واحد دفعة واحدة.
كتابة قاعدة خاصة بك
- انقر مجموعات القواعد… في رأس الصفحة، ثم + مجموعة قواعد جديدة. سمِّ المجموعة، مثلًا “قواعد البرنامج”، وانقر موافق.
- تحت المجموعة، انقر + إضافة قاعدة. يفتح محرر القواعد بالمعرّف R1.
- اكتب الاسم الذي يذكر ما تجده القاعدة، مثلًا “متطلبات بلا حالة اختبار تتحقق منها”.
- في ينطبق على، اختر Requirement.
- في الإبلاغ عن عنصر عندما، اختر علاقة مفقودة، ثم اختر verified by في العلاقة.
- اضبط الخطورة على خطأ واكتب الرسالة، مثلًا “اربط حالة الاختبار التي تتحقق من المتطلب.”
- اقرأ المعاينة تحت الحقول، مثلًا “يبلّغ الآن عن 3 عناصر: SYS-2 Top Speed، …”. انقر حفظ.
- انقر إغلاق. تظهر نتائج القاعدة في القائمة تحت R1، والأخطاء أولًا. انقر إصلاح لربط حالة اختبار؛ فتغادر النتيجة القائمة.
فحص ميزانية كتلة بالوحدات
- في المشروع التوضيحي CubeSat EO-1، افتح مجموعات القواعد…، وانقر + مجموعة قواعد جديدة وسمّها “ميزانية الكتلة”.
- انقر + إضافة قاعدة. سمّها “تجميعات تتجاوز مخصص كتلتها” واختر Asset في ينطبق على.
- في الإبلاغ عن عنصر عندما، اختر مجموع القيم المرتبطة مقارنةً بقيمة. اضبط الدالة على المجموع، والعلاقة على decomposed by، وقيمة كل عنصر مرتبط على Mass، والمقارنة على أكبر من، والمقارنة مع على Mass Allocation.
- اضبط الخطورة على خطأ وانقر حفظ، ثم إغلاق.
- يُسرد التجميع الذي تزن أجزاؤه أكثر من مخصصه، مثلًا “إجمالي Mass لـ “decomposed by” وقدره 2.34 kg أكبر من Mass Allocation وقدره 1.35 kg”. وتُجمع الكتل بالغرامات والكيلوغرامات معًا؛ أما الكتلة المُدخلة بالأمتار فتُسرد بالرسالة “لا يمكن جمع الكتلة والطول: الأبعاد مختلفة (kg مقابل m).”
مشاركة القواعد مع مشروع آخر
- في مجموعات القواعد…، انقر تصدير بجوار المجموعة. فيُنزَّل ملف باسم مثل
program-rules.holarch-rules.json. - في المشروع الآخر، افتح مجموعات القواعد…، وانقر استيراد…، ثم اختيار ملف… (أو الصق نص الملف) وانقر استيراد.
- للمشاركة عبر مكتبة، احتفظ بمجموعات القواعد في مشروع المكتبة وانشر إصدارًا. وفي مشروع يستخدم المكتبة، انقر من المكتبة…، وحدّد المجموعات وانقر نسخ.
- عندما تنشر المكتبة إصدارًا أحدث يحتوي على المجموعة، يعرض مجموعات القواعد… الرسالة “يتوفر إصدار أحدث” بجوار النسخة. انقر تحديث…، وراجع التغييرات، واختر الاحتفاظ بنسختي أو اعتماد نسخة المكتبة لكل قاعدة تغيّرت في الموضعين، وانقر تحديث. وتُحفظ تعديلاتك الأخرى على النسخة.
نصائح
- اضبط القواعد التي يعدّها فريقك مانعة على خطأ في الإعدادات، لتسردها الرئيسية بوصفها مشكلات.
- لا تتجاهل نتيجة إلا إذا كانت مقصودة، واذكر السبب في وصف العنصر أو في تعليق. ويتيح إظهار المتجاهَل للمراجعين رؤية ما قُبل.
- عادةً ما تُصلح أسرع قائمةٌ طويلة من نتائج التسمية بعد استيراد بتحرير الأسماء في قاعدة البيانات.
- شغّل الفحوص قبل حفظ خط أساس، كي لا يحمل خط الأساس ثغرات معروفة.
الصفحة
ترويسة الصفحة
| عنصر التحكم | ما الذي يفعله |
|---|---|
| تصدير… | يفتح مربع حوار التصدير مع Findings (CSV): كل نتيجة غير متجاهَلة، مع القاعدة والخطورة والعنوان ومعرّف العنصر والرقم والاسم والفئة والملاحظة والعناصر المرتبطة. |
| الإعدادات | يضبط خطورة كل قاعدة وعدد الأبناء لكل مستوى (انظر الإعدادات). |
| ↻ تشغيل الفحوص | يشغّل كل فحص مجددًا ويسجّل الأعداد بوصفها آخر تشغيل. |
سطر الرأس
- “N% من الفحوص المنطبقة ناجحة”: أحمر عندما تكون أي نتيجة خطأً، وكهرماني عندما لا توجد إلا تحذيرات، وأخضر عندما لا يوجد ما يُصلَح.
- عدد النتائج والأخطاء والتحذيرات.
- التغيّر منذ آخر تشغيل على هذا الجهاز، مثلًا “3 نتائج أقل من آخر تشغيل.” ويُسجَّل آخر تشغيل عندما تفتح الصفحة أو تغادرها وعندما تنقر ↻ تشغيل الفحوص. وتقول الزيارة الأولى “أول تشغيل على هذا الجهاز.”
في المشروع الكبير تعمل الفحوص في الخلفية، فتبقى الصفحة قابلة للاستخدام: تعرض الزيارة الأولى “جارٍ تشغيل فحوص النموذج…”، وتعرض الزيارات اللاحقة النتائج السابقة إلى أن تجهز الجديدة، وتعرض بطاقة تقدم أي تشغيل يستغرق أكثر من ثانية.
شريط الأدوات
- التجميع حسب القاعدة (الافتراضي) أو التجميع حسب الكيان. ويُتذكَّر الاختيار على هذا الجهاز.
- تصفية النتائج: تطابق أسماء العناصر وأرقام القواعد وعناوينها.
- يفتح توسيع الكل وطي الكل كل المجموعات أو يغلقانها.
الأوجه
| الوجه | القيم |
|---|---|
| الخطورة | الأخطاء، التحذيرات |
| الفئة | فئة كل عنصر له نتيجة |
| القاعدة | كل قاعدة لها نتيجة، حسب الرقم والعنوان |
| التسمية | كل تسمية على عنصر له نتيجة |
| المتجاهَلة | يضيف إظهار المتجاهَل النتائج المتجاهَلة إلى القائمة، معلَّمة بـ «متجاهَلة»، مع استعادة |
تتبع الأعداد الأوجه الأخرى وعامل التصفية، فتعرض ما سيبقى إذا حددت قيمة.
النتائج
تعرض كل نتيجة العنصر (أو القاعدة، عند التجميع حسب الكيان)، والملاحظة (مثلًا “كلمات مبهمة: adequate، TBD” أو “14 ابنًا”)، والعناصر المرتبطة، والزرين إصلاح وتجاهل، أو استعادة للنتيجة المتجاهَلة. ويُلغي تراجع واحد عملية التجاهل أو الاستعادة.
الإصلاحات
| الإصلاح | تستخدمه | ما الذي يفعله |
|---|---|---|
| تحرير حقل | الاسم أو الرقم أو الوصف المفقود؛ فحوص الفعل والاسم | يفتح الحقل بالقيمة الحالية. |
| تكبير الحرف الأول | الأسماء بأحرف صغيرة | يقترح الاسم بحرف أول كبير. |
| إضافة علاقات | الأصل أو المؤدي أو المدخلات أو المخرجات أو القنوات أو المعايير أو التتبعات المفقودة | يسرد العناصر التي يسمح بها المخطط الهيكلي للعلاقة؛ حدّدها وانقر إضافة علاقات. |
| دمج | الأسماء المتشابهة، والأبناء المنفردون | يحتفظ بعنصر واحد، وينقل إليه كل علاقات العناصر الأخرى، ويجمع الأوصاف ويحذف العناصر الأخرى (ويُلغي تراجع واحد ذلك كله). |
| حذف المرتبط | الإجراءات ذات مُدخل يُنتَج بعد استخدامه | يحذف عناصر Input/Output التي تُستهلك قبل وجودها. |
| إضافة traced to | متطلبات تذكر كيانات غير مرتبطة | يضيف traced to من المتطلب إلى كل عنصر يسمّيه نصه. |
| إنشاء مشكلة | حالات الاختبار الفاشلة دون مشكلة مرتبطة | ينشئ Issue مرتبطة بحالة الاختبار والمتطلبات التي تتحقق منها. |
| الفتح | قوائم الأبناء الطويلة، والتبادلات، والمعايير، والعتبات، والعلاقات التي لا يسمح بها المخطط الهيكلي | يفتح العنصر أو مخططه. |
| فتح عرض UAF | عروض UAF التي لا يمكن عرضها | يسرد عروض الجذر مع مشكلاتها ويفتح أولها. |
الإعدادات
- الأبناء لكل مستوى: تبلّغ Action.9 وAsset.9 عن أصل له أبناء أكثر من هذا الرقم. والافتراضي 9، من الإرشاد القائل إن الناس يتعاملون مع نحو 7 ± 2 عناصر في المستوى الواحد. والقيم المسموح بها من 2 إلى 99؛ وتعرض أي قيمة أخرى “يجب أن يكون عدد الأبناء لكل مستوى عددًا صحيحًا من 2 إلى 99.”
- الخطورة لكل قاعدة: Error أو Warning أو Ignore. والقاعدة المتجاهَلة لا تعمل.
- يعيد استعادة الإعدادات الافتراضية كل قاعدة إلى قيمتها الافتراضية (Warning؛ وRequirement.11 على Ignore؛ وGlobal.10 وGlobal.11 على Ignore في مشروع تسبق نسخة مخططه الهيكلي LML 2.0) ويعيد الأبناء لكل مستوى إلى 9.
تُخزَّن الإعدادات في المشروع، وتُشارك مع كل من فيه، ويمكن التراجع عنها.
مجموعات القواعد
يفتح مجموعات القواعد… في رأس الصفحة مربع الحوار مجموعات القواعد. وتعمل قواعدك الخاصة في فحوص النموذج مع الفحوص المدمجة: تعرض نتائجها معرّف القاعدة (مثلًا R1) واسمها، وتُحتسب في سطر الرأس، وتظهر تحت القاعدة في الأوجه، وتستخدم إصلاح وتجاهل وتصدير… مثل أي نتيجة. وتُخزَّن مجموعات القواعد في المشروع، وتُشارك مع كل من فيه، وكل تغيير خطوة تراجع واحدة.
مربع الحوار مجموعات القواعد
| عنصر التحكم | ما الذي يفعله |
|---|---|
| + مجموعة قواعد جديدة | يطلب اسمًا ويضيف مجموعة فارغة مفعّلة. |
| استيراد… | يضيف مجموعات القواعد من ملف مجموعة قواعد: اختيار ملف… أو الصق نصه، ثم استيراد. وتُفحص كل قاعدة أولًا؛ ويُرفض الملف الذي فيه مشكلة وتُسرد المشكلات. ويُضاف “ (2)” إلى الاسم المستخدم من قبل. |
| من المكتبة… | يسرد مجموعات القواعد في إصدارات المكتبات التي يستخدمها هذا المشروع؛ حدّدها وانقر نسخ. وتتذكر النسخة مكتبتها وإصدارها. |
| تحديث… | بجوار مجموعة منسوخة عندما تنشر مكتبتها إصدارًا أحدث يحتوي على المجموعة (“يتوفر إصدار أحدث”). يعاين القواعد المضافة والمعدّلة والمحذوفة في المكتبة، والتعديلات التي أجريتها والمحفوظة، والقواعد التي تغيّرت هنا وفي المكتبة معًا؛ اختر الاحتفاظ بنسختي أو اعتماد نسخة المكتبة لكل منها، ثم انقر تحديث. ويُلغي تراجع واحد ذلك كله. |
| مربع الاختيار بجوار المجموعة | يفعّل المجموعة أو يوقفها. والمجموعة الموقوفة لا تعمل. |
| إعادة التسمية… | يعيد تسمية المجموعة. |
| تصدير | ينزّل المجموعة بوصفها ملف مجموعة قواعد JSON. |
| حذف | يحذف المجموعة وقواعدها بعد تأكيد. ويستعيدها التراجع. |
| + إضافة قاعدة، تحرير، حذف | أضف قاعدة إلى المجموعة، أو غيّرها، أو احذفها. |
القاعدة التي لا يمكن تشغيلها في هذا المشروع، مثل قاعدة تسمّي فئة أو علاقة لا يحتويها المخطط الهيكلي، تعرض المشكلة بالأحمر تحت اسمها ولا تبلّغ عن شيء.
محرر القواعد
| الحقل | ما يضبطه |
|---|---|
| الاسم | عنوان نتائج القاعدة: ما تجده القاعدة. |
| المعرّف | قصير وفريد في المجموعة، مثلًا R1 أو SYS-NUM؛ حتى 40 حرفًا أو رقمًا أو نقطة أو شرطة أو شرطة سفلية. |
| ينطبق على | أي عنصر، أو فئة (بما فيها الفئات الفرعية: Test Case هو أيضًا Action)، أو في مشروع SysML v2 نوع نموذج مثل Part أو Requirement. |
| العناصر المطابقة فقط | اختياري: عامل تصفية بلغة تصفية قاعدة البيانات يضيّق العناصر أولًا، مثلًا is:leaf. |
| الإبلاغ عن عنصر عندما | الشرط، أدناه. |
| الخطورة | خطأ أو تحذير. |
| الرسالة | الإصلاح المطلوب، ويظهر في مربع حوار الإصلاح. |
يذكر السطر تحت الحقول عدد العناصر التي تبلّغ عنها القاعدة الآن ويسمّي أول خمسة منها.
| الشرط | الحقول | يبلّغ عن عنصر عندما |
|---|---|---|
| سمة فارغة | السمة | لا قيمة للسمة. |
| سمة تطابق نمطًا | السمة، النمط، تجاهل حالة الأحرف | يحتوي نص السمة على تطابق مع النمط، وهو تعبير نمطي. |
| سمة لا تطابق نمطًا | السمة، النمط، تجاهل حالة الأحرف | لا يحتوي نص السمة على تطابق، مثلًا ^SYS-\d+$ للأرقام التي يجب أن تبدأ بـ SYS-. |
| علاقة مفقودة | العلاقة، لعناصر من | ليس للعنصر رابط من تلك العلاقة (إلى عناصر من تلك الفئة). |
| علاقة موجودة | العلاقة، لعناصر من | للعنصر رابط من هذا النوع. |
| عدد العناصر المرتبطة N على الأقل | العلاقة، لعناصر من، N | للعنصر N عنصرًا مرتبطًا أو أكثر، مثلًا أكثر من 9 أبناء. |
| عدد العناصر المرتبطة N على الأكثر | العلاقة، لعناصر من، N | للعنصر N عنصرًا مرتبطًا أو أقل. |
| قيمة خارج نطاق | السمة، الحد الأدنى، الحد الأقصى، الوحدة | رقم السمة أقل من الحد الأدنى أو أكبر من الحد الأقصى. اترك أحد الحدين فارغًا لنطاق مفتوح. |
| قيمة داخل نطاق | السمة، الحد الأدنى، الحد الأقصى، الوحدة | رقم السمة ضمن النطاق، بما في ذلك الحدّان. |
| مجموع القيم المرتبطة مقارنةً بقيمة | الدالة، العلاقة، لعناصر من، قيمة كل عنصر مرتبط، المقارنة، المقارنة مع | يكون المجموع أو الأصغر أو الأكبر لقيمة على العناصر المرتبطة (أو عدد العناصر) أكبر من سمة للعنصر (مثلًا Mass Allocation) أو من قيمة بوحدتها (12 kg)، أو على الأقل مساويًا لها، أو أقل منها، أو على الأكثر مساويًا لها، أو مساويًا لها، أو مختلفًا عنها. وتُتخطى العناصر المرتبطة التي ليست لها القيمة. |
| تعبير يطابق | التعبير | يطابق العنصر التعبير. |
تُسمّى السمات كما على العنصر: الاسم والرقم والوصف (في مشروع SysML v2 Short Name والتوثيق) أو أي سمة من سمات الفئة. وفي مشروع SysML v2، يمكن أيضًا تسمية استخدام سمة للعنصر، مثل mass. ويُتخطى العنصر الذي ليست لفئته هذه السمة. وتشمل قيم عنصر LML أيضًا الخصائص التي هو specified by لها (تُقرأ خاصية Mass بالقيمة 2.4 والوحدات kg على أنها 2.4 kg) وتخصيصات ميزانيته (Mass Allocation، من الميزانيات). ودون الوحدة، يقرأ النطاق الرقم الأول في القيمة (تُقرأ 1,500 kg و1500 [kg] على أنها 1500) ويتخطى القيم التي ليست أرقامًا. ومع الوحدة مثل kg، تُحوَّل القيم أولًا (تُقرأ 25000 g على أنها 25 kg)، والقيمة من نوع آخر، مثل 3 m، نتيجة قائمة بذاتها: “لا يمكن مقارنة الطول والكتلة: الأبعاد مختلفة (m مقابل kg).” وتحوّل المجاميع والتعابير الوحدات بالطريقة نفسها وتبلّغ عن عدم التطابق بالطريقة نفسها، ولا تجري أبدًا مقارنة صامتة.
قواعد التعابير
يُكتب التعبير بلغة التصفية في شريط التصفية في قاعدة البيانات، فعامل التصفية الذي يجد العناصر المسببة للمشكلة هناك يعمل قاعدةً: كل عنصر يطابقه يُبلَّغ عنه. أمثلة:
| التعبير | التقارير |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | متطلبات طرفية لا تتحقق منها أي حالة اختبار. |
class:Requirement Requirement:"Status=Draft" | متطلبات لا تزال في Draft. |
class:Action is:root NOT relationship:"performed by" | إجراءات المستوى الأعلى التي لا يؤديها شيء. |
class:Asset (name:%TBD% OR description:TBD) | أصول فيها TBD في الاسم أو الوصف. |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | تجميعات تزن أجزاؤها أكثر من مخصصها، بأي مزيج من الوحدات. |
الحساب بالوحدات: يقارن value:"Mass * 1.1 <= 12 kg" أو value:"sum(decomposed by → Mass) > Mass Allocation" قيم العنصر والمجاميع على عناصره المرتبطة (sum، min، max، count)، مع + و- و* و/ والأقواس والوحدات بعد الأرقام (12 kg، 9.81 [m/s^2]). وتُحوِّل أيضًا مقارنات السمات التي فيها وحدة، مثل Asset:"Mass>2 kg".
المصطلحات: نص حر، name: (% يطابق أي نص)، number: (* يطابق أي نص)، description:، class:، label:، relationship:"…"، status:، id:، under:"<number>"، is:root، is:leaf، is:orphan، is:top، is:locked، is:diagram، ومقارنات السمات مثل Requirement:"Priority>=3" (=، ~ يحتوي، <، <=، >، >=؛ و= دون قيمة تعني فارغًا)، وAND وOR وNOT والأقواس. والمصطلح الذي لا يسمّي شيئًا في المشروع، مثل فئة غير معروفة، يُعرض بوصفه مشكلة.
ملفات مجموعات القواعد
ملف مجموعة القواعد هو JSON يحتوي على "format": "holarch-rule-set" و"version": 1 وname وdescription اختياري وقائمة rules، لكل منها id وname وseverity وmessage وtarget اختياري ({"class": "Requirement"}) وعامل تصفية where اختياري وcheck. صدّر مجموعة لترى الشكل الدقيق. وتعمل الملفات نفسها في فحوص النموذج في الواجهة البرمجية العامة وMCP. وتعمل على مشاريع SysML v2 أيضًا: هناك تشغّل الواجهة البرمجية وMCP مجموعات قواعد المشروع فقط (تعمل القواعد المدمجة في التطبيق)، والقاعدة التي تتناول العلاقات التي يقرؤها Holarch من الوصلات والتدفقات (connected by، transfers، generates، receives) تعمل في التطبيق فقط.
القواعد
| القاعدة | Heading | النموذج الجيد |
|---|---|---|
| Global.1 | أسماء متطابقة أو شبه متطابقة | داخل الفئة، لا يتشارك كيانان اسمًا. وتُقارن الأسماء بأي لغة، مع تجاهل حالة الأحرف والمسافات وعلامات الترقيم وعرض الأحرف (“ABS制御” تساوي “ABS制御”)؛ والأحرف المشكولة تُحتسب (“Größe” و“Grüße” مختلفتان). |
| Global.2 | الأسماء بأحرف صغيرة | يبدأ كل اسم كيان بحرف كبير. |
| Global.4 | أرقام مكررة في فئة | داخل الفئة، كل رقم فريد. |
| Global.5 | كلمات مبهمة في الأسماء أو الأوصاف | تستخدم الأسماء والأوصاف كلمات دقيقة. |
| Global.6 | كيانات بلا علاقات | لكل كيان علاقة. |
| Global.7 | قيم حية تشير إلى أهداف مفقودة | تشير القيم الحية، وكتل المصفوفات، والجداول الحية (الجداول والأعداد والمجاميع)، والإحالات في الأوصاف إلى كيانات ومستندات وفئات وتسميات وعلاقات وأشكال وجداول موجودة. |
| Global.8 | عروض UAF التي لا يمكن عرضها | يستخدم كل عرض UAF جذرًا وفئة وعلاقة يقبلها نوع عرضه. |
| Global.9 | علاقات لا يسمح بها المخطط الهيكلي | تربط كل علاقة فئات يسمح بها المخطط الهيكلي لصلتها. |
| Global.10 | كيانات بلا اسم ولا رقم | لكل كيان اسم أو رقم. |
| Global.11 | قيم خارج خيارات سمتها | كل قيمة تعداد ومتعددة الاختيار هي أحد خيارات سمتها، مختارة مرة واحدة. |
| Action.1 | أسماء Action لا تبدأ بفعل | يبدأ كل اسم Action بفعل. |
| Action.2 | أسماء Action بأحرف صغيرة | يبدأ كل اسم Action بحرف كبير. |
| Action.3 | إجراءات بلا اسم | لكل إجراء اسم. |
| Action.4 | إجراءات بلا رقم | لكل إجراء رقم. |
| Action.5 | إجراءات بلا وصف | لكل إجراء وصف. |
| Action.6 | إجراءات بلا أصل أو ابن | لكل إجراء أصل أو ابن. |
| Action.7 | إجراءات لها ابن واحد | لا يوجد إجراء له ابن واحد. |
| Action.9 | إجراءات لها أكثر من 9 أبناء | لا يوجد إجراء له أكثر من 9 أبناء. |
| Action.10 | إجراءات لها عدة أصول | لا يوجد إجراء له عدة أصول. |
| Action.11 | إجراءات لا يؤديها أي أصل | يؤدي أصلٌ ما كل إجراء. |
| Action.12 | إجراءات لا تُنتج شيئًا | يُنتج كل إجراء Input/Output. |
| Action.13 | إجراءات لا تستهلك شيئًا | يستهلك كل إجراء Input/Output. |
| Action.14 | إجراءات بلا مدخلات أو مخرجات | يستهلك كل إجراء Input/Output أو يُنتجه. |
| Action.15 | إجراءات تُنتج ولا تستهلك شيئًا | كل إجراء يُنتج مخرجات يستهلك أيضًا مُدخلًا. |
| Action.16 | إجراءات تستهلك ولا تُنتج شيئًا | كل إجراء يستهلك مدخلات يُنتج أيضًا مُخرجًا. |
| Action.17 | الإجراءات ذات مُدخل يُنتَج بعد استخدامه | لا يتلقى أي إجراء Input/Output يولّده إجراء لاحق. |
| Action.18 | إجراءات غير متتبَّعة إلى متطلب | يتتبع كل إجراء إلى متطلب. |
| Action.19 | حلقات لا يمكن أن تنتهي | يمكن أن تنتهي كل حلقة. يسمّي الحلقة وفرع OR عند 0 % الذي يمنع EXIT الخاص بها. |
| Asset.1 | أسماء Asset بلا اسم جامد | كل اسم Asset اسم أو عبارة اسمية. |
| Asset.2 | أسماء Asset بأحرف صغيرة | يبدأ كل اسم Asset بحرف كبير. |
| Asset.3 | أصول بلا اسم | لكل أصل اسم. |
| Asset.4 | أصول بلا رقم | لكل أصل رقم. |
| Asset.5 | أصول بلا وصف | لكل أصل وصف. |
| Asset.6 | أصول بلا أصل أعلى أو ابن | لكل أصل أصل أعلى أو ابن. |
| Asset.7 | أصول لها ابن واحد | لا يوجد أصل له ابن واحد. |
| Asset.9 | أصول لها أكثر من 9 أبناء | لا يوجد أصل له أكثر من 9 أبناء. |
| Asset.10 | أصول لها عدة أصول عليا | لا يوجد أصل له عدة أصول عليا. |
| Asset.11 | أصول لا تؤدي أي إجراء | يؤدي كل أصل إجراءً ما. |
| Asset.12 | أصول غير موصولة بقناة | كل أصل موصول بقناة. |
| Asset.13 | أصول متبادلة بلا قناة مشتركة | الأصول التي تتبادل Input/Output موصولة بقناة. |
| Asset.14 | أصول متفاعلة بلا معيار مشترك | تشير الأصول المتفاعلة إلى المعيار نفسه. |
| Asset.15 | أصول لا تتبادل شيئًا | يتبادل كل أصل Input/Output مع أصل آخر. |
| Conduit.1 | أسماء Conduit لا تبدأ باسم جامد | يبدأ كل اسم Conduit باسم جامد. |
| Conduit.2 | قنوات بلا اسم | لكل قناة اسم. |
| Conduit.3 | قنوات بلا رقم | لكل قناة رقم. |
| Conduit.4 | قنوات بلا وصف | لكل قناة وصف. |
| Conduit.5 | قنوات لها أكثر من أصلين | لا توجد قناة تصل أكثر من أصلين. |
| Conduit.6 | قنوات لها أقل من أصلين | تصل كل قناة أصلين. |
| Conduit.7 | قنوات بلا معيار مشترك مع أصولها | تشير القناة والأصول التي تصلها إلى المعيار نفسه. |
| Conduit.8 | قنوات لا تنقل شيئًا | تنقل كل قناة Input/Output ما. |
| Conduit.9 | قنوات غير متتبَّعة إلى متطلب | تتتبع كل قناة إلى متطلب. |
| IO.1 | عناصر Input/Output بلا اسم | لكل Input/Output اسم. |
| IO.2 | عناصر Input/Output بلا رقم | لكل Input/Output رقم. |
| IO.3 | عناصر Input/Output بلا وصف | لكل Input/Output وصف. |
| IO.4 | عناصر Input/Output لها عدة أصول | لا يوجد Input/Output له أكثر من أصل واحد. |
| IO.5 | عناصر Input/Output لا يُنتجها أي إجراء | يُنتج إجراءٌ ما كل Input/Output. |
| IO.6 | عناصر Input/Output لا يستهلكها أي إجراء | يستهلك إجراءٌ ما كل Input/Output. |
| IO.7 | عناصر Input/Output لا يستخدمها أي إجراء | يُنتج إجراءٌ كل Input/Output أو يستهلكه. |
| IO.8 | عناصر Input/Output يُنتجها إجراء ويستهلكها معًا | لا يستهلك أي إجراء Input/Output يُنتجه. |
| IO.9 | عناصر Input/Output بلا معيار مشترك مع أصولها | يشير الـ Input/Output والأصول التي تتبادله إلى المعيار نفسه. |
| IO.10 | عناصر Input/Output غير متتبَّعة إلى متطلب | يتتبع كل Input/Output إلى متطلب. |
| Requirement.1 | متطلبات تذكر كيانات غير مرتبطة | يرتبط المتطلب بكل كيان يسمّيه. |
| Requirement.2 | متطلبات طرفية بلا “shall” | يستخدم كل متطلب طرفي الكلمة “shall”. |
| Requirement.3 | متطلبات بلا اسم | لكل متطلب اسم. |
| Requirement.4 | متطلبات بلا رقم | لكل متطلب رقم. |
| Requirement.5 | متطلبات بلا وصف | لكل متطلب وصف. |
| Requirement.6 | متطلبات بلا أصل أو فرع | لكل متطلب أصل أو ابن. |
| Requirement.7 | متطلبات لها عدة أصول | لا يوجد متطلب له عدة أصول. |
| Requirement.8 | متطلبات طرفية لا يلبيها أي كيان تصميم | يرتبط كل متطلب طرفي بـ Action أو Asset أو Input/Output أو Conduit. |
| Requirement.9 | متطلبات satisfied by عدة عناصر Input/Output | لا يوجد متطلب satisfied by أكثر من Input/Output واحد. |
| Requirement.10 | متطلبات طرفية بلا حالة اختبار تتحقق منها | كل متطلب طرفي verified by Test Case. |
| Requirement.11 | متطلبات خارج أنماط EARS | يتبع كل متطلب طرفي فيه “shall” أحد أنماط EARS. موقوف (Ignore) إلى أن تضبط خطورته. |
| Risk.1 | مخاطر المستوى الأعلى بلا تخفيف | كل خطر مفتوح في أعلى مستوى من مصفوفة المخاطر mitigated by شيءٍ ما. |
| Risk.2 | قبولات مخاطر على السلامة أقدم من تغيير في الضوابط | لا يسبق قبول المخاطرة المتبقية لأي خطر على السلامة تغييرًا في ضوابطه أو في التحقق منها. |
| TestCase.1 | حالات الاختبار الفاشلة دون مشكلة مرتبطة | كل Test Case فاشلة مرتبطة بـ Issue. |
| Measure.1 | مقاييس تتجاوز عتبتها | القيمة المتوقعة (أو الحالية) لكل Measure تستوفي عتبتها. |
ملاحظات على القواعد:
- تستند قواعد كتابة المتطلبات إلى دليل INCOSE لكتابة المتطلبات: الكلمات المبهمة (R7، المصطلحات المبهمة؛ R8، عبارات التملص)، و“shall” (R1، العبارات المهيكلة)، والأحرف الكبيرة (R39، دليل الأسلوب). والفحص الكامل للكتابة هو جودة المتطلبات.
- تتخطى قواعد Action وAsset المهام وحالات الاختبار وانتقالات الحالة والمنافذ والموارد؛ وتظل القواعد Global تنطبق عليها.
- يُحتسب العنصر المفكك مؤدًّى أو مغذًّى أو منتجًا أو متتبَّعًا عندما يكون أي من أحفاده كذلك. والعناصر التي يفكك بعضها بعضًا في حلقة تُحتسب معًا.
- تبلّغ Global.9 عن كل عنصر مرة واحدة، مع الأطراف الأخرى لعلاقاته التي لا يسمح بها المخطط الهيكلي، ومع الصلة والفئة في الملاحظة، مثلًا “غير مسموح: decomposed by → Risk”. وتُعد العلاقة مسموحًا بها عندما يسمح بها المخطط الهيكلي في أي من الاتجاهين. وتبقى هذه العلاقات بعد إزالة هدف في محرر المخطط الهيكلي ويمكن أن تأتي مع عمليات الاستيراد.
- تأتي Global.10 وGlobal.11 من LML 2.0: يُعرَّف الكيان باسم أو رقم (§2.1)، وتُختار قيمة التعداد أو القيمة المتعددة الاختيار من قائمة سمتها (§2.5.6، §2.5.12). وتضع Global.11 كل مشكلات العنصر الواحد في ملاحظته، مثلًا
Status: "Pending" is not a choiceأوVerification Method: "Test" chosen twice. وتعمل كلتاهما افتراضيًا حيث يحتوي المخطط الهيكلي على العناصر المدمجة في LML 2.0: المخطط الهيكلي الافتراضي، أو نسخة المشروع الخاصة بعد المخطط الهيكلي ← إضافة عناصر مدمجة جديدة…. وفي مشروع نسخة مخططه الهيكلي أقدم، تبدآن على تجاهل، فيعرض النموذج المصنوع بـ LML 1.x النتائج نفسها كما من قبل؛ اضبطهما على Warning أو Error في الإعدادات لتشغيلهما. ويطلب محرر المخطط الهيكلي قيمتين على الأقل عند إنشاء قائمة أو تغييرها. - المنافذ نقاط واجهة، لا أجزاء: فهي لا تُحتسب أبناءً، والقناة على منفذ تُحتسب للأصل الذي يملكه.
- حالات الاستخدام (عناصر Action ذات التسمية Use Case) معفاة من قاعدة الفعل وقواعد Input/Output.
- تفحص Requirement.11 الجملة التي تحتوي على “shall” مقابل أنماط EARS الستة (الكتابة بقوالب EARS) وتسمّي أول ما يجب إصلاحه، مثلًا “Event-driven: ضع فاصلة بعد الشرط “When”، قبل اسم النظام.” ولا يُفحص المبرر والملاحظات في الجمل الأخرى.
- تشغّل مشاريع SysML v2 سبع عشرة من القواعد، بمصطلحات SysML v2: Global.1 و.2 و.4 إلى .8، وRequirement.2 إلى .5 و.8 و.10 و.11، وRisk.1، وTestCase.1، وMeasure.1. ولا تنطبق قواعد Action وAsset وConduit وInput/Output؛ إذ تفحص تشخيصات المحرر أسماء النموذج وأنواعه وبنيته. وتفحص قواعد المتطلبات استخدامات المتطلبات: مثلًا تُقرأ Requirement.8 بالصيغة “متطلبات طرفية لا يستوفيها شيء” (جزء أو إجراء يستوفيها) وRequirement.10 بالصيغة “متطلبات طرفية بلا حالة تحقق”. وتفحص Global.1 و.2 و.6 العناصر المجاورة للنموذج، مثل المخاطر والمهام والمستندات.
قواعد خط المنتجات
بمجرد أن يحتوي المشروع على Feature أو Configuration، تشغّل فحوص النموذج أيضًا مجموعة القواعد المدمجة Product line (القواعد ProductLine.1 إلى ProductLine.11 و13 إلى 17، الفئة Product Line). وتُعد أخطاءً الميزاتُ أو التهيئات المفقودة في Applies To (ProductLine.1)، والتهيئات التي تخالف قاعدة أو غير المكتملة (ProductLine.3)، والتهيئات Released التي فيها متطلبات لم يُتحقق منها فيها (ProductLine.16)؛ والقواعد الأخرى تحذيرات. وتفحص ProductLine.10 و11 اكتمال كل تهيئة من All configurations. وتفحص ProductLine.13 و14 مراجعات عنصر (supersedes): اثنتان ساريتان للوحدة نفسها، ووحدات بلا أي منها. وفي عرض التهيئة تفحص كل قاعدة تلك التهيئة. انظر خطوط المنتجات والتهيئات.
الرسائل
| الرسالة | المعنى |
|---|---|
| “لا توجد نتائج. كل الفحوص المنطبقة ناجحة.” | لا شيء يحتاج إلى إصلاح. |
| “لا توجد نتائج. N من النتائج متجاهَلة؛ يسردها «إظهار المتجاهَل».” | كل النتائج المتبقية متجاهَلة. |
| “لا توجد نتيجة تطابق عامل التصفية. امسح عامل التصفية أو الأوجه.” | تُخفي الأوجه أو عامل التصفية كل النتائج. |
| “لا يسمح المخطط الهيكلي بأي من هذه العلاقات للفئة …” | يحتاج الإصلاح إلى علاقة لا يسمح بها المخطط الهيكلي للمشروع لتلك الفئة. أضفها في محرر المخطط الهيكلي، أو أصلح النتيجة بطريقة أخرى. |
| “النمط ليس تعبيرًا نمطيًا صالحًا (…). صحّحه.” | يحتوي محرر القواعد أو ملف مستورد على نمط لا يمكن قراءته. |
| “المعرّف “…” مستخدم بالفعل في مجموعة القواعد هذه. اختر معرّفًا آخر.” | تحتاج قاعدتان في مجموعة واحدة إلى معرّفين مختلفين. |
| “العلاقة “…” ليست في المخطط الهيكلي لهذا المشروع.” | تسمّي قاعدة علاقة لا يحتويها هذا المشروع؛ ولا تبلّغ عن شيء إلى أن تغيّرها. |
| “لا يسمّي التعبير شيئًا للفئة “…”.” | يسمّي تعبير أو عامل تصفية فئة أو تسمية أو علاقة أو عنصرًا لا يحتويه المشروع. |
| “الإصدار N غير مدعوم. يقرأ هذا الإصدار من Holarch الإصدار 1.” | كُتب ملف مجموعة القواعد بإصدار أحدث من Holarch. |
الحدود
- تعرض القائمة حتى 200 نتيجة لكل مجموعة؛ صفِّ القائمة لرؤية الباقي.
- تحتوي مجموعة القواعد على 500 قاعدة كحد أقصى؛ ويحتوي الملف على 50 مجموعة قواعد و2 MB كحد أقصى. والأنماط حتى 300 حرف وتفحص أول 20,000 حرف من القيمة.
- يُحفظ التغيّر منذ آخر تشغيل لكل جهاز ومتصفح، لا في المشروع.
- تُرجع الواجهة البرمجية العامة وأدوات MCP النتائج نفسها بإعدادات المشروع؛ ولا تخزّن النتائج.
ذات صلة
- التحقق، التتبع، الواجهات
- التعليمات: فحوص النموذج، جودة المتطلبات، الرئيسية