Holarch

SysML v2

SysML v2 專案中的需求與驗證

使用「需求」、「品質」、「TBD/TBR」、「待檢查的連結」、「核准」、「RVTM」、「驗證案例」和「可追溯性矩陣」頁面,撰寫、檢查、核准並追蹤 SysML v2 模型的需求與驗證案例。

使用方式 →

本頁內容
  1. 概觀
  2. 概念
    1. 模型中的需求
    2. 閾值與目標
    3. 關係
    4. 測試案例與測試套件
    5. TBD 與 TBR
  3. 使用方式
    1. 使用時機與原因
    2. 撰寫需求
    3. 在文件中撰寫需求
    4. 檢查品質
    5. 核准需求
    6. 設定閾值與目標
    7. 將數值標示為 TBD 或 TBR
    8. 關閉 TBD 或 TBR
    9. 審查已變更的關聯
    10. 規劃並執行驗證
    11. 實作範例:Hybrid Car 示範專案
    12. 提示與良好做法
    13. 常見錯誤
    14. 與其他功能的關聯
  4. 需求與品質
    1. 需求頁面
    2. 品質頁面
  5. 變更管制
    1. 待審查的關聯
    2. 核准
    3. TBD/TBR 登錄表
  6. 驗證頁面
    1. 驗證案例
    2. RVTM
    3. 可追溯性矩陣
    4. 模型檢查
  7. 訊息
  8. 限制
  9. 相關頁面

概觀

SysML v2 專案具有與 LML 專案相同的需求與驗證頁面。它們在模型上運作:需求是模型的 requirement 元素,測試案例則是其 verification 案例。

側欄群組頁面
需要與需求需求、品質、TBD/TBR、待檢查的連結、核准
驗證RVTM、驗證案例、可追溯性矩陣、模型檢查

驗證案例就是 LML 專案中稱為測試中心的頁面。

有些資料是 SysML 文字,有些則是儲存在模型旁的 Holarch 資料:

  • 在文字中:編號(簡短名稱)、名稱、說明(doc)、巢狀、satisfy、verify、dependency 與衍生關係,以及含單位的屬性值。
  • Holarch 資料:狀態、優先順序、驗證方法與其他需求屬性、標籤、測試狀態、結果、步驟與測試週期。其他 SysML v2 工具不會讀取這些資料。

概念

模型中的需求

需求是 requirement 用法或 requirement def。Holarch 從文字讀取其欄位:

Holarch 欄位SysML v2 文字
編號簡短名稱:<'VR-1'>
姓名名稱:CurbMass
說明doc 註解:doc /* … */
子需求(decomposed by)由該需求所擁有的需求
requirement def <'VR-1'> CurbMass {
  doc /* The car's curb mass shall not exceed the mass limit. */
  subject car : Car;
  attribute limit : MassValue;
  require constraint { car.curbMass <= limit }
}

頁面以字首大寫顯示名稱,因此 sedanMass 會顯示為 Sedan Mass。

閾值與目標

當需求的某個 require 約束將量值與數值比較時,該需求就是定量需求:car.curbMass <= limit 或 range >= 800 [km]。該數值就是閾值,也就是最低可接受的數值。<= 使其成為上限(越低越好),>= 則使其成為下限(越高越好)。

SysML v2 沒有表示目標(超出閾值、所追求的數值)的關鍵字。Holarch 將其寫成來自 HolarchRequirements 庫套件(標準庫,Holarch 資料夾)的中繼資料 @Objective:

requirement def <'VR-1'> CurbMass {
  subject car : Car;
  attribute limit : MassValue;
  require constraint { car.curbMass <= limit }
  @Objective { value = 1600 [kg]; }
}
  • 需求定義上的目標適用於其每個用法。用法可以提供自己的目標。
  • 閾值可以是寫在約束中的數值(12 [kg]),或是由需求或重新定義所設定的屬性(attribute :>> limit = maxCurbMass;)。
  • 其他 SysML v2 工具會將 @Objective 讀取為一般的中繼資料。
  • 預算和 TPM 會將閾值用作每個滿足該需求之零件的分配值,並在 TPM 分頁上列出該需求及其閾值與目標(預算和 TPM)。

關係

Holarch 關係SysML v2 文字
satisfied bysatisfy carSpec by fleet.sedan;
verified by驗證案例目標中的 verify carSpec.sedanMass;
performed byperform 或 allocate
traced todependency
decomposed by擁有關係:由另一個需求擁有的需求

