Holarch

需求

文件產生

將即時的可追溯性、驗證和介面矩陣以及測試報告放入文件中,以四種格式匯出、從基準線建立文件,並加上標示:在每一頁與每次匯出中加上公司聲明、DoD 散發聲明、出口管制聲明、著作權或合約編號。

使用方式 →

本頁內容
  1. 概觀
  2. 概念
    1. 矩陣
    2. 即時,而非複製
  3. 使用方式
    1. 將矩陣插入文件
    2. 匯出矩陣
    3. 來自基準線的矩陣
    4. 測試報告
    5. 標示文件和匯出
    6. 設定專案機密等級標示
    7. 設定組織機密等級標示
    8. 為文件設定自有的機密等級標示、封面頁和頁碼
    9. 機密等級標示的列印位置
  4. 模型檢查
  5. 提示

概觀

Holarch 從模型建立交付項目,因此文件始終與其背後的需求、測試和關聯一致。三種工具涵蓋審查者通常要求的內容:

  • 矩陣區塊:文件文字中的可追溯性、驗證或介面矩陣,或測試報告,在模型變更時隨之更新。
  • 匯出矩陣:將相同的矩陣和測試報告匯出為獨立的 Excel、Word、CSV 或網頁檔案,來源可以是目前的模型或基準線。
  • 機密等級標示與版面設定:適用於組織、專案或單一文件的機密等級標示(公司聲明、發布聲明、出口管制聲明、著作權或合約編號),出現在每項匯出上,另外還有 Word 的封面頁和頁碼。

文字中的即時值和表格在文件頁面中說明:即時值…插入實體的一個屬性,計數或合計…插入從查詢計算的數字,即時表格…插入來自查詢的表格,交互參照…插入章節、圖或表目前的編號。

概念

矩陣

矩陣列欄標示為缺口
RTM(需求可追溯性矩陣)需求Number、Requirement、Parent、Traced From、Traced To、Satisfied By沒有父項目且沒有追溯來源的需求
需求向下展開矩陣需求Number、Requirement、Flows Down From、Flows Down To、Derived Requirements沒有子項目也沒有衍生需求的頂層需求
需求配置矩陣需求Number、Requirement、Components、Functions、Other沒有任何項目滿足的需求
符合性矩陣(開啟正式計畫時顯示)客戶規格的需求Number、Requirement、Compliance、Response、Our Requirements and Design、Verification、Deviation/Waiver沒有符合性聲明的需求(Not assessed,未評估)
RVTM(需求驗證可追溯性矩陣)需求Number、Requirement、Method、Level、Verified By、Status沒有驗證方法或沒有驗證的測試案例
VCRM(驗證交互參照矩陣)需求Number、Requirement、Inspection、Analysis、Demonstration、Test、Verified By、Status未選擇驗證方法
依驗證層級的 VCRM需求Number、Requirement,然後是每個驗證層級下的 I、A、D 和 T,Verified By、Status沒有驗證方法或沒有驗證層級
測試報告測試週期的測試案例Number、Test Case、Verifies、Status、Actual Result、Run在該週期中未通過的測試案例
配置矩陣功能 (Actions)Number、Function、Performed By沒有任何元件執行的功能
介面矩陣元件 (Assets)相同的元件;儲存格列出從列元件到欄元件的 Conduit與其他元件之間沒有任何 Conduit 的元件
N² 矩陣功能 (Actions)相同的功能;儲存格列出列功能產生、欄功能接收的 Input/Output沒有交換任何輸入或輸出的功能
自訂矩陣來自搜尋查詢的實體來自第二個查詢的實體;儲存格指出兩者之間的關係,或針對一個選定的關係顯示 X與任何欄都沒有關係的列
  • Parent 是該列 decomposes 的需求。Traced From、Traced To 和 Satisfied By 列出相關實體。在向下展開矩陣中,Derived Requirements 是該列 traces to 的需求。
  • 在 VCRM 中,X 標示每個計畫的方法;狀態是目前為止的驗證結果,如同在測試中心中一樣,從測試案例彙總而來。
  • 在依驗證層級的 VCRM中,欄依驗證等級屬性的層級(Component、Subsystem、System)分組。X 位於需求的層級及其每個計畫方法之下。
  • 測試案例絕不會列為功能:配置矩陣和 N² 矩陣顯示不是 Test Case 的 Action。
  • 範圍:矩陣涵蓋一份文件的實體(依文件順序和編號)、彙編的所有部分,或整個專案。配置矩陣使用文件的功能,文件沒有功能時則使用所有功能。介面矩陣和 N² 矩陣也可以涵蓋某個 Asset 或 Action 的子項目,如同 I² 和 N² 圖;對於整個專案,它們列出具有 Conduit 或 Input/Output 的元件或功能,最多 120 個。自訂矩陣最多顯示 2,000 列和 120 欄。
  • 測試報告區塊顯示一個測試套件的一個測試週期,或其目前結果。請參閱測試報告。

