Holarch

驗證

模型檢查

對整個模型執行 75 項規則式檢查和您自己的規則集,依嚴重性、類別、規則與標籤縮小發現事項範圍、就地修正、忽略刻意如此的項目,並設定每條規則的嚴格程度。

使用方式 →

本頁內容
  1. 概觀
  2. 概念
  3. 使用方式
    1. 逐一處理發現事項
    2. 專注於一個領域
    3. 一併審查一個項目的發現事項
    4. 實例演練:CubeSat EO-1 示範
    5. 撰寫您自己的規則
    6. 以單位檢查質量預算
    7. 與其他專案共用規則
    8. 提示
  4. 頁面
    1. 頁首
    2. 標題行
    3. 工具列
    4. 面向篩選
    5. 發現事項
    6. 修正
  5. 設定
  6. 規則集
    1. 「規則集」對話方塊
    2. 規則編輯器
    3. 運算式規則
    4. 規則集檔案
  7. 規則
    1. 產品線規則
  8. 訊息
  9. 限制
  10. 相關內容

概觀

驗證 → 模型檢查會對專案中的每個項目執行一組規則,並列出每條規則的發現。這些規則會尋找讓模型難以信任或審查的缺口:缺少名稱與編號、孤立的項目、無人執行的動作、未承載任何東西的介面、未配置或未驗證的需求、沒有處理計畫的風險,以及未達門檻的度量。

每當模型變更時檢查都會重新執行,因此此頁面、首頁上的模型檢查卡片以及驗證上的徽章始終一致。

概念

  • 規則:一項附有編號的檢查(例如 Requirement.10),包含說明其發現內容的標題、良好模型應有樣貌的陳述,以及修正方式。規則依其檢查的類別分組:Global(每個項目)、Action、Asset、Conduit、Input/Output、Requirement、Risk、Test Case 與 Measure。
  • 發現事項:違反一條規則的一個項目。發現事項可以列出相關項目,例如名稱的重複項或父項的子項。
  • 嚴重性:每條規則以錯誤或警告回報,或設為忽略而不執行。預設為警告,但結構描述副本早於 LML 2.0 之專案中的 LML 2.0 規則 Global.10 與 Global.11 除外(請參閱規則)。
  • 已忽略的發現事項:您已針對一個項目接受的發現事項。它不再計入,顯示已忽略會將其與還原一起列出。
  • 適用的檢查:至少對其類別的一個項目執行過的規則。標題行會計算有多少適用的檢查沒有發現事項。
  • 規則集:您自己的規則所組成的具名群組,儲存在專案中,可整組開啟或關閉。其規則與內建檢查一起執行,其發現事項使用相同的清單、修正與忽略。請參閱規則集。

使用方式

在每次審查前、大量匯入後,以及首頁顯示模型檢查錯誤時執行檢查。它們回答一個問題:在其他人閱讀之前,模型中有什麼需要處理?

逐一處理發現事項

  1. 開啟驗證 → 模型檢查。標題行會顯示例如「84% 的適用檢查通過」,接著是錯誤與警告的數量,以及與上次執行相比的變化。
  2. 清單依規則分組,錯誤在前。按一下規則標題即可展開;其描述說明此規則為何重要。
  3. 對每個發現事項按一下修正。修正對話方塊會顯示項目、規則與建議的修正:要填寫的欄位、要加入的關係、要合併的重複項,或開啟該項目或其圖的按鈕。
  4. 儲存修正。發現事項會消失,計數也會更新。
  5. 當發現事項是刻意的(例如一個動作在兩個父項下重複使用),請按一下忽略。

專注於一個領域

  1. 在左側的面向篩選中,勾選嚴重性下的錯誤以只查看錯誤。
  2. 勾選類別下的類別(有發現事項之項目的類別)、規則下的規則,或標籤下的標籤。同一面向內的勾選以 OR 組合;不同面向以 AND 組合。每個值都會顯示其發現事項數量。
  3. 在篩選發現事項中輸入,以比對項目名稱或規則標題。
  4. 按一下清除面向篩選即可再次顯示全部。