在任何頁面上新增或移除其中一種關係都會變更文字,一次復原即可全部撤回。

測試案例與測試套件

  • 測試案例是 verification 用法或 verification def。
  • 它所驗證的需求是其目標的 verify 成員。
  • 擁有驗證案例的套件就是測試套件。
verification def CurbMassTest {
  doc /* Weigh the car on a scale with full fluids and no driver. */
  subject car : Car;
  objective massObjective {
    verify carSpec.sedanMass;
  }
}

TBD 與 TBR

當下列任一情況成立時,需求即為未關閉(TBD 或 TBR):

  • 其 TBD/TBR 屬性為 TBD 或 TBR。
  • 其名稱或 doc 中出現 TBD、TBR 或 TBS。
  • 其某個屬性值帶有 TBD 或 TBR 中繼資料。

以 TBD 取代數值並不是有效的 SysML。請改以 Holarch 庫套件 HolarchMetadata 中的中繼資料標示屬性(請參閱將數值標示為 TBD 或 TBR)。

使用方式

使用時機與原因

在模型中撰寫了第一批需求之後使用這些頁面,並在整個驗證過程中持續使用:

  • 撰寫時使用需求與品質:每個需求的格式是否正確?
  • 審查時使用核准:誰已簽核?
  • 設計變更時使用 TBD/TBR 與待檢查的連結:還有什麼未關閉,什麼需要再檢查一次?
  • 規劃與執行驗證時使用可追溯性矩陣、驗證案例與 RVTM:每個需求是否都已滿足並驗證?

撰寫需求

  1. 開啟需要與需求 → 需求。
  2. 按一下 + 新增。會在套件 Requirements 中以下一個編號新增一個需求用法。
  3. 在屬性面板或表格中輸入名稱與說明。文字會立即變更,每次編輯都能以一次復原撤回。
  4. 在屬性面板中設定 Holarch 資料,區段與 LML 需求相同:審查列中的狀態,工作流程下的優先順序、關鍵度與擁有者;驗證下的驗證方法與驗證等級;Requirement 下的理由與來源。這些是 Holarch 資料;文字不會變更。每次編輯都能以一次復原撤回,需求表格、RVTM 與 VCRM 會顯示相同的數值。

您也可以在編輯器中撰寫需求。文字一旦可以剖析,需求就會出現在需求頁面上。

在文件中撰寫需求

一份文件可以容納一個套件的需求用法。

  1. 在文件中選擇撰寫 ▾ → 需求套件…並挑選套件。新文件會得到一個以其命名、含第一個需求的套件。
  2. 如同在 LML 文件中一樣新增、增加縮排、減少縮排與移動需求。
    • 章節下的需求屬於該套件。
    • 另一個需求下的需求會巢狀於其中。
    • 編號就是其簡短名稱。新增、移除或移動其他項目只會重新編號章節,絕不會變更簡短名稱;新需求會以其文件編號作為簡短名稱。上移與下移會互換兩個需求的簡短名稱,而重新編號…會在預覽後變更它們。
  3. 在編輯器中於該套件撰寫的需求會出現在文件中。

移除會在確認後刪除該套件的需求。若要將需求移出文件但不刪除,請在編輯器中將其移至另一個套件。

檢查品質

  1. 開啟需要與需求 → 品質。
  2. 按一下檢查品質。每個需求的說明會依九項標準評分,規則與 LML 專案相同。
  3. 請先修正分數最低的項目。

標示為過期的分數屬於較舊的文字。請再次檢查品質。

核准需求

需求的狀態依序為草稿 → 審查中 → 已核准或已拒絕。

  1. 將需求的狀態設為審查中。它會列在核准上,對審查者而言也會列在「我的工作」的等待審查下。審查者會收到通知。
  2. 身為審查者,請選取該需求。屬性面板會顯示其狀態,並有核准、拒絕…與重新開啟。
  3. 按一下核准,或按一下拒絕…並選擇性填寫原因。屬性面板會記錄是誰在何時設定了狀態。

具有審查者角色的人可以核准與拒絕。編輯已核准需求的文字會使其回到審查中。

設定閾值與目標

  1. 以將一個量值與數值比較的 require 約束撰寫閾值,例如 require constraint { battery.mass <= 50 [kg] }。
  2. 選取該需求。屬性面板會顯示閾值和目標,含量值與閾值(最多或至少)。
  3. 在目標中輸入所追求的數值,例如 45 kg,然後按 Enter。

    Holarch 會將 @HolarchRequirements::Objective { value = 45 [kg]; } 寫入該需求。清除該欄位即可將其移除。

  4. 以 satisfy 將需求關聯到符合它的零件。當零件符合閾值但未達目標時,編輯器會加以註明。

