אימות
בדיקות המודל
הרצת 75 בדיקות מבוססות כללים ומערכי כללים משלך על כל המודל, צמצום הממצאים לפי חומרה, מחלקה, כלל ותווית, תיקונם במקום, התעלמות מאלה שמכוונים והגדרת מידת ההקפדה של כל כלל.
סקירה כללית
אימות ← בדיקות המודל מריץ קטלוג של כללים על כל פריט בפרויקט ומציג מה כל כלל מוצא. הכללים מחפשים פערים שמקשים לסמוך על מודל או לסקור אותו: שמות ומספרים חסרים, פריטים שעומדים לבדם, פעולות שאף אחד לא מבצע, ממשקים שלא מעבירים דבר, דרישות שלא הוקצו או לא אומתו, סיכונים בלי תוכנית טיפול ו-Measures שלא עומדים בסף שלהם.
הבדיקות רצות שוב בכל פעם שהמודל משתנה, כך שהדף, הכרטיס בדיקות המודל בדף הבית והתג על אימות תמיד מתאימים זה לזה.
מושגים
- כלל: בדיקה אחת עם מספר (למשל Requirement.10), כותרת שמתארת מה היא מוצאת, הצהרה איך נראה מודל טוב, ותיקון. הכללים מקובצים לפי המחלקה שהם בודקים: Global (כל פריט), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case ו-Measure.
- ממצא: פריט אחד שמפר כלל אחד. ממצא יכול לציין פריטים קשורים, למשל את הכפילויות של שם או את הצאצאים של הורה.
- חומרה: כל כלל מדווח כ-שגיאה או כ-אזהרה, או מוגדר ל-התעלמות ואינו רץ. ברירת המחדל היא אזהרה, מלבד כללי 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, יש לפתוח את ערכות כללים…, ללחוץ על + ערכת כללים חדשה ולקרוא לה "תקציב מסה".
- יש ללחוץ על + הוספת כלל. יש לקרוא לו "מכלולים מעל הקצאת המסה שלהם" ולבחור נכס ב-חל על.
- ב-דיווח על פריט כאשר, יש לבחור סכום של ערכים קשורים בהשוואה לערך. יש להגדיר את פונקציה ל-סך הכול, את קשר ל-decomposed by, את הערך של כל פריט קשור ל-Mass, את השוואה ל-גדול מ- ואת השוואה עם ל-Mass Allocation.
- יש להגדיר את חומרה ל-שגיאה וללחוץ על שמירה, ואז על סגירה.
- מכלול שהחלקים שלו שוקלים יותר מההקצאה שלו מוצג ברשימה, למשל "Total Mass of "decomposed by" 2.34 kg is more than Mass Allocation 1.35 kg". מסות בגרמים ובקילוגרמים מסתכמות יחד; מסה שהוזנה במטרים מוצגת כ-"Cannot add mass and length: the dimensions differ (kg vs m)." (אי אפשר לחבר מסה ואורך: הממדים שונים).
שיתוף כללים עם פרויקט אחר
- ב-ערכות כללים…, יש ללחוץ על ייצוא ליד הערכה. מורד קובץ בשם כמו
program-rules.holarch-rules.json. - בפרויקט האחר, יש לפתוח את ערכות כללים…, ללחוץ על ייבוא…, ואז על בחירת קובץ… (או להדביק את הטקסט של הקובץ) וללחוץ על ייבוא.
- כדי לשתף דרך ספרייה, שומרים את ערכות הכללים בפרויקט הספרייה ומפרסמים מהדורה. בפרויקט שמשתמש בספרייה, יש ללחוץ על מהספרייה…, לסמן את הערכות וללחוץ על העתקה.
- כשהספרייה מפרסמת מהדורה חדשה יותר עם הערכה, ערכות כללים… מציג "גרסה חדשה יותר זמינה" ליד העותק. יש ללחוץ על עדכון…, לסקור את השינויים, לבחור שמירת הגרסה שלי או לקיחת הגרסה של הספרייה לכל כלל ששונה בשני המקומות, וללחוץ על עדכון. שאר העריכות שלך בעותק נשמרות.
טיפים
- כדאי להגדיר את הכללים שהצוות שלך מתייחס אליהם כחוסמים ל-שגיאה ב-הגדרות, כדי שדף הבית יציג אותם כבעיות.
- כדאי להתעלם מממצא רק כשהוא מכוון, ולציין למה בתיאור של הפריט או בתגובה. הצגת פריטים בהתעלמות מאפשר לסוקרים לראות מה התקבל.
- רשימה ארוכה של ממצאי שמות אחרי ייבוא מתוקנת בדרך כלל הכי מהר בעריכת השמות במסד הנתונים.
- כדאי להריץ את הבדיקות לפני שמירת קו בסיס, כדי שקו הבסיס לא יישא פערים ידועים.
הדף
כותרת הדף
| פקד | מה הוא עושה |
|---|---|
| ייצוא… | פותח את תיבת הדו-שיח של הייצוא עם ממצאים (CSV): כל ממצא שאינו בהתעלמות, עם כלל, חומרה, כותרת, מזהה פריט, מספר, שם, מחלקה, הערה ופריטים קשורים. |
| הגדרות | מגדיר את החומרה של כל כלל ואת מספר הצאצאים לכל רמה (ראו «הגדרות»). |
| ↻ הרצת הבדיקות | מריץ שוב את כל הבדיקות ומתעד את הספירות כהרצה האחרונה. |
שורת הכותרת
- "N% מהבדיקות הרלוונטיות עוברות": אדום כשממצא כלשהו הוא שגיאה, ענבר כשיש רק אזהרות, ירוק כשאין מה לתקן.
- מספר הממצאים, השגיאות והאזהרות.
- השינוי מאז ההרצה האחרונה במכשיר הזה, למשל "3 ממצאים פחות מההרצה האחרונה." ההרצה האחרונה מתועדת כשפותחים את הדף או יוצאים ממנו וכשלוחצים על ↻ הרצת הבדיקות. בביקור הראשון מוצג "הרצה ראשונה במכשיר הזה."
בפרויקט גדול הבדיקות רצות ברקע, כך שאפשר להמשיך להשתמש בדף: בביקור הראשון מוצג "מריץ את בדיקות המודל…", בביקורים הבאים מוצגים הממצאים הקודמים עד שהחדשים מוכנים, וכרטיס התקדמות מציג הרצה שנמשכת יותר משנייה.
סרגל כלים
- קיבוץ לפי כלל (ברירת מחדל) או קיבוץ לפי ישות. הבחירה נשמרת במכשיר הזה.
- סינון ממצאים: מתאים לשמות פריטים, למספרי כללים ולכותרות כללים.
- הרחבת הכול ו-כיווץ הכול פותחים או סוגרים כל קבוצה.
היבטים
| היבט | ערכים |
|---|---|
| חומרה | שגיאות, אזהרות |
| סוג | המחלקה של כל פריט עם ממצא |
| כלל | כל כלל עם ממצא, לפי מספר וכותרת |
| תווית | כל תווית בפריט עם ממצא |
| בהתעלמות | הצגת פריטים בהתעלמות מוסיף לרשימה את הממצאים שבהתעלמות, מסומנים «בהתעלמות», עם שחזור |
הספירות תלויות בשאר ההיבטים ובמסנן, כך שהן מראות מה יישאר אם מסמנים ערך.
ממצאים
כל ממצא מציג את הפריט (או, בקיבוץ לפי ישות, את הכלל), את ההערה (למשל "מילים מעורפלות: adequate, TBD" או "14 צאצאים"), את הפריטים הקשורים ואת הכפתורים תיקון ו-התעלמות, או שחזור לממצא בהתעלמות. ביטול פעולה אחד מבטל התעלמות או שחזור.
תיקונים
| תיקון | משמש את | מה הוא עושה |
|---|---|---|
| עריכת שדה | שם, מספר או תיאור חסרים; בדיקות פועל ושם עצם | פותח את השדה עם הערך הנוכחי. |
| אות רישית | שמות באותיות קטנות | מציע את השם עם אות ראשונה רישית. |
| הוספת קשרים | הורה, מבצע, קלטים, פלטים, ערוצים, תקנים או עקבות חסרים | מציג את הפריטים שהסכמה מתירה לקשר; יש לסמן אותם וללחוץ על הוספת קשרים. |
| מיזוג | שמות דומים, צאצאים יחידים | שומר פריט אחד, מעביר אליו כל קשר של האחרים, מאחד את התיאורים ומוחק את האחרים (ביטול פעולה אחד מחזיר הכול לאחור). |
| מחיקת הקשורים | פעולות עם קלט שמופק אחרי השימוש בו | מוחק את ה-Input/Outputs שנצרכים לפני שהם קיימים. |
| הוספת traced to | דרישות שמזכירות ישויות לא קשורות | מוסיף traced to מהדרישה לכל פריט שהטקסט שלה מזכיר. |
| יצירת Issue | מקרי בדיקה שנכשלו בלי בעיה מקושרת | יוצר Issue שמקושר למקרה הבדיקה ולדרישות שהוא מאמת. |
| פתיחה | רשימות צאצאים ארוכות, החלפות, תקנים, ספים, קשרים שהסכמה אינה מתירה | פותח את הפריט או את הדיאגרמה שלו. |
| פתיחת תצוגת UAF | תצוגות UAF שאי אפשר להציג | מציג את התצוגות של השורש עם הבעיות שלהן ופותח את הראשונה. |
הגדרות
- צאצאים לכל רמה: Action.9 ו-Asset.9 מדווחים על הורה עם יותר צאצאים מהמספר הזה. ברירת המחדל היא 9, מתוך ההנחיה שאנשים מתמודדים עם כ-7 ± 2 פריטים ברמה אחת. הערכים המותרים הם 2 עד 99; ערך אחר מציג "מספר הצאצאים לכל רמה חייב להיות מספר שלם בין 2 ל-99."
- חומרה לכל כלל: שגיאה, אזהרה או התעלמות. כלל בהתעלמות אינו רץ.
- שחזור ברירות המחדל מחזיר כל כלל לברירת המחדל שלו (אזהרה; Requirement.11 בהתעלמות; Global.10 ו-Global.11 בהתעלמות בפרויקט שעותק הסכמה שלו קודם ל-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 אפשר לציין גם שימוש מאפיין (attribute usage) של האלמנט, כמו mass. פריט שבמחלקה שלו אין מאפיין כזה מדולג. הערכים של פריט LML כוללים גם את ה-Characteristics שהוא specified by (מאפיין Mass עם Value 2.4 ו-Units kg נקרא כ-2.4 kg) ואת הקצאות התקציב שלו (Mass Allocation, מתקציבים). בלי יחידה, טווח קורא את המספר שבתחילת הערך (1,500 kg ו-1500 [kg] נקראים כ-1500) ומדלג על ערכים שאינם מספרים. עם יחידה כמו kg, הערכים מומרים קודם (25000 g נקרא כ-25 kg), וערך מסוג אחר, כמו 3 m, הוא ממצא בפני עצמו: "Cannot compare length and mass: the dimensions differ (m vs 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. אפשר לייצא ערכה כדי לראות את המבנה המדויק. אותם קבצים רצים בבדיקות המודל של ה-API הציבורי ושל ה-MCP. הם רצים גם בפרויקטים של SysML v2: שם ה-API וה-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.2 | שמות נכסים באותיות קטנות | כל שם של נכס מתחיל באות רישית. |
| 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/Outputs בלי שם | לכל Input/Output יש שם. |
| IO.2 | Input/Outputs בלי מספר | לכל Input/Output יש מספר. |
| IO.3 | Input/Outputs בלי תיאור | לכל Input/Output יש תיאור. |
| IO.4 | Input/Outputs עם כמה הורים | לאף Input/Output אין יותר מהורה אחד. |
| IO.5 | Input/Outputs שאף פעולה אינה מפיקה | פעולה כלשהי מפיקה כל Input/Output. |
| IO.6 | Input/Outputs שאף פעולה אינה צורכת | פעולה כלשהי צורכת כל Input/Output. |
| IO.7 | Input/Outputs שאף פעולה אינה משתמשת בהם | כל Input/Output מופק או נצרך על ידי פעולה. |
| IO.8 | Input/Outputs שפעולה גם מפיקה וגם צורכת | אף פעולה אינה צורכת Input/Output שהיא מפיקה. |
| IO.9 | Input/Outputs בלי תקן משותף עם הנכסים שלהם | Input/Output והנכסים שמחליפים אותו מפנים לאותו תקן. |
| IO.10 | Input/Outputs שאינם נעקבים לדרישה | כל 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 | דרישות שמסופקות על ידי כמה Input/Outputs | אף דרישה אינה מסופקת על ידי יותר מ-Input/Output אחד. |
| Requirement.10 | דרישות עלה בלי מקרה בדיקה מאמת | כל דרישת עלה מאומתת על ידי Test Case. |
| Requirement.11 | דרישות מחוץ לתבניות EARS | כל דרישת עלה עם "shall" עוקבת אחר אחת מתבניות EARS. כבוי (התעלמות) עד שמגדירים את החומרה שלו. |
| Risk.1 | סיכונים ברמה הגבוהה ביותר בלי הפחתה | כל סיכון פתוח ברמה הגבוהה ביותר של מטריצת הסיכונים מופחת על ידי משהו. |
| Risk.2 | קבלות של סיכוני בטיחות שקודמות לשינוי בבקרה | קבלת הסיכון השיורי של סיכון בטיחות אינה קודמת לשינוי בבקרות שלו או באימות שלהן. |
| TestCase.1 | מקרי בדיקה שנכשלו בלי בעיה מקושרת | כל Test Case שנכשל מקושר ל-Issue. |
| Measure.1 | Measures שחורגים מהסף שלהם | הערך החזוי (או הנוכחי) של כל Measure עומד בסף שלו. |
הערות על הכללים:
- כללי כתיבת הדרישות מצטטים את INCOSE Guide to Writing Requirements: מילים מעורפלות (R7, מונחים מעורפלים; R8, סעיפי מילוט), "shall" (R1, הצהרות מובנות) ואותיות רישיות (R39, מדריך סגנון). בדיקת הכתיבה המלאה היא איכות הדרישות.
- כללי Action ו-Asset מדלגים על משימות, מקרי בדיקה, מעברי מצב, פורטים ומשאבים; כללי Global עדיין חלים עליהם.
- פריט מפורק נחשב כמבוצע, מוזן, מפיק או נעקב כשאחד מהצאצאים שלו כזה. פריטים שמפרקים זה את זה בלולאה נספרים יחד.
- Global.9 מדווח על כל פריט פעם אחת, עם הקצוות האחרים של הקשרים שלו שהסכמה אינה מתירה, ועם היחס והמחלקה בהערה, למשל "Not allowed: 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: סכמת ברירת המחדל, או עותק של פרויקט אחרי Schema → Add New Built-ins…. בפרויקט שעותק הסכמה שלו ישן יותר, הם מתחילים במצב התעלמות, כך שמודל שנבנה ב-LML 1.x מציג את אותם ממצאים כמו קודם; כדי להריץ אותם יש להגדיר אותם לאזהרה או לשגיאה ב-הגדרות. עורך הסכמה מבקש לפחות שני ערכים כשיוצרים או משנים רשימה. - פורטים הם נקודות ממשק, לא חלקים: הם אינם נספרים כצאצאים, וערוץ על פורט נספר עבור הנכס שמחזיק בו.
- מקרי שימוש (Actions עם התווית Use Case) פטורים מכלל הפועל ומכללי ה-Input/Output.
- Requirement.11 בודק את המשפט שמכיל "shall" מול שש תבניות EARS (כתיבה בעזרת תבניות EARS) ומציין את הדבר הראשון שיש לתקן, למשל "Event-driven: Put a comma after the \"When\" condition, before the system name." (יש לשים פסיק אחרי תנאי ה-When, לפני שם המערכת). נימוקים והערות במשפטים אחרים אינם נבדקים.
- פרויקטים של SysML v2 מריצים 17 מהכללים, במונחי 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 usages): למשל Requirement.8 נקרא "דרישות עלה ששום דבר אינו מספק" (חלק או פעולה שמספקים אותה) ו-Requirement.10 "דרישות עלה בלי מקרה אימות". Global.1, .2 ו-.6 בודקים את הפריטים שליד המודל, כמו סיכונים, משימות ומסמכים.
כללי קו מוצרים
ברגע שבפרויקט יש Feature או Configuration, בדיקות המודל מריצות גם את ערכת הכללים המובנית קו מוצרים (הכללים ProductLine.1 עד ProductLine.11 ו-13 עד 17, המחלקה Product Line). תכונות או תצורות חסרות ב-Applies To (ProductLine.1), תצורות שמפרות כלל או שאינן שלמות (ProductLine.3) ותצורות במצב Released עם דרישות שלא אומתו בהן (ProductLine.16) הן שגיאות; שאר הכללים הם אזהרות. ProductLine.10 ו-11 בודקים את השלמות של כל תצורה מתוך «כל התצורות». ProductLine.13 ו-14 בודקים גרסאות של פריט (supersedes): שתיים בתוקף לאותה יחידה, ויחידות בלי אף אחת. בתצוגת תצורה כל כלל בודק את התצורה הזו. ראו קווי מוצרים ותצורות.
הודעות
| הודעה | משמעות |
|---|---|
| "אין ממצאים. כל הבדיקות הרלוונטיות עוברות." | אין מה לתקן. |
| "אין ממצאים. N ממצאים בהתעלמות; «הצגת פריטים בהתעלמות» מציג אותם." | כל הממצאים שנותרו בהתעלמות. |
| "אף ממצא אינו תואם למסנן. יש לנקות את המסנן או את ההיבטים." | ההיבטים או המסנן מסתירים את כל הממצאים. |
| "הסכמה אינה מתירה אף אחד מהקשרים האלה למחלקה …" | התיקון דורש קשר שסכמת הפרויקט אינה מתירה למחלקה הזו. אפשר להוסיף אותו בעורך הסכמה, או לתקן את הממצא בדרך אחרת. |
| "התבנית אינה ביטוי רגולרי תקין (…). יש לתקן אותה." | בעורך הכללים או בקובץ מיובא יש תבנית שאי אפשר לקרוא. |
| "המזהה "…" כבר בשימוש בערכת הכללים הזו. יש לבחור מזהה אחר." | שני כללים באותה ערכה צריכים מזהים שונים. |
| "הקשר "…" אינו בסכמה של הפרויקט הזה." | כלל מציין קשר שאין בפרויקט הזה; הוא אינו מדווח על דבר עד שמשנים אותו. |
| "הביטוי אינו מציין דבר עבור המחלקה "…"." | ביטוי או מסנן מציינים מחלקה, תווית, קשר או פריט שאין בפרויקט. |
| "גרסה N אינה נתמכת. הגרסה הזו של Holarch קוראת את גרסה 1." | קובץ ערכת הכללים נכתב בגרסה חדשה יותר של Holarch. |
מגבלות
- הרשימה מציגה עד 200 ממצאים לכל קבוצה; כדי לראות את השאר יש לסנן את הרשימה.
- ערכת כללים מכילה עד 500 כללים; קובץ מכיל עד 50 ערכות כללים ו-2 MB. תבניות הן עד 300 תווים ובודקות את 20,000 התווים הראשונים של ערך.
- השינוי מאז ההרצה האחרונה נשמר לכל מכשיר ודפדפן, לא בפרויקט.
- ה-API הציבורי וכלי ה-MCP מחזירים את אותם ממצאים עם ההגדרות של הפרויקט; הם אינם שומרים תוצאות.
קשור
- אימות, עקיבות, ממשקים
- עזרה: בדיקות המודל, איכות הדרישות, בית