即時,而非複製

矩陣區塊只儲存要顯示的內容,而不儲存列。每次顯示或匯出文件時,Holarch 都會從模型重新建立列。結果會快取到下次變更為止,因此大型專案仍保持快速。

使用方式

將矩陣插入文件

  1. 開啟文件,然後按一下文件或項目的說明。
  2. 在 RTF 工具列中開啟+,然後選擇矩陣…。
  3. 選擇矩陣和範圍。範圍預設為開啟的文件。
    • 對於自訂矩陣,輸入列和欄的搜尋查詢(例如 class:Requirement 和 class:Asset),選擇關係或保留任何關係,並視需要為其指定標題。
    • 對於測試報告,選擇測試套件和測試週期,或目前結果。

      您會看到預覽。預覽會在模型變更時更新。

  4. 按一下插入。

    矩陣以虛線外框出現在文字中。其標號指出矩陣、範圍以及有多少列有缺口。

矩陣無法逐格編輯;請改為變更模型。若要移除它,請像其他內容一樣在編輯器中刪除該表格。

匯出矩陣

  1. 在文件中開啟交付 ▾,然後選擇可追溯性矩陣…。或選擇交付 ▾ → 所有匯出…,然後選擇Traceability matrix (Excel)、(Word)、(CSV)或(HTML)。
  2. 在匯出矩陣中,選擇矩陣和範圍,並在匯出為中選擇Matrix (Excel)、Matrix (Word)、Matrix (CSV)或Matrix (HTML)。
  3. 選用:在模型中選擇基準線,而非目前的模型。清單顯示專案的基準線和所選文件的基準線。

    欄位下方的一行顯示列數和有缺口的列數。

  4. 按一下匯出。

    快顯通知顯示「已匯出矩陣。」缺口在 Excel、Word 和網頁中以紅色底色標示。Word 和網頁匯出使用文件的版面設定。在 Word 中,文字欄較寬,驗證方法欄較窄,標題為 I、A、D 和 T,表格下方附圖例(I = Inspection、A = Analysis、D = Demonstration、T = Test)。超過五欄的矩陣使用橫向頁面。依層級的 VCRM 有第二列標題列顯示層級;介面、N² 和自訂矩陣會為列標題和對角線加上底色。

來自基準線的矩陣

簽署的交付項目必須顯示建立基準線時的模型,而非現在的模型。從基準線建立的矩陣使用基準線的實體和關係,其標題結尾為「(baseline name)」。

  • 匯出矩陣:在模型中選擇基準線。
  • 專案基準線保存整個模型,因此每個矩陣都可以從它建立。
  • 文件基準線保存文件、其項目以及與其關聯的實體。該文件的矩陣是完整的。超出文件範圍的矩陣(整個專案,或介面或 N² 矩陣)會附註「Built from a document baseline, which holds only that document and the entities linked to it.」(從文件基準線建立,其中只包含該文件及與其關聯的實體。)

測試報告

測試報告提供一個測試週期的結果:測試了什麼、在哪個組態上、哪些通過和失敗,以及這驗證了哪些需求。

  1. 在測試中心中,使用開始新週期…記錄測試週期。輸入組態 / 版本和受測件(兩者的初始值都是執行中最常記錄的值)。
  2. 在套件卡片上開啟⋯,然後選擇測試報告…。或開啟⋯ → Test Cycles…(測試週期),然後在某個週期上按一下報告…。
  3. 在匯出測試報告中選擇測試週期,並在匯出為中選擇Test report (Word)、(Excel)、(CSV)或(HTML),然後按一下匯出。