一併審查一個項目的發現事項

  1. 選擇篩選旁的依實體分組。
  2. 每個項目只列出一次,並附上其所有發現事項,依編號排序。有錯誤的項目會在其標題中顯示錯誤徽章。

實例演練:CubeSat EO-1 示範

  1. 開啟 CubeSat EO-1 示範專案,前往驗證 → 模型檢查。
  2. 勾選類別下的 Requirement。其餘的規則會顯示哪些需求沒有父項、沒有配置(Requirement.8)或沒有驗證用的測試案例(Requirement.10)。
  3. 展開 Requirement.10,在一個發現事項上按一下修正,並關聯驗證它的測試案例。該發現事項會離開清單,標題行的數字會上升。
  4. 選擇依實體分組,一次查看一項需求的所有剩餘發現事項。

撰寫您自己的規則

  1. 按一下頁首中的規則集…,然後按一下+ 新增規則集。為規則集命名,例如「計畫規則」,然後按一下確定。
  2. 在規則集下按一下+ 新增規則。規則編輯器會以 ID R1 開啟。
  3. 輸入說明此規則發現內容的名稱,例如「沒有驗證用測試案例的需求」。
  4. 在適用於中選擇 Requirement。
  5. 在在以下情況下回報項目中選擇缺少關係,然後在關係中選擇 verified by。
  6. 將嚴重性設為錯誤並撰寫訊息,例如「關聯驗證此需求的測試案例。」
  7. 閱讀欄位下方的預覽,例如「目前回報 3 個項目:SYS-2 Top Speed, …」。按一下儲存。
  8. 按一下關閉。規則的發現事項會出現在清單中的 R1 下,錯誤在前。按一下修正以關聯測試案例;該發現事項會離開清單。

以單位檢查質量預算

  1. 在 CubeSat EO-1 示範中開啟規則集…,按一下+ 新增規則集並將其命名為「質量預算」。
  2. 按一下+ 新增規則。將其命名為「超出質量配置的組件」,並在適用於中選擇 Asset。
  3. 在在以下情況下回報項目中選擇將相關值的總計與某個值比較。將函數設為總計、關係設為 decomposed by、每個相關項目的值設為 Mass、比較設為大於,並將比較對象設為 Mass Allocation。
  4. 將嚴重性設為錯誤並按一下儲存,然後按一下關閉。
  5. 零件重量超出其配置的組件會被列出,例如「decomposed by 的 Mass 總計 2.34 kg 大於 Mass Allocation 1.35 kg」。以公克和公斤表示的質量可相加;以公尺輸入的質量會列為「無法將質量與長度相加:維度不同(kg 與 m)。」

與其他專案共用規則

  1. 在規則集…中,按一下規則集旁的匯出。會下載一個名稱類似 program-rules.holarch-rules.json 的檔案。
  2. 在另一個專案中開啟規則集…,按一下匯入…,然後按一下選擇檔案…(或貼上檔案的文字),再按一下匯入。
  3. 若要透過庫共用,請將規則集保留在庫專案中並發布一個發行版本。在使用該庫的專案中,按一下從庫…,勾選規則集並按一下複製。
  4. 當庫發布了含有該規則集的較新發行版本時,規則集…會在副本旁顯示「有較新的版本可用」。按一下更新…,審查變更,針對兩處都有變更的每條規則選擇保留我的或採用庫中的,然後按一下更新。您對副本的其他編輯會保留。

提示

  • 在設定中將團隊視為阻擋性的規則設為錯誤,讓首頁將其列為問題。
  • 只有在發現事項是刻意的時候才忽略它,並在項目的描述或留言中說明原因。顯示已忽略可讓審查者看到哪些已被接受。
  • 匯入後若出現一長串命名發現事項,通常在資料庫中編輯名稱最快。
  • 在儲存基準線之前執行檢查,讓基準線不帶有已知的缺口。

頁面