將數值標示為 TBD 或 TBR

  1. 在需求的套件中匯入中繼資料套件:private import HolarchMetadata::*;。
  2. 在數值仍待決定的屬性前寫 #TBD。省略數值,或提供估計值。
  3. 在數值待審查的屬性前寫 #TBR。
  4. 若要記錄擁有者與原因,請在屬性本體中使用完整形式。
#TBR attribute limit : TimeValue = 0.5 [h];
attribute chargerPower : PowerValue {
  @TBD { owner = "Powertrain lead"; rationale = "The fast-charging standard is not chosen yet."; due = "2026-12-01"; }
}

編輯器中的插入 ▾ → TBD 值與 TBR 值會為您撰寫這些內容。TBD 與 TBR 特化 ModelingMetadata::StatusInfo,因此其他 SysML v2 工具會將它們讀取為狀態註記。@StatusInfo { status = StatusKind::tbd; } 也會計入。此套件列於標準庫的 Holarch 之下。

關閉 TBD 或 TBR

  1. 開啟需要與需求 → TBD/TBR。每個未關閉的項目都會顯示其擁有者、到期日與存在時間,並附未關閉項目的燃盡圖。
  2. 在文字或屬性面板中輸入最終數值,然後按一下該列上的關閉。TBD/TBR 屬性會回到 None,TBD/TBR 中繼資料也會從數值中移除。

doc 中的標記會在您編輯 doc 時關閉。匯出 XLSX 會匯出登錄表。

當需求變更時,依賴它的關聯會作為該變更的一部分被標示為待審查,按一次復原即可同時撤回兩者。

  1. 開啟需要與需求 → 待檢查的連結。每個關聯都會顯示變更了什麼、何時以及由誰變更。
  2. 按一下差異以查看舊的與新的名稱及 doc,或按一下在文字中顯示以在編輯器中開啟該需求。
  3. 檢查關聯的元素。如果它已不再適用,請更新它。
  4. 按一下標記為已審查…,選擇性新增留言,然後確認。

具有待審查關聯的元素也會在屬性面板中顯示附有審查…的橫幅,並在表格中顯示審查徽章。資料庫檢視待審查的關聯會列出它們。

規劃並執行驗證

  1. 開啟驗證 → 驗證案例。
  2. 按一下 + 新增 ▾ → 測試套件…以新增套件,再按一下 + 新增 ▾ → 測試案例…以新增驗證用法。
  3. 將需求關聯到測試案例。會在測試案例的目標中新增一個 verify。
  4. 新增步驟、以執行套件執行套件,並設定每個測試案例的狀態。狀態、預期與實際結果、步驟與週期都是 Holarch 資料。
  5. 開啟驗證 → RVTM,即可查看每個需求及其驗證方法、驗證它的測試案例,以及從子需求彙總的狀態。

實作範例:Hybrid Car 示範專案

請先建立示範專案:管理專案 → 專案檔案 ▾ → 新增示範專案 → Hybrid Car (SysML v2)。其需求位於套件 VehicleRequirements 中。

  1. 開啟需要與需求 → 需求。其中包括 VR-1 Curb Mass 到 VR-6 Battery Mass Limit,以及需求 carSpec,其下有 VR-1.1 Sedan Mass、VR-2.1 Sedan Acceleration 與 VR-4.1 Sedan Range。
  2. 選取 VR-1.1 Sedan Mass。它透過驗證案例 CurbMassTest 目標中的 verify carSpec.sedanMass; 受到該案例驗證。
  3. 開啟 TBD/TBR。VR-5 Charge Time 未關閉:其 limit 帶有 #TBR,其 chargerPower 帶有擁有者為 Powertrain lead 的 @TBD。
  4. 在編輯器中將 maxCurbMass 從 1650 [kg] 改為 1600 [kg]。VR-1.1 Sedan Mass 使用 maxCurbMass 作為其限值,因此其關聯會被標示為待審查。
  5. 開啟待檢查的連結。會列出 VR-1.1 Sedan Mass 的 verified by 關聯。按一下差異,檢查測試,然後按一下標記為已審查…。
  6. 開啟驗證 → 可追溯性矩陣,以需求為列、資產為欄。carSpec 與 fleet.sedan 的儲存格會顯示 satisfied by,來自 satisfy carSpec by fleet.sedan;。