Word 報告(預設)包含下列章節:

  1. Identification(識別):測試套件、測試週期、結果的儲存時間以及報告的製作時間。
  2. Test Environment and Configuration(測試環境與組態):組態或版本、受測件、測試人員和執行日期。
  3. Summary of Results(結果摘要):依狀態的計數和通過率。
  4. Results by Test Case(各測試案例結果):每個測試案例一列。
  5. Detailed Results(詳細結果):每個測試案例的預期與實際結果、測試人員、日期、組態、受測件、證據檔案和步驟結果。
  6. Deviations and Open Issues(偏離與未解決問題):失敗和受阻的測試案例及其關聯的 Issue。
  7. Test Evidence(測試證據):在該週期中記錄的證據檔案。
  8. Requirement Verification Status(需求驗證狀態):該套件驗證的需求,以及依此週期結果得出的狀態。

Excel 提供三個工作表(Results、Steps、Requirements);CSV 和網頁提供結果表格。結果來自所儲存的週期,因此套件重設後報告保持不變。名稱、已驗證的需求和 Issue 來自目前的模型。在開始保留步驟結果和證據之前儲存的週期,這些欄位顯示為「—」。

若要將結果表格放入文件,請插入測試報告矩陣區塊(請見上文)。

標示文件和匯出

機密等級標示是 Holarch 列印在您匯出的所有內容上的文字:每頁頂端的頁首、每頁底部的頁尾,以及第一頁上的聲明。為專案或組織設定一次,每項匯出都會帶有它。文件可以用自己的標示取代它。