控制項功能
匯出…開啟「匯出」對話方塊並選擇發現事項 (CSV):每個未被忽略的發現事項,含規則、嚴重性、標題、項目 ID、編號、名稱、類別、附註與相關項目。
設定設定每條規則的嚴重性與每層子項數(請參閱「設定」)。
↻ 執行檢查再次執行每項檢查,並將計數記錄為上次執行。

標題行

  • 「N% 的適用檢查通過」:有任何發現事項為錯誤時顯示紅色,只有警告時顯示琥珀色,沒有需要修正的項目時顯示綠色。
  • 發現事項、錯誤與警告的數量。
  • 與此裝置上次執行相比的變化,例如「比上次執行少 3 個發現事項。」上次執行會在您開啟或離開頁面時,以及按一下↻ 執行檢查時記錄。第一次造訪會顯示「此裝置上的第一次執行。」

在大型專案中,檢查會在背景執行,讓頁面保持可用:第一次造訪會顯示「正在執行模型檢查…」,之後的造訪會顯示先前的發現事項,直到新的發現事項就緒,而超過一秒的執行會顯示進度卡片。

工具列

  • 依規則分組(預設)或依實體分組。選擇會記憶在此裝置上。
  • 篩選發現事項:比對項目名稱、規則編號與規則標題。
  • 全部展開與全部摺疊會開啟或關閉每個群組。

面向篩選

面向數值
嚴重性錯誤、警告
等級每個有發現事項之項目的類別
規則每條有發現事項的規則,依編號與標題
標籤有發現事項之項目上的每個標籤
已忽略顯示已忽略會將已忽略的發現事項加入清單,標示為「已忽略」,並附還原

計數會依其他面向與篩選而定,因此會顯示勾選某個值後會剩下什麼。

發現事項

每個發現事項會顯示項目(若依實體分組則為規則)、附註(例如「含糊用詞:adequate, TBD」或「14 個子項」)、相關項目,以及修正與忽略按鈕,已忽略的發現事項則為還原。一次復原即可撤回一次忽略或還原。

修正

修正方式使用於功能
編輯欄位缺少名稱、編號或描述;動詞與名詞檢查以目前的值開啟欄位。
首字大寫小寫的名稱提供首字母大寫的名稱。
新增關係缺少父項、執行者、輸入、輸出、管道、標準、追溯列出結構描述允許用於該關係的項目;勾選它們並按一下新增關係。
合併相似的名稱、單一子項保留一個項目,將其他項目的每個關係移到它上面,合併描述並刪除其他項目(一次復原即可全部撤回)。
刪除相關項目其輸入在使用之後才產生的動作刪除在存在之前就被消耗的輸入/輸出。
新增 traced to提及無關實體的需求從需求對其文字所指名的每個項目新增 traced to。
建立 Issue沒有關聯問題的未通過測試案例建立一個關聯到測試案例及其所驗證需求的 Issue。
開啟過長的子項清單、交換、標準、門檻、結構描述不允許的關係開啟項目或其圖。
開啟 UAF 檢視無法顯示的 UAF 檢視列出根的檢視及其問題,並開啟第一個。

設定

  • 每層子項數:Action.9 與 Asset.9 會回報子項多於此數字的父項。預設為 9,依據人在同一層級約可處理 7 ± 2 個項目的準則。允許的值為 2 到 99;其他值會顯示「每層子項數必須是 2 到 99 的整數。」
  • 每條規則的嚴重性:錯誤、警告或忽略。被忽略的規則不會執行。
  • 還原預設值會將每條規則設回其預設值(警告;Requirement.11 為忽略;在結構描述副本早於 LML 2.0 的專案中,Global.10 與 Global.11 為忽略),並將每層子項數設回 9。

設定儲存在專案中,與專案中的每個人共用,且可復原。

規則集