提示與良好做法

  • 為每個需求提供簡短名稱。它是每個頁面與文件中的編號。
  • 將數值寫成屬性,而不是寫在 doc 中。attribute :>> limit = maxCurbMass; 可以被計算、由 Parametric View 檢查,並由待審查的關聯追蹤。
  • 以 #TBD 或 #TBR 標示未定的數值,而不是在數值中寫「TBD」。文字會維持有效,登錄表也能找到它們。
  • 將測試案例放在自己的套件中。它會在驗證案例頁面上成為一個測試套件。

常見錯誤

  • 以為狀態會出現在文字中。狀態、優先順序與驗證方法是 Holarch 資料。交換檔案不會攜帶它們。
  • 撰寫 limit = TBD。這不是有效的 SysML,文字會維持為草稿。請使用 #TBD attribute limit : TimeValue;。
  • 為了移動需求而將其從文件中移除。移除會將它從模型中刪除。請改為在編輯器中將其移至另一個套件。

與其他功能的關聯

  • 檢視:Requirement View 會繪製相同的需求,以及 satisfy、verify、derive 與 refine 關係(SysML v2 檢視)。
  • 模擬器:對照需求檢查…會從需求的 require constraint 取得其準則,並將結果記錄在驗證案例上(評估、單位與分析)。
  • 文件:RTM、RVTM、VCRM、需求展開與分配矩陣區塊會列出模型的需求。
  • 變更控制:基準線保存模型;比較會列出需求的變更(SysML v2 專案中的 Holarch 功能)。

需求與品質

需求頁面

需求是篩選為 Requirement 類別的資料庫。它具有資料庫的篩選、檢視、欄、樹狀模式、內嵌編輯、大量處理工具與匯出(需求)。

  • + 新增會在套件 Requirements 中以下一個編號新增一個需求用法。
  • 編輯編號、名稱或說明會變更模型文字,每次變更都能以一次復原撤回。
  • 表格與定義匯出包含種類、類型、多重性與值,在含有個體的模型中另含個體、部分(portion)與執行個體。
  • 選取需求會在 SysML v2 屬性面板中顯示它。其連結會在瀏覽器中開啟它。

模型元素無法使用:變更類別、複製、鎖定、連同子項複製,以及專案資料(JSON)與專案套件(.holarch)匯出。匯出專案…會將整個專案備份為 .holarch。

品質頁面

品質會依 LML 專案的九項標準為每個需求的說明評分:Appropriate、Complete、Conforming、Correct、Feasible、Necessary、Singular、Unambiguous 與 Verifiable(需求品質)。分數是 Holarch 資料。標示為過期的分數屬於較舊的文字。

篩選方式與 LML 專案相同(篩選品質頁面):含品質、未通過某項標準與規則發現事項群組的 + 篩選、需求屬性與標籤、輸入的 quality: 條件、搜尋文字以及檢視 ▾。

變更管制

當關聯另一端的項目在上次審查該關聯後有所變更時,該關聯就需要審查(其他工具也稱為可疑連結):請確認該關聯仍然成立,然後將其標記為已審查。需求的變更會將下列關聯標示為待審查:satisfied by(satisfy)、verified by(verify)、decomposed by(擁有的需求)與 traced to(dependency)。

變更是指對下列任一項的編輯:

  • 需求的名稱或 doc。
  • 關鍵屬性:優先順序、關鍵度、驗證方法或驗證等級。
  • 其擁有之屬性的數值,例如 attribute :>> limit = maxCurbMass;,或其某個約束。
  • 這些數值或約束所指名的目標屬性,例如 attribute maxCurbMass : MassValue = 1650 [kg];。

無論您在何處進行變更都會計入:編輯器、檢視、屬性面板或表格。變更驗證方法或驗證等級只會將 verified by 關聯標示為待審查,而首次設定時則不會標示任何關聯。

待檢查的連結頁面的每個關聯都有差異、在文字中顯示與標記為已審查…。

核准

核准會列出審查中的需求。屬性面板會顯示狀態,並有核准、拒絕…與重新開啟,以及是誰在何時設定的。狀態是模型旁的 Holarch 資料;它不屬於 SysML 文字。

TBD/TBR 登錄表

登錄表會列出每個未關閉的需求及其擁有者、到期日與存在時間,並有未關閉項目的燃盡圖以及匯出 XLSX。關閉會將 TBD/TBR 屬性設回 None,並移除數值的 TBD/TBR 中繼資料。