注意:託管服務 (app.holarch.app) 不能保存 CUI、機密或出口管制資訊(使用條款)。在該服務中,標準清單不包含 Distribution Statement B 至 F 和出口管制聲明,而指出 CUI、機密等級(例如 SECRET//NOFORN)、ITAR、EAR 或出口管制,或 Distribution Statement B 至 F 的機密等級標示不會被儲存:「Holarch 的託管服務不能保存 CUI、機密或出口管制資訊,因此此處不能使用此機密等級標示。請移除它,或使用桌面應用程式或自行託管的安裝。」Company Confidential、Distribution Statement A、著作權和合約編號等公司聲明仍可使用。此規則實施前設定的機密等級標示會保留並照常列印;若要變更,請移除受限制的部分。

桌面應用程式和自行託管的安裝提供完整清單,並接受任何機密等級標示。機密等級標示是您選擇的文字;Holarch 會列印它們,但不會強制執行處理規則,您組織自己的管控措施適用。在每個版本中,機密等級標示中的出口管制聲明都會關閉該專案的 AI。

標準機密等級標示清單會為您填入文字:

標準機密等級標示標題頁尾聲明
Company ProprietaryCOMPANY PROPRIETARYCOMPANY PROPRIETARY指出公司的專有權聲明
Company ConfidentialCOMPANY CONFIDENTIALCOMPANY CONFIDENTIAL指出公司的保密聲明
Distribution Statement A 至 F(B 至 F:僅限桌面應用程式和自行託管)(無)DISTRIBUTION STATEMENT A to F該聲明的標準 DoD 措辭 (DoDI 5230.24),並填入原因、認定日期和管控單位
出口管制聲明(ITAR/EAR)(僅限桌面應用程式和自行託管)(無)Export-controlled technical data. See the notice on the first page.(出口管制技術資料。請參閱第一頁的聲明。)警告文件可能包含受 ITAR (22 CFR 120–130) 或 EAR (15 CFR 730–774) 管制的技術資料
著作權(無)© 年份 著作權所有人. All rights reserved.(無)
合約編號(無)Contract No. 合約編號(無)

您留空的填寫欄位會以方括號預留位置保留在文字中,例如 [reason]。編輯器隨後會顯示「匯出前請完成方括號中的部分。」

設定專案機密等級標示

  1. 按 ⌘K / Ctrl+K,然後選擇專案機密等級標示…。您也可以從文件中的版面設定…,或從開啟專案的專案偏好設定…(首頁上的首頁 ▾)開啟它。
  2. 選擇自有機密等級標示。
  3. 在標準機密等級標示中選擇一個項目,填入其欄位(例如公司),然後按一下新增至機密等級標示。

    您會看到頁首、頁尾和聲明已填入。再新增一個項目即可組合:頁首和頁尾以「 · 」連接,每個聲明各成一段。

  4. 視需要編輯文字,然後按一下儲存。

    快顯通知顯示「已儲存專案機密等級標示。」只有專案擁有者可以變更專案機密等級標示;其他成員只能唯讀檢視。

清除會清空這三個欄位。無機密等級標示會關閉專案的機密等級標示,即使組織有設定也一樣。

設定組織機密等級標示

  1. 開啟帳戶選單並選擇組織設定,然後開啟該組織。
  2. 在文件機密等級標示下,按一下編輯機密等級標示…。
  3. 依照專案的方式設定機密等級標示,然後按一下儲存。

    快顯通知顯示「已儲存組織機密等級標示。」它適用於組織中每個沒有自有機密等級標示的專案。只有組織管理員可以變更它。

為文件設定自有的機密等級標示、封面頁和頁碼

  1. 在文件中開啟交付 ▾,然後選擇版面設定…。
  2. 在機密等級標示下選擇一項:
    • 專案或組織機密等級標示(預設):下方一行指出文件使用的機密等級標示。
    • 自有機密等級標示:依照專案的方式設定頁首、頁尾和聲明。
    • 無機密等級標示:文件及其匯出不帶任何機密等級標示。
  3. 填入其餘欄位:
    • 封面頁,附版本和編製者。封面頁也會顯示聲明。
    • Word 匯出中的頁碼(「Page X of Y」)。
  4. 按一下套用。

    快顯通知顯示「已儲存版面設定。」頁首和頁尾出現在文件的頂端和底部,聲明則在其標題下方。⌘Z / Ctrl+Z 可一步復原此變更。

最接近的機密等級標示優先:文件自有的,否則是專案的,否則是組織的。

機密等級標示的列印位置

  • 文件檢視和列印或 PDF…:頁首和頁尾位於每頁的頂端和底部,聲明位於標題下方。
  • Word 匯出(交付 ▾ → {template} (Word),或所有匯出…中的文件 (Word)):頁首和頁尾在每頁重複,若有選擇則附頁碼,封面頁取代純標題。文件中的即時矩陣區塊會成為 Word 表格,標題位於其上方,欄寬和 I/A/D/T 標題相同,缺口以紅色底色標示。
  • 匯出矩陣和Traceability matrix (Word)或(HTML)。
  • 其他 Word 檔案:ICD 文件、簡報、圖和分解 (Word)匯出會在每頁帶有頁首和頁尾,並在標題下方帶有聲明。
  • Excel 報告:頁首和頁尾放入每個工作表的頁首和頁尾,Excel 會在整頁模式中顯示並列印。
  • CSV:僅在表格 (CSV)中勾選首行顯示機密等級標示時。預設為關閉,因此檔案可以原樣再次匯入。
  • 圖的影像:PNG 和 SVG 匯出會在圖的上方加上帶有頁首的色帶,下方加上帶有頁尾和聲明的色帶。網頁 (HTML)匯出會在頁面頂端和底部顯示它們。縮圖和文件內的圖片不加標示。
  • 簡報:PowerPoint、網頁、PNG 和 SVG 投影片會在每張投影片上顯示頁首和頁尾,並在第一張投影片上顯示聲明。
  • 彙編有自己的版面設定,在匯出彙編時使用。

模型檢查

模型檢查會回報指向已刪除內容的即時值或即時表格(規則 Global.7,「Live values pointing to missing targets」,即時值指向不存在的目標):

  • 實體已刪除的即時值會顯示「{Entity: … Not found}」。
  • 範圍文件已刪除的矩陣區塊、測試套件或測試週期已刪除的測試報告區塊,或關係已不存在的自訂矩陣。
  • 查詢中指出不存在之類別、標籤、關係或文件的計數或合計或即時表格。
  • 項目、圖或表已刪除的交互參照。

開啟說明,然後編輯或移除即時值,或針對存在的目標重新插入。請參閱模型檢查。

提示

  • 將 RVTM 或 VCRM 放在規格的結尾作為其驗證章節;它會保持最新直到審查為止。
  • 對於審查套件,請建立彙編,並在其自己的版面設定中為其設定封面頁和機密等級標示。
  • 將 VCRM 匯出至 Excel 供審查委員會加註,並在文件中保留即時區塊。
  • 對於依整合層級組織的驗證計畫,請使用依驗證層級的 VCRM,並先設定每個需求的驗證等級。
  • 對於介面控制文件,請插入範圍為系統 Asset 的介面矩陣,讓其子項目及其 Conduit 出現在對角線和儲存格中。