頁首中的規則集…會開啟「規則集」對話方塊。您自己的規則會與內建檢查一起在模型檢查中執行:其發現事項會顯示規則的 ID(例如 R1)與名稱,計入標題行,出現在面向篩選的規則下,並與任何發現事項一樣使用修正、忽略與匯出…。規則集儲存在專案中,與專案中的每個人共用,每項變更都是一個復原步驟。

「規則集」對話方塊

控制項功能
+ 新增規則集要求輸入名稱,並新增一個已開啟的空白規則集。
匯入…加入規則集檔案中的規則集:選擇檔案…或貼上其文字,然後按一下匯入。每條規則都會先經過檢查;有問題的檔案會被拒絕並列出問題。已使用的名稱會加上「 (2)」。
從庫…列出此專案所使用之庫的發行版本中的規則集;勾選它們並按一下複製。副本會記住其庫與發行版本。
更新…當複製的規則集所屬的庫已發布含有該規則集的較新發行版本時,會顯示在其旁邊(「有較新的版本可用」)。預覽庫中新增、變更與移除的規則、保留的您所做的編輯,以及在此處和庫中都有變更的規則;針對其中每一條選擇保留我的或採用庫中的,然後按一下更新。一次復原即可全部撤回。
規則集旁的核取方塊開啟或關閉規則集。關閉的規則集不會執行。
重新命名…重新命名規則集。
匯出將規則集下載為 JSON 規則集檔案。
刪除確認後刪除規則集及其規則。復原可將其還原。
+ 新增規則、編輯、刪除在規則集中新增規則、變更規則或刪除規則。

無法在此專案中執行的規則(例如指名結構描述中沒有的類別或關係的規則)會在其名稱下方以紅色顯示問題,且不回報任何內容。

規則編輯器

欄位設定內容
姓名規則發現事項的標題:規則所發現的內容。
ID在規則集中簡短且唯一,例如 R1 或 SYS-NUM;最多 40 個字母、數字、點、連字號與底線。
適用於任意項目、一個類別(包含子類別:Test Case 也是 Action),或在 SysML v2 專案中的模型種類,例如 Part 或 Requirement。
只限符合的項目選用:以資料庫篩選語言撰寫的篩選條件,可先縮小項目範圍,例如 is:leaf。
在以下情況下回報項目條件,如下。
嚴重性錯誤或警告。
訊息要進行的修正,顯示在「修正」對話方塊中。

欄位下方的行會說明此規則目前回報多少項目,並列出前五個的名稱。

條件欄位回報項目的情況
屬性為空屬性屬性沒有值。
屬性符合模式屬性、模式、忽略大小寫屬性的文字包含與模式(一個規則運算式)相符的內容。
屬性不符合模式屬性、模式、忽略大小寫屬性的文字沒有相符的內容,例如對必須以 SYS- 開頭的編號使用 ^SYS-\d+$。
缺少關係關係、目標項目類別項目沒有該關係的關聯(指向該類別的項目)。
存在關係關係、目標項目類別項目有這樣的關聯。
相關項目數至少為 N關係、目標項目類別、N項目有 N 個或更多相關項目,例如超過 9 個子項。
相關項目數最多為 N關係、目標項目類別、N項目有 N 個或更少相關項目。
值在範圍之外屬性、最小值、最大值、單位屬性的數字低於最小值或高於最大值。將一個邊界留空即為開放範圍。
值在範圍之內屬性、最小值、最大值、單位屬性的數字在範圍內,包含邊界。
將相關值的總計與某個值比較函數、關係、目標項目類別、每個相關項目的值、比較、比較對象相關項目上某個值的總計、最小或最大(或項目數)大於、至少、小於、最多、等於或不同於項目的某個屬性(例如 Mass Allocation)或帶單位的值(12 kg)。沒有該值的相關項目會被略過。
運算式相符運算式項目符合運算式。