到期日是需求唯一的到期日,與屬性面板工作流程群組以及項目檢視中的到期日是同一個日期:

  1. 需求數值上之 @TBD/@TBR 中繼資料中最早的 due,例如 @TBD { owner = "Powertrain lead"; due = "2027-06-30"; }。
  2. 否則為 TBD 到期日屬性。
  3. 否則為需求自己的到期日。

登錄表為唯讀。請在文字中變更日期,或在屬性面板中設定到期日。到期日會將 due = "<date>"; 寫入需求的每個 @TBD/@TBR 中繼資料本體中(若本體中沒有則新增),並設定需求的到期日,一次復原即可全部撤回。前置詞形式 #TBD/#TBR 沒有本體,因此只以這種方式標示的數值會使用需求的到期日。

驗證頁面

驗證案例

套件、測試案例、狀態、步驟、測試週期、執行套件與報告的運作方式與 LML 專案相同(驗證)。

  • + 新增 ▾ → 測試案例…會新增驗證用法;測試套件…會新增套件。
  • 關聯需求會在測試案例的目標中新增一個 verify。
  • 狀態、預期與實際結果、步驟與週期是儲存在模型旁的 Holarch 資料。

RVTM

每個需求及其驗證方法、驗證它的測試案例,以及從子需求彙總的狀態(RVTM)。⚠ 標示其 satisfy、verify 或分解關聯需要審查的需求,以及其 verify 關聯需要審查的驗證案例。

可追溯性矩陣

列、欄與關係的運作方式與 LML 專案相同(可追溯性矩陣)。

  • 資產是零件用法(系統中的零件),Actions 是動作用法。
  • 對於類別軸,元素 → 定義會改為列出定義。
  • 在模型元素之間,儲存格可以包含 satisfied by(satisfy)、verified by(verify)、performed by(allocate 或 perform)、traced to(dependency)與 decomposed by(擁有關係)。其他關係會顯示為不允許。
  • 每次按一下都能以一次復原撤回,並會變更模型文字。

模型檢查

適用於模型的規則會執行(模型檢查),以 SysML v2 的用語來說:

  • 沒有名稱、簡短名稱(末端需求)、說明(自己的或其定義的)、satisfy 或 verify 的需求用法,以及沒有「shall」的末端需求;
  • 重複的簡短名稱、含糊的字詞、指向不存在目標的即時數值、無法顯示的 UAF 檢視;
  • 沒有緩解措施的未關閉頂層風險、沒有 Issue 的失敗驗證案例、超出閾值的 TPM;
  • 模型旁的項目(風險、任務、決策、文件)同名或沒有關係。

編輯器中的檢查器涵蓋名稱、類型與結構,因此 LML 功能分析規則(Action、Asset、Conduit 與 Input/Output)不會執行,設定也只會列出這些規則。不會為模型元素提供合併修正。

訊息

訊息意義與修正方式
SysML v2 專案中無法使用:請在編輯器中變更模型。此動作只能用於 LML 實體。請在編輯器中進行變更。
未套用變更。此編輯會讓文字無效。旁邊的訊息會指出問題。
過期:請重新執行需求的文字在上次品質檢查之後有所變更。請再次檢查品質。
“…” meets “…”, but … does not reach the objective ….資訊:零件符合閾值但未達目標。請改善設計,或變更目標。
“…” has an objective but no threshold to compare it with. …需求有 @Objective,但沒有將量值與數值比較的 require 約束。請新增一個。
“…” has more than one threshold (…), so its objective is ambiguous. …需求比較了不只一個量值。請將它拆分為每個量值一個需求。
The objective … of “…” is not below (above) its threshold ….目標必須超出閾值:低於上限,或高於下限。
The objective … of “…” is in …, but its threshold … is in ….目標的單位與閾值屬於不同的量值。請使用閾值之量值的單位。
@Objective applies to requirements, but “…” is ….此註記位於需求之外。請將它移入需求中。

限制

  • 狀態、驗證方法、其他需求屬性、標籤與測試結果是 Holarch 資料。SysML v2 交換檔案不會攜帶它們。
  • 模型元素無法使用變更類別、複製、鎖定與連同子項複製。
  • 模型檢查中不會為模型元素提供合併修正。

SysML® 與 OMG® 是 Object Management Group, Inc. 在美國及其他國家的註冊商標。