屬性的名稱與項目上相同:名稱、編號與說明(在 SysML v2 專案中為 Short Name 與說明文件),或類別的任何屬性。在 SysML v2 專案中,也可以指名元素的屬性用法,例如 mass。類別沒有此屬性的項目會被略過。LML 項目的值也包含它 specified by 的特性(Value 為 2.4、Units 為 kg 的 Mass 特性讀作 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。匯出一個規則集即可看到確切的結構。相同的檔案也會在公開 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不產生任何東西的動作每個動作都產生一個輸入/輸出。
Action.13不消耗任何東西的動作每個動作都消耗一個輸入/輸出。
Action.14沒有輸入或輸出的動作每個動作都消耗或產生一個輸入/輸出。
Action.15只產生而不消耗任何東西的動作每個產生輸出的動作也會消耗一個輸入。
Action.16只消耗而不產生任何東西的動作每個消耗輸入的動作也會產生一個輸出。
Action.17其輸入在使用之後才產生的動作沒有動作接收由後續動作產生的輸入/輸出。
Action.18未追溯到需求的動作每個動作都追溯到一個需求。
Action.19永遠無法結束的迴圈每個迴圈都能結束。會列出迴圈名稱,以及以 0 % 阻擋其 EXIT 的 OR 分支。
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相互交換但沒有共同管道的資產交換輸入/輸出的資產透過管道連接。
Asset.14相互作用但沒有共同標準的資產相互作用的資產引用同一標準。
Asset.15不交換任何東西的資產每個資產都與另一個資產交換輸入/輸出。
Conduit.1不以名詞開頭的管道名稱每個管道名稱都以名詞開頭。
Conduit.2缺少名稱的管道每個管道都有名稱。
Conduit.3缺少編號的管道每個管道都有編號。
Conduit.4缺少描述的管道每個管道都有描述。
Conduit.5連接兩個以上資產的管道沒有管道連接兩個以上的資產。
Conduit.6資產少於兩個的管道每個管道都連接兩個資產。
Conduit.7與其資產沒有共同標準的管道管道及其連接的資產引用同一標準。
Conduit.8不傳輸任何東西的管道每個管道都傳輸某個輸入/輸出。
Conduit.9未追溯到需求的管道每個管道都追溯到一個需求。
IO.1缺少名稱的輸入/輸出每個輸入/輸出都有名稱。
IO.2缺少編號的輸入/輸出每個輸入/輸出都有編號。
IO.3缺少描述的輸入/輸出每個輸入/輸出都有描述。
IO.4有多個父項的輸入/輸出沒有輸入/輸出擁有多個父項。
IO.5沒有動作產生的輸入/輸出每個輸入/輸出都由某個動作產生。
IO.6沒有動作消耗的輸入/輸出每個輸入/輸出都由某個動作消耗。
IO.7沒有動作使用的輸入/輸出每個輸入/輸出都由某個動作產生或消耗。
IO.8同一動作既產生又消耗的輸入/輸出沒有動作消耗其自身產生的輸入/輸出。
IO.9與其資產沒有共同標準的輸入/輸出輸入/輸出及交換它的資產引用同一標準。
IO.10未追溯到需求的輸入/輸出每個輸入/輸出都追溯到一個需求。
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由多個輸入/輸出滿足的需求沒有需求由多個輸入/輸出滿足。
Requirement.10沒有驗證測試案例的末端需求每個末端需求都由 Test Case 驗證。
Requirement.11不符合 EARS 模式的需求每個含「shall」的末端需求都遵循其中一種 EARS 模式。在您設定其嚴重性之前為關閉(忽略)。
Risk.1沒有緩解措施的最高等級風險風險矩陣最高等級的每個未結風險都有緩解措施。
Risk.2早於控制措施變更的危害接受沒有任何危害的殘餘風險接受早於其控制措施或其驗證的變更。
TestCase.1沒有關聯問題的未通過測試案例每個失敗的 Test Case 都關聯到一個 Issue。
Measure.1突破閾值的 Measure每個 Measure 的預測值(或目前值)都滿足其閾值。

關於規則的說明:

  • 需求撰寫規則引用 INCOSE Guide to Writing Requirements:模糊詞語(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 內建項目的地方,兩者預設都會執行:預設結構描述,或在 Schema → Add New Built-ins…(結構描述 → 新增新的內建項目…)之後的專案自有副本。在結構描述副本較舊的專案中,它們一開始為忽略,因此以 LML 1.x 建立的模型會顯示與以前相同的發現事項;在設定中將它們設為警告或錯誤即可執行。結構描述編輯器在您建立或變更清單時,會要求至少兩個值。
  • 埠是介面點,而非零件:它們不算作子項,而埠上的管道會計入擁有該埠的資產。
  • 使用案例(帶有 Use Case 標籤的 Action)不受動詞規則與輸入/輸出規則限制。
  • Requirement.11 會以六種 EARS 模式(以 EARS 範本撰寫)檢查含「shall」的句子,並指出第一個要修正的地方,例如「Event-driven:在 \"When\" 條件之後、系統名稱之前加上逗號。」其他句子中的理由與附註不受檢查。
  • SysML v2 專案以 SysML v2 的用語執行其中 17 條規則:Global.1、.2、.4 到 .8,Requirement.2 到 .5、.8、.10 與 .11,Risk.1、TestCase.1 與 Measure.1。Action、Asset、Conduit 與 Input/Output 規則不適用;編輯器的診斷會檢查模型的名稱、型別與結構。Requirement 規則檢查需求用法:例如 Requirement.8 顯示為「沒有任何項目滿足的末端需求」(滿足它的零件或動作),Requirement.10 則為「沒有驗證案例的末端需求」。Global.1、.2 與 .6 會檢查模型旁的項目,例如風險、任務與文件。

產品線規則

專案一旦有 Feature 或 Configuration,模型檢查也會執行內建規則集產品線(規則 ProductLine.1 到 ProductLine.11 及 13 到 17,類別產品線)。Applies To 中缺少特性或組態(ProductLine.1)、違反規則或不完整的組態(ProductLine.3),以及含有未在其中驗證之需求的 Released 組態(ProductLine.16)為錯誤;其他規則為警告。ProductLine.10 與 11 會從「所有組態」檢查每個組態的完整性。ProductLine.13 與 14 檢查項目的修訂版本(supersedes):同一單元有兩個同時生效,以及沒有任何修訂版本的單元。在組態檢視中,每條規則都會檢查該組態。請參閱產品線與組態。

訊息

訊息意義
「沒有發現事項。每項適用的檢查都通過。」沒有需要修正的項目。
「沒有發現事項。已忽略 N 個發現事項;「顯示已忽略」會列出它們。」剩餘的每個發現事項都已被忽略。
「沒有符合篩選條件的發現事項。請清除篩選條件或面向篩選。」面向篩選或篩選條件隱藏了所有發現事項。
「結構描述不允許該類別使用以下任何關係…」此修正需要專案結構描述不允許該類別使用的關係。請在結構描述編輯器中加入,或以其他方式修正該發現事項。
「此模式不是有效的規則運算式(…)。請更正。」規則編輯器或匯入的檔案中有無法讀取的模式。
「ID「…」已在此規則集中使用。請選擇其他 ID。」同一規則集中的兩條規則需要不同的 ID。
「關係「…」不在此專案的結構描述中。」規則指名了此專案沒有的關係;在您變更它之前,它不會回報任何內容。
「運算式未指涉類別「…」的任何內容。」運算式或篩選條件指名了專案中沒有的類別、標籤、關係或項目。
「不支援版本 N。此版本的 Holarch 可讀取版本 1。」規則集檔案是由較新版本的 Holarch 寫入的。

限制

  • 清單每組最多顯示 200 個發現事項;篩選清單即可查看其餘的發現事項。
  • 一個規則集最多可包含 500 條規則;一個檔案最多可包含 50 個規則集與 2 MB。模式最多 300 個字元,會檢查值的前 20,000 個字元。
  • 與上次執行相比的變化會依裝置和瀏覽器保存,而不是保存在專案中。
  • 公開 API 與 MCP 工具會以專案的設定傳回相同的發現事項;它們不會儲存結果。