需求
需求
撰寫、檢查、核准、建立基準線並匯入需求,並追蹤未結的 TBD/TBR 項目和待審查的關聯。
概觀
使用需求頁面撰寫、檢查、核准需求並建立其基準線,以及追蹤仍未結的事項。需求是 LML 類別 Requirement 的實體:系統必須具備的能力、特性或品質因素。
需求通常位於需求文件中(請參閱文件)。每個需求仍然是模型中的一個實體。因此同一個需求會出現在資料庫、圖、可追溯性矩陣與 RVTM 中。
導覽列中的需要與需求群組包含所有需求頁面:
| 頁面 | 顯示的內容 |
|---|---|
| 文件 | 規格及其大綱。需求在這裡撰寫。 |
| 需求 | 所有需求在同一個表格中(篩選為 class:Requirement 的資料庫)。 |
| 品質 | 需求品質:每個需求依九項準則計算的分數。 |
| TBD/TBR | 仍待確定或審查之未結值的登錄表。 |
| 待檢查的連結 | 上游需求在關聯上次審查之後已變更的關聯。 |
| 核准 | Status 為 In Review 的需求。 |
| 匯入和匯出 | 透過單一拖放區匯入 Word、Excel、CSV、ReqIF、純文字、XMI 與專案檔案,以及模型匯出。 |
基準線是用於審查的凍結快照。可從文件或從控制與審查 → 基準線和版本建立。與功能、資產與測試的關聯請參閱可追溯性。
概念
Requirement 與 Statement
Statement 是 Requirement 的父類別。
- 對不具約束力的文字使用 Statement:章節標題、假設、背景。
- 對每個具約束力的「shall」陳述使用 Requirement。
只有 Requirement 會由品質檢查評分、列在 TBD/TBR 登錄表上、在變更時標記為待審查,並計入 RVTM。Statement 會被略過。
需求具有通用的實體欄位編號、名稱與描述。描述就是需求陳述本身,為格式化文字。下列屬性補足其餘內容。
需求屬性
| 屬性 | 類型與值 | 意義 |
|---|---|---|
| 理由 | 長文字 | 需求背後的理由。 |
| 狀態 | Draft、In Review、Approved、Rejected | 需求在核准工作流程中所處的位置。 |
| Priority | High、Medium、Low | 需求對利害關係人的重要程度。 |
| Criticality | High、Medium、Low | 未滿足該需求時對任務或安全的後果。 |
| 擁有者 | 文字 | 負責該需求的人員或團隊。 |
| 來源 | 文字 | 需求所出自的利害關係人、文件或標準。 |
| Verification Method | 多選:Analysis、Demonstration、Inspection、Test | 需求的驗證方式。 |
| Verification Level | Component、Subsystem、System | 驗證需求時的組裝層級。 |
| Success Criteria | 長文字 | 顯示需求已滿足的可量測結果。 |
| TBD/TBR | None、TBD、TBR | TBD = 值仍待確定;TBR = 值待審查。關閉時設回 None。 |
| TBD Owner | 文字 | 負責關閉 TBD/TBR 的人員。 |
| TBD Due Date | 日期和時間 | 必須關閉 TBD/TBR 的日期。工作流程群組中的到期日會顯示並設定同一個日期(請參閱TBD/TBR 登錄表)。 |
| Quality Score | 百分比,計算值 | 上次「檢查品質」的結果。 |
| Appropriate、Complete、Conforming、Correct、Feasible、Necessary、Singular、Unambiguous、Verifiable | 是/否,計算或手動設定 | 九項品質準則。 |
屬性面板會將需求的欄位分組(請參閱屬性面板):Requirement(編號、名稱、描述、標籤、理由、來源、成功準則)、工作流程(含 Status 的審查列、Priority、Criticality、Owner、負責人、到期日、TBD/TBR、TBD Owner、TBD Due Date)、驗證(驗證方法與等級、Verified by,以及正式計畫的結案欄位)、值(預算數量、門檻值、目標值與目前值、單位)、符合性(正式計畫)與品質。
分數與九項準則位於品質群組中,一開始為摺疊狀態。其標題會顯示例如「89% · 9 項中符合 8 項」,或「尚未檢查」。Holarch 會依類別記住您是否讓該群組保持開啟。
專案可以新增自己的需求屬性與選項;請參閱結構描述擴充。
需求標籤
標籤可在不變更類別的情況下為需求分類。內建的需求標籤為:
- Functional Requirement、Performance Requirement、介面需求。
- Environmental Requirement、Reliability Requirement、Safety Requirement。
- Verification Requirement。
- Stakeholder Need:由利害關係人陳述的需要,在轉換為系統需求之前。
Verification Method 也是一個標籤群組,含標籤 Analysis、Demonstration、Inspection 與 Test。標籤與屬性會在同一個復原步驟中保持同步:
- 新增標籤 Test 會將 Verification Method 設為 Test。
- 在屬性中選擇 Test 會新增該標籤。
只帶有標籤的舊專案與匯入,會在專案開啟時合併到屬性中。
需求工作流程
每個需求會經過四種狀態:
- Draft:撰寫中。
- In Review:等待決定。列在「核准」頁面上。
- Approved 或 Rejected:已決定。每項決定都會記錄決定者、時間與選填的原因。
核准之後,有三種機制確保記錄真實:
- 編輯後重新審查。編輯 Approved 需求的名稱或描述會將其移回 In Review,並附註「核准後文字已變更」。
- 品質過期。編輯名稱或描述會將其品質結果標記為已過期,並清除手動品質覆寫。
- 待審查的關聯。編輯名稱、描述或關鍵屬性會將通往其下游項目的關聯標記為待審查。
這三者都屬於該次編輯,因此按一次復原(⌘Z / Ctrl+Z)會一起還原它們。
未結項目:TBD、TBR 與 TBS
未結項目是尚未確定的值。下列任一條件成立時,需求即為未結項目:
- 其 TBD/TBR 屬性為 TBD 或 TBR。
- 其名稱或描述包含 TBD、TBR 或 TBS 一詞。
未結項目會出現在 TBD/TBR 登錄表上,直到關閉為止。
基準線
基準線是唯讀快照。有兩種:
- 文件基準線包含一份文件。它包括文件成品、其項目及其屬性、與它們相關的關係、相隔一層的實體,以及文件的大綱設定。
- 專案基準線包含專案中的所有實體與關係。
基準線可以帶有核准記錄(姓名、角色、聲明、日期)。記錄一經儲存即被鎖定。
使用方式
使用時機與原因
需求工作涵蓋系統工程 V 模型的左側:
- 擷取利害關係人的需要。
- 推導系統需求。
- 檢查每個陳述是否格式正確。
- 讓需求獲得核准。
- 在審查(SRR、PDR、CDR)時凍結它們。
基準線之後,工作轉向變更管制。每項變更都會重新審查,並檢查其下游影響。未結的 TBD/TBR 值會在設計定案之前關閉。
需求頁面會回答下列問題:
| 問題 | 頁面 |
|---|---|
| 每個需求是否都寫得好? | 品質 |
| 哪些值仍未知、由誰負責、是否已逾期? | TBD/TBR |
| 因為某個需求變更,有哪些必須重新檢查? | 待檢查的連結 |
| 有哪些在等待決定? | 核准 |
| 自審查以來有哪些變更? | 文件的版本 ▾ → 比較版本…、基準線和版本 |
| 每個需求是否都已分配並驗證? | 可追溯性矩陣與 RVTM |
「品質」、「待檢查的連結」、「TBD/TBR」與「核准」頁面在導覽列的需要與需求下彼此相鄰。從那裡依序完成這四項檢查。
撰寫需求
- 開啟需要與需求 → 文件。
- 開啟需求文件。
若要開始新文件,請按一下 + 新增文件(請參閱文件)。
- 在文件下方的快速新增列中,選擇項目要放的位置,例如 Under 3 Electrical Power。
- 輸入需求陳述並按 Enter。
Holarch 會新增一個文件預設類別的項目(在需求文件中為 Requirement)。它會接在其同層項目之後編號。
- 選取該需求後,開啟右側的屬性面板。
- 在 Requirement 群組中填入理由、來源與成功準則,在工作流程中填入優先順序、Criticality 與擁有者,在驗證中填入Verification Method 與驗證等級。
- 以屬性面板 Requirement 群組中的 + 標籤新增類型標籤,例如 Performance Requirement。(標籤欄位於檢視 ▾ → 欄 ▸之下。)
該需求的 Status 為 Draft,並出現在需要與需求 → 需求上。
若某個值尚未知:
- 在陳述中寫下您的最佳估計。
- 將 TBD/TBR 設為 TBD。
- 填入 TBD Owner,並在工作流程群組的到期日中設定日期。
該需求現在也會以該到期日出現在 TBD/TBR 登錄表上。
檢查措辭
- 開啟需要與需求 → 品質。
從文件中,改為選擇檢查 ▾ → 檢查品質。
- 在範圍列中,選擇所有需求或文件:<name>。
- 按一下頁首中的檢查品質。
通知會顯示「已檢查 32 個需求」(或您的數量)。每個需求都會得到 0 到 100% 的分數,以及每項準則的 ✔ 或 ✘。
需求超過 2,000 個時,檢查會在背景中執行:進度卡片會顯示「正在檢查需求」、數量與剩餘時間,您可以繼續工作。按一下卡片上的取消即可停止;不會有任何變更。接著卡片會顯示「正在儲存品質結果」與已儲存的數量;儲存期間,其他編輯會被拒絕,並顯示「正在儲存品質結果。完成後再試一次。」只有結果有變更的需求才會被儲存,因此在沒有變更的情況下再次檢查不會儲存任何內容。整個檢查是一個步驟:按一次 ⌘Z / Ctrl+Z 即可移除它。
- 閱讀圖磚:需求、平均分數、良好 (≥ 67%)、需要重工 (< 67%),以及存在時的已過期(文字已變更)。
- 對於每個低於 67% 的需求,請閱讀建議欄。
或指向 ✘ 以查看該準則的訊息。
- 按一下需求的名稱以開啟它,並修正文字。
- 再次執行檢查。
Correct 與 Feasible 一律需要人的判斷。無論其他檢查發現什麼,檢查永遠不會將它們標記為符合。因此自動檢查最多達到 9 項準則中的 7 項(78%)。沒有驗證測試或需求的需求最多達到 9 項中的 6 項(67%)。對於每個需求,請自行判斷它們:
- 審查需求後,按一下 ✘ 即可將該準則標記為「是」。
- 若要取得初步意見,請使用 ✦ AI ▾ → 用 AI 檢查(N 個需求)…(AI 需求檢查)。
附註:舊版本儲存的分數可能在其他檢查失敗時仍將 Correct 或 Feasible 計為符合。請再次執行檢查以更新它們。
以 EARS 範本撰寫
EARS(Easy Approach to Requirements Syntax,需求語法簡易法)將每個需求寫成一個句子:一個選用的條件,接著是「the [system] shall [response]」。條件的第一個字決定模式。
| 模式 | 範本 | 範例 |
|---|---|---|
| Ubiquitous | The [system] shall [response]. | The pump controller shall record every start command with its time.(泵浦控制器應記錄每個啟動命令及其時間。) |
| Event-driven | When [trigger], the [system] shall [response]. | When the tank level falls below 20 %, the pump controller shall start the backup pump.(當水箱液位低於 20 % 時,泵浦控制器應啟動備用泵浦。) |
| State-driven | While [state], the [system] shall [response]. | While the vehicle is charging, the battery manager shall keep each cell below 45 °C.(車輛充電期間,電池管理器應使每個電芯保持在 45 °C 以下。) |
| Unwanted behavior | If [unwanted condition], then the [system] shall [response]. | If the supply voltage drops below 10 V, then the flight computer shall switch to the reserve battery.(若供電電壓降至 10 V 以下,飛行電腦應切換至備用電池。) |
| Optional feature | Where [feature is included], the [system] shall [response]. | Where a heated windshield is fitted, the climate controller shall clear frost within 5 minutes.(若裝有加熱擋風玻璃,空調控制器應在 5 分鐘內清除結霜。) |
| Complex | While [state], when [trigger], the [system] shall [response]. | While the drill is in standby, when the operator presses Start, the drill controller shall reach full speed within 3 s.(鑽機處於待機狀態時,當操作員按下 Start,鑽機控制器應在 3 s 內達到全速。) |
- 在屬性面板或項目檢視中開啟需求。
- 按一下描述旁的 EARS ▾。
第一行會顯示陳述的模式(✓ Event-driven)或需要修正的內容(無 EARS 模式:1 項待修正)。
- 選擇一個模式。
其範本會成為描述。若需求已有描述,請以取代確認;舊的陳述會保留在項目的歷程記錄中。按一次 ⌘Z / Ctrl+Z 即可復原。
- 取代方括號中的文字。
若要檢查所有需求,請在模型檢查 → 設定中將 Requirement.11 設為警告或錯誤。預設為關閉。
在 SysML v2 專案中,EARS ▾ 位於屬性面板中需求的說明文件之下,並寫入其 doc 註解。
核准需求
- 需求就緒時,將其 Status 設為 In Review。
可在屬性面板(工作流程群組審查列中的 Status)、資料庫或文件欄中進行。
- 審查者開啟需要與需求 → 核准。
此頁面會列出 Status 為 In Review 的每個需求。
- 按一下某一列。
屬性面板的工作流程群組會顯示審查列:Status、設定者與設定時間(「by J. Rivera · Mar 9, 2026 at 9:58 AM」)以及按鈕。
- 按一下核准。
或按一下拒絕…並輸入選填的原因。
通知會顯示「已核准」或「已拒絕」。該決定會連同您的姓名與時間一起記錄,且該需求會離開「核准」清單。
當需求位於基準線中,且有驗證項目或文件追溯到它時,核准會先開啟一個對話方塊,在需要重新審查下列出它們(影響)。按一下某一列即可查看,然後按一下核准確認。
若要將已決定的需求送回審查,請按一下重新開啟。通知會顯示「已移至 In Review」。
若專案在需求 Status 上設有工作流程(結構描述 → 工作流程),審查列會顯示該工作流程的轉換,而不是核准、拒絕…與重新開啟。需要核准的轉換以 … 結尾,並會開啟請求核准:請參閱請求核准狀態變更。對於已建立基準線的需求,請求核准與變更請求的核准…對話方塊會顯示相同的需要重新審查清單。
凍結文件以供審查
- 在文件的標題欄中,按一下版本 ▾。
- 選擇儲存基準線…。
或選擇交付 ▾ → 版本 ▸ 儲存基準線…。
- 保留或變更名稱。預設為「<document> Baseline <n>」。
- 在核准下,為每位核准者填入一列:名稱、角色與聲明(預設為「Approved for release.」)。
+ 新增核准者會新增一列;× 會移除一列。
- 按一下建立。
通知會顯示「已儲存基準線」。版本 ▾會顯示「目前 · 最新基準線 <name>」。
從現在起,每一列與最新基準線不同時都會出現變更標記。
處理基準線之後的變更
- 在文件中編輯需求文字。
通知會摘要發生的情況,例如「1 個已核准需求已移至 In Review;6 個關聯已標記為待審查。」作為您編輯的一部分(一次復原即可全部撤回):
- Approved 需求會移至 In Review。
- 其品質結果會變為已過期(「品質:已過期 — 重新執行」)。
- 其下游關聯會被標記為待審查。
- 開啟需要與需求 → 待檢查的連結。
- 對每一列按一下差異以查看文字變更,並審查已關聯的項目。
- 當已關聯的項目仍然成立時,請按一下其列上的標記為已審查…。
若要一次標記多個,請選取其列並按一下將所選項目標記為已審查…。
- 寫下您檢查的內容,然後按一下標記為已審查。
- 再次執行「檢查品質」。
- 將需求重新送交核准。
- 按一下版本 ▾ → 比較版本…,在自下選擇基準線,在至下選擇目前版本。
報告會列出自基準線以來的每項變更。
- 按一下變更 (Excel) 以取得供變更委員會使用的檔案。
關閉 TBD 與 TBR 項目
- 開啟需要與需求 → TBD/TBR。
- 閱讀圖磚:未結 TBD/TBR、已逾期、無擁有者,以及每份文件的數量。
- 先處理已逾期的列。它們會加上色調,並在到期日下方顯示「已逾期」。
- 在擁有者顯示「—」的地方,指派 TBD Owner。
- 值確定後,將需求文字編輯為最終值。
- 按一下該列上的關閉。
「關閉」會將 TBD/TBR 設為 None,且該列會離開登錄表。
若要將登錄表傳送給擁有者,請按一下匯出 XLSX。
匯入現有的規格
- 開啟需要與需求 → 匯入與匯出。
- 將檔案拖放到拖放區上,或按一下拖放區以選擇檔案:Word (.docx)、Excel 或 CSV、ReqIF 或純文字。
狀態列會顯示例如「已分析「SRS.docx」:48 列、5 欄。」格式會顯示偵測到的格式。
- 按一下繼續。
- 檢查每一欄對應到什麼,並將無類別的列所用的類別設為 Requirement。
- 按一下繼續。
- 保持勾選從這 N 個需求建立需求文件,檢查文件類型與名稱,並檢查新項目、已更新的項目與警告。
- 按一下匯入 N 個項目。
沒有警告時,Holarch 會開啟新文件。有警告時,匯入完成卡片會列出它們。
匯入完成卡片有按鈕可開啟文件、資料庫、Spider 圖或樹狀圖,或「檢查品質」。按一次 ⌘Z / Ctrl+Z 即可移除整個匯入。
實例演練:CubeSat EO-1 示範
從管理專案建立示範專案 CubeSat EO-1 — Earth Observation Demo。它有一份含 32 個需求的規格 SRS-001 EO-1 System Requirements Specification,附有 SRR 基準線以及其後所做的變更。
品質。
- 開啟需要與需求 → 品質並按一下檢查品質。
圖磚顯示 32 個需求、平均 92%、29 個良好與 3 個需要重工。
這三個較弱的需求是刻意這樣寫的。每個得分 44%:
- 2.5 Safe Mode Recovery:「The spacecraft should recover from safe mode quickly and resume imaging as appropriate」。建議包括:
- 「R34 - 無法量測的效能用語:[quickly]」
- 「R8 - 例外條款削弱了需求:[as appropriate]」
- 「R19 - 合併了兩個需求;請將其拆分為獨立的需求:[and]」
- 「以句號結束陳述。」
- 「關聯一個驗證它的 Test Case 或 Requirement。」
- 3.5 Battery Thermal Control:「…keep the battery warm enough (TBD).」建議為「R21 - 包含括號;請將括號中的文字移至 Rationale。」與「取代 TBD/TBR 預留位置。」
- 6.4 Operator Interface:「…shall be user friendly and/or easy to use.」建議為「R34 - 無法量測的效能用語:[user friendly, easy to use]」與「R19 - 「and/or」有歧義;請說明是兩者皆是還是其中之一:[and/or]」。
若要修正 2.5:
- 將其改寫為「The spacecraft shall resume imaging within 6 hours of a safe mode entry.」
- 以 verified by 關聯一個測試案例。
- 再次執行檢查。
組合詞、例外條款與模糊用語的訊息會消失。
TBD/TBR。開啟 TBD/TBR。它顯示三個未結項目:
- 3.5 Battery Thermal Control:由 Thermal Engineer 負責的 TBD。它已逾期。
- 2.4 Target Slew(ADCS Lead)與 5.3 Downlink Link Margin(Comms Lead):較晚到期的 TBR。
基準線之後的變更。文件的版本 ▾會列出 SRR Baseline。它由 J. Rivera(Systems Lead)、R. Okafor(Mission Principal Investigator)與 L. Brandt(Program Manager)核准。
SRR 之後,需求 3.1 Orbit Average Power 從 28 W 變更為 30 W。由於 3.1 為 Approved,它已移回 In Review,並附註「核准後文字已變更」。
待檢查的連結列出來自 3.1 的六個關聯:
- 1.3.1 Solar Arrays
- F3 Generate and Store Power 與 F3.1 Convert Sunlight to Power
- EQ-1.1 Solar Power Generation 與 EQ-1.4 Power Margin Check
- TC-06 Solar Array Power Test
按一下任一列上的差異:「28 W」被劃掉,並插入「30 W」。然後審查這些項目:
- TC-06 預期峰值功率 ≥ 72 W,量測值為 75.1 W。透過 EQ-1.3 Orbit-Average Array Power(峰值 × 0.62 日照比例 × 0.6 電力路徑效率),75.1 W 相當於 27.9 W 軌道平均,低於新的 30 W。請讓該關聯保持未審查,並新增留言「75.1 W peak = 27.9 W orbit average; re-test against about 80.6 W peak」。該測試需要新的預期結果與新的執行。
- 在將 1.3.1 標記為已審查之前,請確認太陽能陣列的尺寸設計仍然成立。
與目前比較。在版本 ▾中選擇 SRR Baseline,然後按一下其橫幅中的與目前比較。報告會列出:
- 3.1 的 Description、Rationale、Status 與 Quality Score 變更。
- 2.4 Target Slew 的 Status 變更(Draft → In Review)。
- 新需求 4.4 Downlink Encryption,以及其兩個新的 satisfies 關聯。
核准。開啟核准。有九個需求為 In Review,包括 3.1、1.5 Daily Collection Volume 與 5.3 Downlink Link Margin。
提示與良好做法
- 每個需求寫一個「shall」,使用主動語態,並附數字、單位與條件。品質檢查正是獎勵這種寫法。
- 將理由放在 Rationale 中,而不是放在陳述中。目的片語(「so that」、「in order to」)與括號會被標示為 R20 與 R21。
- 撰寫時就填入 Verification Method。如此一來,有方法但沒有測試案例的需求在 RVTM 中會顯示為 Planned-only,而不是 Unverified。
- 以擁有者與到期日設定 TBD/TBR,而不只是在文字中輸入「TBD」。該屬性為登錄表提供可追蹤的擁有者與到期日。
- 在每次審查之前建立基準線。變更標記與與目前比較只能對照基準線運作。
- 以留言將關聯標記為已審查。留言會新增到已關聯的項目並記錄在關聯上,因此審查會留下稽核軌跡。
常見錯誤
| 症狀 | 原因 | 修正方式 |
|---|---|---|
| 某個需求沒有被評分、不在登錄表上或不在 RVTM 中。 | 它是 Statement,不是 Requirement。 | 在屬性面板中將其類別變更為 Requirement。 |
| Correct 與 Feasible 在每個需求上都顯示 ✘。 | 它們需要人的判斷(「需要審查者的判斷」)。 | 審查每一個並按一下 ✘ 以將其標記為「是」,或執行 AI 需求檢查。 |
| 分數顯示「已過期 — 重新執行」。 | 文字在上次檢查之後已變更。 | 按一下檢查品質,或開啟文字變更時自動重新檢查。 |
| 手動的是/否覆寫消失了。 | 編輯文字會清除它們。 | 審查後請重新設定;復原可還原它們,且它們會保留在歷程記錄中。 |
| 修正錯字後需求不再是 Approved。 | 任何名稱或描述的編輯都會重新開啟已核准的需求。 | 再次核准它。請在核准之前修正錯字。 |
| TBD/TBR 列上缺少「關閉」。 | 該未結項目僅來自文字。 | 編輯文字以移除 TBD、TBR 或 TBS。 |
| 匯入建立了副本而不是更新。 | 依下列比對現有實體沒有比對成功。 | 以 ID 欄匯出、編輯,然後以依下列比對現有實體:全域 ID 匯入(請參閱從試算表更新需求)。 |
與其他功能的關聯
- 資料來源:透過匯入取得的利害關係人輸入與現有規格,以及在文件中撰寫的文件。
- 提供資料給:
- AI:文件與項目檢視的 ✦ AI ▾ 選單有「清楚改寫…」、「新增可量測準則…」、「簡化…」、「拆分複合需求…」、「草擬理由…」、「建議名稱…」與「用 AI 檢查」(AI 需求檢查)。AI 變更在套用前會先預覽。請參閱詢問 AI 與 AI 工具。
「需求」頁面
使用「需求」頁面在一個表格中查看並編輯所有需求。需要與需求 → 需求就是篩選為 class:Requirement 的資料庫。
資料庫的每項功能在這裡都可以使用:
- 排序與篩選欄,並就地編輯儲存格。
- 選取列以使用大量操作列,一次為多個需求設定屬性或標籤。
- 匯出,並為選取的列開啟可追溯性矩陣。
按一下某一列即可在屬性面板中顯示該需求。按兩下即可開啟其項目檢視。有待審查關聯的需求會在其列上顯示 ⚠ 審查徽章。在列上按右鍵即可開啟其選單:最多三項建議動作及其原因(例如需求未通過 Unambiguous 時的 ✦ 新增可量測準則…,未驗證時的 ✦ 產生測試案例…)、✦ 更多 AI ▸,接著是開啟、重新命名…、複製、新增子項目…、Status ▸、Priority ▸、關聯至 ▸、新增至文件 ▸、在圖中顯示 ▸、複製連結、複製編號與刪除…(請參閱右鍵選單)。
表格、查詢與大量編輯請參閱模型與資料庫。
實用的查詢:
| 查詢 | 顯示內容 |
|---|---|
class:Requirement | 所有需求。 |
Requirement:"Status=In Review" | 「核准」清單。 |
Requirement:"Status=Draft" | 尚未送審的需求。 |
class:Requirement AND is:leaf | 葉需求(沒有子需求)。 |
class:Requirement AND NOT relationship:"verified by" | 沒有驗證項目的需求。 |
需求品質
使用品質頁面(標題為「需求品質」)找出措辭不佳的需求。它會依九項準則為每個需求評分。
九項準則與建議中的規則編號(R2、R19 等)依循 INCOSE Guide to Writing Requirements 中的特性與規則。Holarch 的字詞清單與模式是這些規則的近似;它們不是該指南的原文,且部分規則需要審查者的判斷。
- 分數 = 100 × (符合的準則數)/ 9,四捨五入。未檢查的準則(–,請參閱其他語言的需求)不計入:100 × 符合數 / 8。
- 67% 以上為良好。低於 67% 為需要重工。
- 長條在低於 34% 時為紅色,34% 到 66% 為黃色,67% 以上為綠色。
頁面版面配置
- 頁首:
- 更多 ▾:清除手動評等會重設所顯示需求的每個手動是/否,並重新執行檢查。在「需求」中開啟會在「需求」表格中開啟所顯示的需求。範圍為文件時會出現開啟文件。
- 匯出 ▾:所顯示需求的 Excel (.xlsx) 與 CSV。
- 檢查品質:檢查範圍內的每個需求,不論篩選顯示什麼(重複規則會將每個需求與範圍內的其他需求比較)。
- ✦ AI ▾(在頂端列中):用 AI 檢查(N 個需求)…,即對所顯示需求的 AI 需求檢查。
- 範圍列:範圍(所有需求或文件:<name>)與勾選方塊文字變更時自動重新檢查。待檢查的連結、TBD/TBR 與核准在導覽列中位於品質旁。
- 查詢列:+ 篩選、篩選晶片與搜尋文字、清除、?(搜尋語法)與檢視 ▾:與「需求」頁面上的列相同(請參閱篩選「品質」頁面)。
- 圖磚:需求(篩選隱藏部分需求時,在顯示的需求下顯示「12 of 40」)、平均分數、良好 (≥ 67%)、需要重工 (< 67%),以及有過期結果時的已過期(文字已變更)。已過期的分數不計入平均。
- 圖磚下方的附註:「自動檢查最多達到 9 項屬性中的 7 項(78%);Correct 與 Feasible 需要人工驗證 — 按一下 ✘ 以將其標記為「是」。每次按一下會在手動「是」、手動「否」與自動之間循環。」
- 表格:編號、名稱(下方附描述)、品質分數、每項準則一欄,以及建議。「建議」會列出每則訊息,並以其準則為字首。列依編號排序。在列上按右鍵,或在其上按 Shift+F10,即可開啟資料庫列選單:建議動作及其原因(修正未通過準則的改寫排在最前)、✦ 更多 AI ▸、開啟、重新命名…、複製、新增子項目…、Status ▸、Priority ▸、關聯至 ▸、新增至文件 ▸、在圖中顯示 ▸、複製連結、複製編號與刪除…。該列會成為選取項目。
- 多列:⌘ / Ctrl+按一下(Windows 與 Linux 上為 Ctrl+按一下)會切換一列,⇧ / Shift+按一下會選取從上次按一下之列開始的範圍,⌘ / Ctrl+⇧ / Shift+按一下會加入該範圍,而在已取得焦點的列上按 ⌘A / Ctrl+A 或 ⇧ / Shift+↑ / ⇧ / Shift+↓ 會選取所有列或延伸選取範圍。工具列會顯示數量;Esc 會清除選取。在選取的列上按右鍵即可對所有選取列執行動作:✦ 用 AI 檢查(n 個需求)…、✦ 改寫 (n) ▸、✦ 產生測試案例 (n)…、✦ 詢問 AI 關於這些項目 (n)…、✦ 建議追溯 (n)…(每項都有一個預覽;請參閱對多個選取項目使用 AI)、複製 n 個實體、設定 Status ▸、設定 Priority ▸、新增至文件 ▸與刪除 n 個項目…;每項都能以一次復原撤回。TBD/TBR 登錄表與「待檢查的連結」的運作方式相同;在「待檢查的連結」中,選取也會為將所選項目標記為已審查…勾選這些列。
特殊情況:
- 沒有結果的列會在分數欄中顯示「未執行」。
- 已過期的列會顯示「已過期 — 重新執行」。
- 範圍內沒有需求時,頁面會顯示「沒有需求」與「只有 Requirement 類別的實體會被評分;Statement 會被略過。」
- 篩選或搜尋文字隱藏了所有需求時,頁面會顯示「沒有符合的需求」與「沒有需求符合搜尋或篩選。請清除它們以查看所有需求。」
篩選「品質」頁面
查詢列的運作方式與「需求」頁面相同(請參閱輸入的篩選如何變成晶片):按 Enter 時,輸入的篩選條件會變成晶片,其餘文字則比對名稱、編號與描述;在空白搜尋中按 Backspace 會移除最後一個晶片,清除會移除全部。圖磚、表格、匯出 ▾與 ✦ AI ▾ → 用 AI 檢查都會依照篩選。
+ 篩選會列出下列項目,並附範圍內的數量:
| 群組 | 篩選條件 | 條件 |
|---|---|---|
| 品質 | 良好 (≥ 67%)、需要重工 (< 67%)、未執行、已過期(文字已變更)、手動評等、AI 發現事項 | quality:good, quality:rework, quality:notrun, quality:stale, quality:manual, quality:ai |
| 未通過某項準則 | 每項準則一個:評為「否」 | quality:Verifiable=no(=yes:評為「是」) |
| 規則發現事項 | 在範圍內發現的規則,例如 R7 Imprecise wording 或 R30 Closely resembles(可能的重複項目) | quality:R7 |
| 結構、類別、需求屬性、標籤、關係、圖 | 與「需求」頁面相同;需求屬性列出時不附類別晶片 | is:tbd, Requirement:"Status=Draft", label:"…" |
同一群組中的篩選以或結合;不同群組以和結合。分數範圍使用該屬性:Requirement:"Quality Score>=50"。quality: 條件也適用於「需求」頁面與資料庫。
檢視 ▾會套用內建檢視(需要重工、尚未檢查、結果已過期、模稜兩可、不可驗證、可能的重複項目、手動評等)或您已儲存的檢視之一。儲存檢視…會將目前的篩選與搜尋文字儲存在此瀏覽器中,適用於每個專案;使用已儲存的檢視時會出現刪除「<name>」。所有需求會清除篩選。位址 quality?q=<query> 會開啟已篩選的頁面。
篩選會讀取已儲存的結果,不會重新檢查。在 50,000 個需求上,篩選或搜尋的變更所需時間遠低於十分之一秒。
準則與檢查
每項準則會顯示三種標記之一:
- ✔(是):沒有訊息。
- ✘(否):至少有一則訊息。
- –:未檢查。
檢查會比對完整的單字與片語,不區分大小寫。只有列出的形式才算:「effective」與「effectively」都有列出,「effectiveness」則沒有。引號內的字也算。下列訊息是顯示的確切文字。訊息結尾方括號中的清單會列出找到的字詞。
Unambiguous(明確)
| 規則 | 訊息 | 觸發條件 |
|---|---|---|
| R6 | R6 - 無法辨識的單位;請使用標準 SI、美國慣用或英制單位:[...] | 數字後接一個不是已知單位的字(例如「12 sorties」)。已知單位包括 SI、美國慣用與英制單位及其縮寫、%、度、°C 與 °F。 |
| R2 | R2 - 使用主動語態:[...] | 「shall/must/will/should be」後接過去分詞(「shall be measured」)。 |
| R5 | R5 - 使用定冠詞(「the」)取代:[...] | 「a」或「an」。 |
| R7 | R7 - 措辭不精確:[...] | some、many、several、few、little、much、various、appropriate(ly)、adequate(ly)、efficient(ly)、effective(ly)、sufficient(ly)、reasonable、reasonably、suitable、suitably、significant(ly)、minimal(ly)、maximal(ly)、approximately、almost、nearly、generally、usually、typically、normally、robust(ly)、flexible、flexibly、easy、easily、etc、similar、relevant、substantial(ly)、large、small、good、bad、better、best、worst、proper、properly、acceptable、acceptably、accurate(ly)、extreme、high-contrast、high contrast。 |
| R8 | R8 - 例外條款削弱了需求:[...] | if necessary、where possible、as appropriate、as practicable、as far as possible、if practical、as required、as needed、to the extent possible、if possible。 |
| R10 | R10 - 不必要的不定詞片語:[...] | to be designed to、to be able to、to be capable of、to enable、to allow、be able to、be capable of。 |
| R16 | R16 - 避免否定:[...] | not、n't、never。 |
| R17 | R17 - 避免使用斜線符號(「/」)。 | 兩個字之間的斜線,但 km/h、m/s、and/or 及其在德文、法文、西班牙文、義大利文與荷蘭文中的對應形式除外。 |
| R24 | R24 - 使用代名詞而非明確的名詞:[...] | it、its、they、them、their、he、she、him、her、someone、something、anyone、anything、anybody、somebody、this、these、those。 |
| R32 | R32 - 使用「each」取代全稱量詞:[...] | all、any、both、every、everything、everyone。 |
| R34 | R34 - 無法量測的效能用語:[...] | fast、quick、quickly、user friendly、user-friendly、high speed(s)、high-speed、best practice(s)、state of the art、state-of-the-art、seamless(ly)、intuitive(ly)、easy to use、timely、rapid、rapidly、real-time、real time。「Real-time clock」不算:它是元件的名稱。 |
| R35 | R35 - 時間用語不明確:[...] | as、eventually、before、after、until、meanwhile、simultaneous(ly)、soon、later、sometimes、occasionally、often、subsequently、previously。 |
| — | 取代 TBD/TBR 預留位置。 | 描述中的 TBD、TBR 或 TBS(大寫)。 |
| — | AI:有歧義 — <reason> | 來自 AI 需求檢查且已接受的 AI 發現事項。 |
| — | 陳述了最大值(「up to」);若指的是最小值,請使用「at least」。 | 「up to」後接以數字或文字表示的數量(「up to 72 hours」、「up to five tonnes」)。「Up to date」不算。 |
Complete(完整)
| 規則 | 訊息 | 觸發條件 |
|---|---|---|
| — | 缺少描述。 | 描述為空白。 |
| — | 缺少名稱。 | 名稱為空白。 |
| R9 | R9 - 開放式清單用語:[...] | including but not limited to、etc、and so on、and so forth、such as、among others。 |
Singular(單一)
| 規則 | 訊息 | 觸發條件 |
|---|---|---|
| R18 | R18 - 請寫成單一句子(找到 N 句)。 | 超過一個句子(也包括以 。、! 或 ? 結尾的日文與中文句子)。 |
| — | 以句號結束陳述。 | 不以「.」(或 。)結尾的描述。 |
| R19 | R19 - 合併了兩個需求;請將其拆分為獨立的需求:[...] | 連接兩個動作或兩項義務的 and、or、but、however 或 whereas(「shall log and report each fault」、「… and the operator shall …」)、「nor shall」、「;」之後的第二個子句;第二個動作之前的「and/or」。請參閱一項中有兩個需求(R19)。 |
| R19 | R19 - 「and/or」有歧義;請說明是兩者皆是還是其中之一:[and/or] | 數值之間或條件中的「and/or」。 |
| R19 | R19 - 合併了兩個值;若各自分別驗證,請將其拆分:[...] | 在一個動作之後連接兩個對象或值的 and、or(「measure the temperature and the humidity」)。這是附註:Singular 仍為「是」。 |
| R20 | R20 - 包含目的片語;請移至 Rationale:[...] | purpose of、in order to、so that、for the purpose of、so as to。 |
| R21 | R21 - 包含括號;請將括號中的文字移至 Rationale。 | 「(」或「[」(也包括全形括號)。 |
Conforming(符合規範)
| 訊息 | 觸發條件 |
|---|---|
| 使用情態動詞:[need, shall, will, should, must] | 這些字詞都未出現。 |
Appropriate(適當)
| 規則 | 訊息 | 觸發條件 |
|---|---|---|
| R31 | R31 - 指定了解決方案:[...] | using、by means of、utilizing、utilising、implemented in、implemented with、via a、via the、built with、written in。 |
Necessary(必要)
| 規則 | 訊息 | 觸發條件 |
|---|---|---|
| R30 | R30 - 極為相似:[3.2 Battery Capacity (81.3% similar), ...] | 範圍內另一個描述相似度至少 75% 的需求(字元對相似度)。發現事項最多列出五個,其餘則計算數量(「and 3 more」)。需求的直接父項與子項(decomposed by、decomposes)不會進行比較:細化常會重複其父項的措辭。同層需求與無關的需求則會比較。 |
Verifiable(可驗證)
| 訊息 | 觸發條件 |
|---|---|
| 關聯一個驗證它的 Test Case 或 Requirement。 | 該需求沒有連到 Requirement 或 Test Case 的 verified by 關聯。 |
| AI:以目前寫法無法驗證 — <reason> | 來自 AI 需求檢查且已接受的 AI 發現事項。 |
Feasible(可行)
| 規則 | 訊息 | 觸發條件 |
|---|---|---|
| R26 | R26 - 很少能達成的絕對用語:[...] | always、never、100%、100 percent、all the time、totally、completely、absolutely、zero defects、forever、continuous、continuously、uninterrupted。 |
| — | 需要審查者的判斷 | 未發現絕對用語,也未發現近似重複項目;必須由人決定。 |
Correct(正確)
| 訊息 | 觸發條件 |
|---|---|
| 需要審查者的判斷 | 每項文字檢查(Appropriate、Complete、Conforming、Necessary、Singular、Unambiguous)都通過;必須由人決定。 |
由於 Correct 與 Feasible 在有人決定之前都以「需要審查者的判斷」結束,自動評分最高為 9 項中的 7 項(78%)。
一項中有兩個需求(R19)
一個需求只陳述一件事。R19 會檢視每個「and」、「or」、「nor」、「but」、「however」、「whereas」、「as well as」與「and/or」,並將其歸入下列種類之一:
| 種類 | 範例 | 結果 |
|---|---|---|
| 兩個需求 | 「The unit shall log and report each fault.」「The pump shall stop, and the operator shall be alerted.」「… to acknowledge alarms and to silence the horn.」「…; it shall also …」 | 發現事項。Singular 為「否」。 |
| 有歧義的「and/or」 | 「The log shall record the user ID and/or the badge number.」 | 發現事項:請說明是兩者皆是還是其中之一。Singular 為「否」。 |
| 兩個值 | 「The station shall measure the temperature and the humidity.」 | 附註:若各值分別驗證,請將其拆分。Singular 仍為「是」;附註以灰色顯示,不會降低分數。 |
| 無發現事項 | 「between 5 °C and 30 °C」;「When A and B, the unit shall …」;「… when the door is open and the fan is off」;「requirements 2.1 and 2.2」;引用的文字;「The command and control unit shall …」;「ASME Boiler and Pressure Vessel Code」;「5 Nm at 3000 rpm and 24 V」;「including batteries and strap」;「either open or closed」 | 無。 |
同一個量的兩個值(「at -20 °C and 60 °C」)會得到附註。「, and」會結束一個條件:「… when the level falls below 10 %, and restart when …」是發現事項。作為一體行動的主詞(「The Owner and the Contractor shall agree …」、「The power and data connector shall …」)不會得到附註;各自行動的兩個主詞(「The pump and the valve shall close …」)會得到附註。比較用語(「12 or more」)不會被標示。動作之後的名稱無法與兩個值區分,因此請將其列在複合名稱下。
複合名稱。在「品質」頁面上,更多 ▾ → 複合名稱…會開啟專案中包含「and」或「or」但指稱單一事物之名稱的清單,每行一個(例如「power and data connector」)。R19 不會標示它們。專案縮寫詞彙表中的展開形式(Acronym 陳述,請參閱尋找縮寫)也算,並內建一些常見名稱(「command and control」、「research and development」、「operations and maintenance」…)。此清單隨專案儲存,且可復原。再次按一下檢查品質即可套用變更。
其他語言的需求
Holarch 會從文字偵測每個需求的語言。字詞規則(R2–R10、R16、R19、R20、R24、R26、R31–R35、「up to」、情態動詞、單位)用於為英文需求評分。
德文、法文與西班牙文(測試版)。這些需求會以其自身語言套用相同的規則,例如德文的「angemessen」或「bei Bedarf」、法文的「approprié」或「si possible」、西班牙文的「adecuado」或「según corresponda」。某個語言的規則處於測試版期間:
- 每個發現事項都是標示(測試版)的建議。它與其他附註一起以灰色顯示,永遠不會降低準則或分數;
- 會顯示附註「此語言的措辭規則為測試版:僅供建議,不計分。結構檢查仍適用。」,且在以 AI 檢查措辭或手動評等之前,Unambiguous 為 –(未檢查);
- 表示「each」的字(jede、chaque、cada)是正確的選擇,不會被標示,「alle 5 s」或「tous les 5 s」(每 5 s)也不會。
只有在規則以至少 300 個以該語言撰寫的陳述量測過、經以該語言為母語的需求工程師審查(至少 90 % 的發現事項正確),且審查者已簽核後,該規則才會開始對該語言計分。屆時,該語言的分數可能在下次檢查時改變;版本資訊會說明這一點。
其他語言(日文、義大利文、中文及其他)會得到:
- 附註「措辭規則涵蓋英文。結構檢查仍適用。」以及 Unambiguous 的 –(未檢查):在檢查措辭或手動評等之前不計入分數。其他 Unambiguous 發現事項(例如 TBD)仍會使其不通過;
- 適用於任何語言的檢查:R18(也包括 。)、句末句號(也包括 。)、R17、R21、TBD/TBR、R30、名稱、描述與驗證關聯。
每種語言(不論是否為測試版)也都會進行這些檢查。建議以英文儲存,並依原文引用字詞(「R7 - Imprecise wording: [angemessen] (beta)」),因此 quality:R7 篩選與匯出在每種語言中的運作方式都相同。公開 API 會連同其規則、字詞與模式(findings)一起傳回。
用 AI 檢查措辭。「品質」頁面上的 ✦ AI ▾ → 用 AI 檢查措辭…(或單一需求上的 ✦ 更多 AI ▸)會透過設定的 AI,以每個需求自身的語言套用相同的規則。預覽會列出發現事項,以及以該語言撰寫的選用改寫(未勾選)。套用所選項會將發現事項新增為 AI 發現事項並移除附註(測試版建議仍保留為附註),作為一個復原步驟。編輯文字會清除它們。此功能需要含 AI 的方案。
手動覆寫
當您不同意自動結果,或要記錄審查者的決定時,可覆寫某項準則。
- 在「品質」頁面上:按一下準則儲存格即可循環切換:第一次按一下設為手動「是」(✔),下一次設為手動「否」(✘),第三次則清除手動值,讓自動檢查重新決定。手動儲存格會顯示手動標記;其工具提示會說明「(手動設定)」以及下一次按一下的效果。
- 在屬性面板或項目檢視中:每項準則都是一個含是與否的清單。手動設定的準則還會提供自動(重新檢查),將其恢復為自動結果。手動設定的值會顯示「手動」。
重新執行檢查時,手動值會保留。沒有其他訊息的手動「否」會顯示「已手動標記為否。」
覆寫會在兩種情況下被清除:
- 需求的名稱或描述變更。覆寫會保留在歷程記錄中,復原可將其還原。
- 您選擇更多 ▾ → 清除手動評等。這也會清除已接受的 AI 發現事項。
已過期的結果
當需求的名稱或描述在檢查後變更時,其結果會被標記為已過期:
- 「品質」頁面會顯示「已過期 — 重新執行」,工具提示為「文字在上次檢查之後已變更。請再次執行「檢查品質」。」
- 文件的品質分數欄會顯示附時鐘圖示的已過時標籤(指向它可查看原因)。
- 屬性面板會顯示「品質:已過期 — 重新執行」。
開啟文字變更時自動重新檢查即可避免過期的結果。Holarch 接著會立即對編輯過的需求重新執行規則檢查。此設定會保留在此瀏覽器中。
從文件檢查品質
在文件中,選擇檢查 ▾ → 檢查品質。選取了需求時,該項目會顯示為檢查此需求的品質並只檢查該需求。未選取需求時,它會檢查文件中所有可見的需求。
結果會在檢查品質 — <name>對話方塊中開啟,含圖磚與表格。其按鈕為匯出 CSV、匯出 XLSX、在「品質」中開啟與關閉。
沒有需求的文件會顯示「此文件沒有可檢查的 Requirement。Statement 不會被評分。」
AI 需求檢查
對於規則無法判斷的準則(Correct、Feasible 與 Necessary),可使用 AI 需求檢查取得初步意見。它也會在 Unambiguous 下尋找規則遺漏的措辭(例如看似指最小值的「up to 72 hours」,或沒有量測標準的「accurately」),以及在 Verifiable 下尋找問題(以目前寫法,沒有任何測試、分析、檢查或展示能證明需求已滿足)。AI 會收到規則的發現事項,並只報告規則遺漏的內容。
- 選擇 ✦ AI ▾ → 用 AI 檢查(N 個需求)…。
對於單一需求,請在其 ✦ AI ▾ 選單中選擇用 AI 檢查(此需求)…,或在其右鍵選單中選擇 ✦ 更多 AI ▸ → ✦ 用 AI 檢查…。
Holarch 的 AI 會審查這些需求。它們以每組 20 個的方式傳送,並附最多 300 個其他需求以供重複檢查。在內含的 AI 上,檢查每 100 個需求計為一個請求(無條件進位);在執行超過 100 個需求的檢查之前,對話方塊會說明它將使用多少請求,例如「此審查將使用您本月剩餘 52 個內含 AI 請求中的 3 個(每 100 個需求 1 個請求)。」需要的請求數超過剩餘數量時,檢查不會開始。
- 在對話方塊中審查每個需求。
頂端的那一行會說明預設勾選的項目:「已勾選的項目會被套用。改寫一開始不勾選,讓您先閱讀。已鎖定、已核准與已建立基準線的需求一開始不勾選。」
- 勾選您接受的變更與改寫。
按鈕上方的那一行會計算「套用」將執行的內容,例如「將 7 個值與 2 個改寫套用到 5 個需求。」未勾選任何項目時會顯示「未選取任何項目。」,且套用所選項會變暗。
- 按一下套用所選項。
已勾選的項目會套用,一次復原即可全部撤回。通知會顯示「已套用 N 個 AI 變更」。
對話方塊會為每個需求顯示:
- Correct、Feasible、Necessary、Unambiguous 與 Verifiable 的「是/否」判定及原因。
- 每個判定下方有一個勾選方塊,標示套用後會變更的內容;若儲存的值已相符,則顯示「無變更」且不附勾選方塊:
- Correct、Feasible 與 Necessary:判定與儲存的值不同時為「否 → 是」或「是 → 否」,沒有儲存的值時為「設為是」或「設為否」。
- Unambiguous 與 Verifiable:AI 發現問題時為「新增發現事項」,先前的 AI 發現事項不再成立時為「清除先前的發現事項」。
- 選填的留言。
- AI 提出改寫時,會有一個附字詞差異的套用改寫:勾選方塊。
一開始勾選的項目:
- 每個值的變更一開始都會勾選。
- 改寫一開始不勾選,讓您先閱讀。
- 已核准、已建立基準線與已鎖定的需求一開始不勾選,並會加上標示。
勾選改寫會使該需求的 Unambiguous 與 Verifiable 方塊變暗,並將其標示為「改寫後重新檢查」:規則檢查會對新文字重新執行。取消勾選改寫會將方塊恢復原狀。Correct、Feasible 與 Necessary 仍會套用。
| 按鈕 | 效果 |
|---|---|
| 選取所有值變更 | 勾選每個值變更,但已核准、已建立基準線與已鎖定的需求除外。 |
| 選取所有改寫 | 勾選每個改寫,但已標示的除外。 |
| 全部不選 | 取消勾選所有項目。 |
「套用」的效果:
- Correct、Feasible 與 Necessary 會成為手動的「是/否」值。
- Unambiguous 或 Verifiable 的「否」會成為 AI 發現事項:「品質」頁面會將其與規則發現事項一起列出,顯示為「AI:有歧義 — <reason>」或「AI:以目前寫法無法驗證 — <reason>」,且該準則顯示 ✘。「是」會移除先前的 AI 發現事項。
- 當需求的名稱或描述變更時(包括接受的改寫),以及執行更多 ▾ → 清除手動評等時,AI 發現事項會被清除。
套用所選項的效果:
- 判定會成為手動值,並附訊息「AI:<reason>」。重新執行檢查時它們會保留。
- 改寫會取代描述並重新執行檢查。
品質匯出
| 匯出 | 內容 |
|---|---|
匯出 ▾ → CSV(quality_report.csv) | 每個需求與準則一列:Number、Name、Description、Quality Score、Attribute、Message、Result。 |
匯出 ▾ → Excel (.xlsx)(quality_report.xlsx) | Number、Name、Description、Rationale、Quality Score、Attribute、Message、Result,需求儲存格會跨其九列合併,「Yes」以綠色、「No」以紅色顯示,結尾附報告分數(「是」的答案占所有答案的比例)。 |
| 文件的交付 ▾ → 所有匯出… → 品質發現事項 (Excel) | 針對單一文件的相同版面配置,附文件的顯示欄。 |
核准
使用需要與需求 → 核准查看所有等待決定的項目。它會以查詢 Requirement:"Status=In Review" 開啟資料庫。
它具有資料庫的所有功能:
- 選取多列並使用大量操作列一起設定 Status 或標籤。
- 匯出清單。
- 按兩下某一列即可開啟項目檢視與完整的歷程記錄。
核准方塊
核准方塊會出現在每個需求的屬性面板與項目檢視中。它會顯示:
- 以彩色晶片呈現的目前狀態(未設定時為 Draft)。
- 最後記錄的決定:「<status> by <name> · <date and time>」,有附註時後接「— <note>」(例如「— 核准後文字已變更」),或「未記錄核准」。
- 適用於目前狀態的按鈕:
| 按鈕 | 顯示時機 | 效果 |
|---|---|---|
| 核准 | Status 既不是 Approved 也不是 Rejected | 設為 Approved,並記錄您與時間。通知:「已核准」。 |
| 拒絕… | Status 既不是 Approved 也不是 Rejected | 在拒絕需求對話方塊中要求輸入原因(選填),然後設為 Rejected。通知:「已拒絕」。 |
| 重新開啟 | Status 為 Approved 或 Rejected | 設為 In Review。通知:「已移至 In Review」。 |
記錄的姓名是您的帳戶名稱。在表格或屬性面板中手動設定 Status 也會以您的姓名與時間記錄一項決定。檢視者看到的方塊沒有按鈕。
當工作流程透過變更請求處理移至 Approved 的動作時,方塊會改為顯示開啟中的請求及其計數,例如 CR-4:3 項核准中的 1 項。套用後,決定會列出每位核准者與該請求:「Approved by Ann Lead, Bob Discipline · <date and time> · CR-4」。
附註:編輯 Approved 需求的名稱或描述會將其設為 In Review,並附註「核准後文字已變更」。通知會報告「N 個已核准需求已移至 In Review。」變更其他屬性不會重新開啟它。
TBD/TBR 登錄表
使用登錄表追蹤每個未結項目直到關閉為止。開啟需要與需求 → TBD/TBR。從文件中,選擇檢查 ▾ → TBD/TBR 登錄表即可開啟範圍限於該文件的登錄表。
- 頁首:匯出 XLSX(登錄表為空白時停用)。
- 範圍列:範圍(所有需求或文件:<name>)。
- 圖磚:未結 TBD/TBR、已逾期、無擁有者,以及開啟各文件的依文件晶片(「<document>:<count>」)。
- 未關閉項目隨時間變化:未結數量的燃盡圖。它依需求的歷程記錄重建,從最舊的需求到現在最多 60 個點。指向某個點即可查看其日期與數量。歷程記錄不足時會顯示「歷程記錄尚不足以繪製燃盡圖。」
- 表格欄:
- 編號,以及附描述的名稱。
- 文件。
- 類型:TBD、TBR 或 TBS,附「屬性」、「文字中」或兩者。
- 擁有者:TBD Owner,否則為需求的 Owner,否則為「—」。
- 到期日:需求唯一的到期日,與屬性面板工作流程群組及項目檢視中的到期日為同一個日期。當 TBD Due Date 屬性有日期時即為該屬性,否則為需求的到期日。過去的日期下方會顯示「已逾期」。已逾期的列會加上色調。
- 天數:項目開啟以來的天數。
- 關閉。
在列上按右鍵,或在其上按 Shift+F10,即可開啟與資料庫相同的列選單:建議動作及其原因、✦ 更多 AI ▸、開啟、重新命名…、複製、新增子項目…、Status ▸、Priority ▸、關聯至 ▸、新增至文件 ▸、在圖中顯示 ▸、複製連結、複製編號與刪除…。在其他右鍵選單中,具有未結 TBD 或 TBR 的需求會以解決 TBD…開頭,它會開啟此登錄表並選取該需求。
登錄表是唯讀的。若要變更到期日,請選取該列並在屬性面板中設定到期日。Holarch 會設定需求的到期日,並在 TBD Due Date 屬性有日期時也設定該屬性(保留其時刻),一次復原即可全部撤回。清除到期日會同時清除兩者。
只有在設定了 TBD/TBR 屬性時才會出現關閉。它會將該屬性設為 None:
- 文字中不再有任何內容時,通知會顯示「已關閉」。
- 文字中仍有 TBD、TBR 或 TBS 時,通知會顯示「屬性已關閉;文字仍包含 TBD。」
- 僅來自文字的項目沒有「關閉」按鈕;請編輯文字以關閉它。
沒有未結項目時,頁面會顯示「沒有未結的 TBD/TBR 項目。設定需求的 TBD/TBR 屬性,或在其文字中寫入 TBD、TBR 或 TBS,即可在此列出。」
匯出 XLSX 會寫入 TBD-TBR Register.xlsx,含 Number、Name、Document、Type、Source(attribute、text 或兩者)、Owner、Due Date、Opened、Age (days)、Overdue(紅色的 Yes)與 Description。
待檢查的連結
使用待檢查的連結(在其他工具中也稱為可疑關聯)找出需求變更後必須重新檢查的內容。當關聯另一端的項目在該關聯上次審查之後有所變更時,該關聯就需要審查:確認關聯仍然成立,然後將其標記為已審查。需要與需求 → 待檢查的連結會列出它們。從文件中,請使用檢查 ▾ → 待檢查的連結。
什麼會將關聯標記為待審查
需求上的下列變更會將其關聯標記為待審查:
- 名稱或描述。
- Priority、Criticality、Verification Method 或 Verification Level。
- 任何數字、百分比或持續時間屬性。
Holarch 接著會標記該需求下列類型的每個關聯:decomposed by、derived by、refined by、satisfied by、verified by 與 traced to。
變更 Verification Method 或 Verification Level 只會標記 verified by 關聯。設定需求的第一個方法或等級不會標記任何關聯:它是在規劃驗證,並未變更任何已審查的內容。
每個關聯的另一端是待審查項目:子需求、滿足它的功能或資產、驗證它的測試案例等。對同一個需求的後續變更會加入同一個標記上已變更欄位的清單。
待審查的關聯顯示在哪裡
- 待檢查的連結頁面:每個待審查的關聯一列。
- 文件與資料庫:項目列上的 ⚠ 審查徽章(「另一端的項目在此關聯上次審查之後已變更。請確認關聯仍然成立,然後將其標記為已審查。按一下以審查。」)。
- 屬性面板與項目檢視:橫幅「⚠ 審查:<requirement> 在此關聯上次審查之後已變更。請確認關聯仍然成立,然後將其標記為已審查。」其審查…按鈕會為該項目開啟待檢查的連結 — <item>對話方塊,含待審查的未關閉關聯與關閉。
- 屬性面板的追溯區段:每個待審查關聯旁的 ⚠,其工具提示中有已變更的欄位與日期。
- RVTM:任一端有待審查關聯的需求(它已變更,或其上游項目已變更)之後的 ⚠;按一下它即可審查這些關聯。Verified by 中測試案例之後的 ⚠ 會標示該驗證關聯。
「待檢查的連結」頁面
此頁面頂端會說明規則,並顯示一個表格:
| 欄 | 內容 |
|---|---|
| (勾選方塊) | 為將所選項目標記為已審查…選取。標題列的勾選方塊會全選。 |
| 變更 | 已變更的需求。 |
| 變更 | 已變更的欄位,例如「Description」或「Priority, Verification Level」。 |
| 時間 / 變更者 | 變更的日期與時間,以及變更者。 |
| 關係 | 關聯類型,從已變更的需求方向讀取(例如「satisfied by」)。 |
| 待審查項目 | 關聯另一端的項目。 |
| (動作) | 差異與標記為已審查…。 |
在列上按右鍵,或在其上按 Shift+F10,即可開啟該項目的列選單,與資料庫相同:建議動作、✦ 更多 AI ▸、開啟、重新命名…、複製、新增子項目…、Status ▸、Priority ▸、關聯至 ▸、新增至文件 ▸、在圖中顯示 ▸、複製連結、複製編號與刪除…。在其他右鍵選單(資料庫、文件)中,具有待審查關聯的項目會以檢查連結…開頭,它會為該項目開啟審查。
差異會開啟變更 — <requirement>,顯示名稱與描述的字詞差異。只有屬性變更時,會顯示「只有屬性變更:<fields>。請開啟實體歷程記錄以查看詳細資料。」歷程記錄…會開啟需求的歷程記錄。
若要將關聯標記為已審查:
- 按一下某列上的標記為已審查…、針對已勾選列的將所選項目標記為已審查…,或全部標記為已審查 (N)…。
將 N 個關聯標記為已審查會開啟:「確認已關聯的項目在變更後仍然成立。每個已關聯的項目都會新增一則留言。」
- 輸入選填的留言,例如「Child still valid; no change needed.」
- 按一下標記為已審查。
通知會顯示「已將 N 個關聯標記為已審查。」
未選取任何項目時使用將所選項目標記為已審查…會顯示「請先選取要標記為已審查的關聯。」
將關聯標記為已審查會在該關聯上記錄審查:審查者、時間、留言與欄位。若您寫了留言,Holarch 也會在每個項目的留言中新增「Link reviewed (<requirement> changed: <fields>): <comment>」。復原可還原它。
沒有待審查的關聯時,頁面會顯示「沒有待審查的關聯。當關聯另一端的項目在該關聯上次審查之後變更時,該關聯就需要審查。」
基準線與版本比較
文件基準線
以文件標題欄中的版本 ▾建立並使用文件基準線。它會列出:
- 目前版本:即時的文件。
- 此文件的每個基準線,最新的排在最前,並附其日期。
- 在專案基準線下,每個專案基準線。
- 儲存基準線…與比較版本…(在文件有基準線之前會變暗:「請先儲存基準線」)。
儲存基準線…會開啟儲存基準線:
- 名稱 *(必填)。
- 核准:名稱、角色與聲明的列,附 + 新增核准者。第一列會填入您的姓名。空白時顯示「沒有核准者。」
- 附註「基準線會保留此版本的文件(其項目、項目的屬性與關係),以供日後檢視、比較與還原。核准記錄會以現在的日期記錄,之後無法編輯。」
在版本 ▾中選擇基準線即可檢視它。文件會變成唯讀,並顯示橫幅「基準線「<name>」,唯讀,儲存於 <date>」與核准清單。會出現下列按鈕:
| 按鈕 | 效果 |
|---|---|
| 返回目前版本 | 返回即時的文件。 |
| 編輯 | 編輯基準線:重新命名並新增核准記錄。核准(已鎖定)會列出現有記錄,這些記錄無法變更;新記錄「會以現在的日期記錄並加入清單」。僅限文件基準線。 |
| 與目前比較 | 從此基準線開啟比較版本。僅限文件基準線。 |
| 還原基準線 | 文件基準線:「要以基準線「<name>」覆寫此文件的實體、順序與結構嗎?之後新增的實體會從文件中移除(不會刪除)。可以復原。」專案基準線:以基準線取代專案,「要以專案基準線「<name>」取代整個專案嗎?可以復原。」 |
| 刪除 | 「要刪除基準線「<name>」嗎?」 |
在即時的文件中,每一列都帶有變更標記:自基準線以來新增、自基準線以來已變更,或未變更。它會與最新的文件基準線比較;文件沒有文件基準線時,則與最新的專案基準線比較。
比較版本
使用變更報告即可確切查看自審查以來有哪些變更。
- 按一下版本 ▾ → 比較版本…,或基準線橫幅中的與目前比較。
比較版本隨即開啟。
- 選擇自:一個基準線。
- 選擇至:較晚的基準線,或目前版本。
表格會列出編號、名稱、變更類型、欄位與變更(修改過之文字的字詞差異)。
變更類型:
| 變更類型 | 意義 |
|---|---|
| 已新增 / 已移除 | 實體加入或離開了文件。 |
| 已修改 | 某個欄位已變更:名稱、編號、描述、類別、影像或任何屬性(會列出欄位名稱)。 |
| 已新增標籤 / 已移除標籤 | 新增或移除了標籤。 |
| 已新增關係 / 已移除關係 | 新增或移除了與文件相關的關聯。 |
| 關係屬性 | 關係的屬性已變更。 |
變更 (Excel) 會寫入「<document> (Changes).xlsx」,含 Number、Name、Class、Change Type、Field、Old Value 與 New Value。修訂標記版 (Word) 會將相同的比較寫成 Word 追蹤修訂。
文件的交付 ▾ → 變更 (Excel)…(也位於所有匯出…中)會以自與至匯出相同的報告。沒有基準線時,它會失敗並顯示「此文件沒有基準線。請先儲存一個。」
文件 (Word) 會從文件的基準線填入 Word 輸出的修訂歷程與核准表格。
「基準線和版本」頁面
使用控制與審查 → 基準線和版本管理專案中的每個基準線。專案基準線包含每個實體;文件基準線包含一份文件,並以文件的版本 ▾ → 儲存基準線…建立。頁首有還原以前的版本…(可還原整個專案先前的自動儲存)與 + 儲存基準線…。
若要建立專案基準線:
- 按一下頁首中的 + 儲存基準線…。
儲存專案基準線對話方塊會顯示目前的實體與關係數量。名稱預設為「Baseline <n>」;預留位置文字為「名稱,例如「SRR」」。
- 輸入名稱,然後按 Enter 或按一下儲存基準線。空白的名稱會被拒絕(「輸入名稱。」)。
通知會顯示「已儲存基準線」。
此頁面的卡片:
- 基準線卡片:目前的數量(「目前:<n> 個項目、<n> 個關係」)與篩選:所有基準線、專案層級基準線或文件:<name>。欄:
- 名稱。
- 文件:在該基準線檢視文件的連結,或「專案」。
- 建立時間。
- 核准:「✔」與核准者姓名。指向它們即可查看角色、日期與聲明。「by <name>」為建立者。
- 實體與關係。
- 比較:將此基準線設為「自」,將目前的工作副本設為「至」。
- ⋯(更多動作):
- 重新命名…:重新命名基準線。
- 匯出(JSON):下載「<name>.json」(格式
holarch-baseline,含快照與核准)。 - 還原基準線…(專案基準線):「要以基準線「<name>」取代所有目前的實體與關係嗎?可以復原(⌘Z / Ctrl+Z)。」通知:「已還原「<name>」」。
- 回復文件…(文件基準線):「要將文件「<doc>」還原為基準線「<name>」嗎?只有該文件的實體與結構會變更。可以復原。」文件已刪除時停用。
- 刪除…。在託管服務上,只有專案擁有者可以重新命名或刪除基準線;其他人的這些項目會變灰並顯示原因。
- 孤立基準線(需要時顯示):「N 個已刪除文件的基準線」。每個都有還原文件(從基準線重新建立文件成品及其實體)與刪除。
- 比較卡片:選擇自(較舊)與至(較新)。「至」為目前版本或同一範圍的另一個基準線。
- 圖磚:已新增的實體、已移除的實體、已變更的實體、關係變更。
- 表格會顯示實體、變更、欄位與差異(字詞差異)。日期屬性以應用程式的日期格式顯示。
- 匯出 CSV 與匯出 XLSX 會寫入「Changes <from> to <to>」。
- 沒有可顯示的內容時:「「<from>」與「<to>」之間沒有差異。」
沒有基準線時:「沒有基準線。建立一個以記錄專案的目前狀態。」
附註:基準線儲存在專案中,並在專案匯出時隨專案一起移動。專案基準線包含實體與關係。文件基準線還包含文件的大綱設定。
匯入需求
使用需要與需求 → 匯入與匯出從檔案匯入需求。它分為四個步驟:檔案 → 對應 → 審查 → 匯入。
- 上一步與繼續可在步驟之間移動。「審查」步驟上的匯入 N 個項目會進行匯入,一次復原即可全部撤回。
- 單一拖放區可接受每種格式。格式會從檔案偵測(其名稱,以及名稱不足以判斷時的內容),並顯示在格式下,您可以在那裡變更它。
格式為 Word (.docx)、Holarch 專案檔案(.holarch, .json)、Excel / CSV (.xlsx, .csv)、純文字 (.txt)、UML/SysML (.xmi, .uml, .mdzip) 與 ReqIF(.reqif)。
本節涵蓋需求格式。專案檔案、XMI 以及其他所有匯入與匯出,請參閱匯入與匯出。
步驟 1:檔案
將檔案拖放到「將檔案拖放到這裡或按一下以選擇檔案」上,或將文字貼入方塊並按一下分析文字(含標題列的 CSV、ReqIF XML、XMI、JSON 或文件文字)。
| 選項 | 數值 | 效果 |
|---|---|---|
| 格式 | 上述六種格式 | 顯示偵測到的格式。選擇另一種格式即可以其他方式讀取相同的內容。 |
| 文字編碼(CSV、文字) | 自動、UTF-8、ISO-8859-1 / Windows-1252、Shift_JIS、Big5、UTF-16 | 檔案位元組的讀取方式。變更它會重新讀取檔案。 |
| 工作表(活頁簿) | 「<name>(N 列)」 | 要匯入的工作表。預先選取第一個有資料的工作表。 |
- 純文字:方塊會讓匯入的內容保持可編輯。編輯後按一下重新執行分析。
- 狀態列會顯示「已分析「<file>」:N 列、M 欄。」(另加「(工作表「<name>」)」,以及 Word 的「、N 個表格」)。
步驟 2:對應
每個檔案欄為一列:檔案欄(標題與位置)、範例值(前三列)與 Holarch 欄位。選擇略過即可略過某一欄。從欄標題比對出的欄位會標示自動。
| Holarch 欄位 | 內容 |
|---|---|
| 名稱、編號、描述 | 項目自身的欄位。 |
| 類別、標籤 | 類別名稱;以 ; , 或 | 分隔的標籤名稱。 |
| 父項編號、全域 ID | 父項的編號;用於比對現有實體的 ID。 |
| 屬性 | 無類別之列所用類別的任何屬性。 |
| 關係 | 以 ; 分隔多個目標。 |
| 列 ID、父列 ID、新屬性(已新增到結構描述) | 來自 ReqIF 與 XMI 檔案的結構,以及新屬性。 |
✦ AI ▾ → 建議對應會為每一欄提議一個欄位。建議的對應會列出變更(已勾選)及 AI 的理由;套用已勾選項目會變更對應。此時尚未匯入任何內容。
Holarch 會從標題推測對應:
| 標題 | 對應到 |
|---|---|
| Number、No、Num、#、ID Number、Req Number、Requirement Number | 編號 |
| Name、Title、Short Name、Requirement Name | 姓名 |
| Description、Text、Requirement、Requirement Text、Statement、Desc | 說明 |
| Class、Type、Entity Class | 等級 |
| Labels、Label、Tags | 標籤(以 ; , 或 | 分隔值) |
| Parent、Parent Number | 父項編號 |
| Global ID、ID、GUID、UUID | 全域 ID |
| 屬性名稱(例如 Priority、Rationale、Status) | 該屬性。「Method」與「Verification」會對應到 Verification Method。 |
| 標籤群組名稱(例如沒有該屬性時的 Verification Method) | 標籤 |
| 關係名稱(例如 satisfied by) | 該關係;以 ; 分隔多個目標 |
| Object Identifier、Origin ID | 全域 ID |
| Object Number、ReqIF.ChapterName、ReqIF.ForeignID | 編號 |
| Object Heading、ReqIF.Name、Long Name | 姓名 |
| Object Text、ReqIF.Text、ReqIF.Description | 說明 |
| ReqIF.Category | 等級 |
| ReqIF ID、XMI ID、Row ID / Parent ID | 列 ID / 父列 ID |
新屬性會在每個匯入的類別上建立一個以該欄命名的屬性。其類型依值而定:
- 數字,當每個值都是數字時。
- 選項清單,當不同的簡短值很少時。
- 長文字,用於超過 120 個字元的值。
- 其他情況為文字。
品質準則、計算屬性與檔案屬性無法對應。
在各欄下方:
| 選項 | 數值 | 效果 |
|---|---|---|
| 無類別的列所用的類別 | 任何類別;預設為 Requirement | 沒有 Class 欄值且沒有符合之類別規則的列所用的類別。 |
| 類別規則 | 描述包含某個字或片語 → 某個類別 | + 規則會新增一條,× 會移除它。第一條符合的規則會套用到沒有 Class 值的列。 |
| 依下列比對現有實體 | 全域 ID、名稱、編號 | 符合現有實體的列會更新該實體,而不是建立副本。依名稱與編號比對時,也要求類別相同。 |
| 依下列比對相關實體 | 全域 ID、名稱、編號 | 關係欄中的值如何找到其目標。 |
| 日期欄的日期格式(CSV) | 自動、yyyy-MM-dd HH:mm:ss、dd/MM/yyyy、MM/dd/yyyy、yyyyMMdd、自訂… | 日期儲存格的讀取方式。自訂…會顯示一個欄位,讓您以 yyyy、MM、dd、HH、mm 與 ss 輸入自己的模式(例如 dd.MM.yyyy HH:mm)。 |
| 編號模式(Word、文字) | 空白(自動),或 1. a) (i) 之類的標記,或 1.1 或 1.1.a 之類的路徑編號 | 編號段落如何成為大綱。對於文字,模式會從編號偵測並自動填入。Word 標題樣式與清單編號不需要模式。請參閱編號模式。 |
| 在父項下為子項編號 (1 → 1.1)(Word、文字) | 預設為開啟 | 產生的子項編號會是「3.1」、「3.2」,而不是「1」、「2」。 |
階層。大綱編號會重建階層:「1.2.3」會成為「1.2」的子項。父項編號欄,或列 ID 與父列 ID 的組合,會明確設定父項。沒有父項的項目會成為文件的最上層項目。
Word 表格。對於 Word 檔案,Word 表格區段會列出每個表格。在各章節中以相同標題重複出現的表格會共用一個對應。此區段說明:「將需求表格匯入為實體,每列一個,並對應其欄。其他表格會以表格形式保留在其前一個項目的描述中。」
- 將每個表格設為實體(每列一個)或描述中的表格。
- 將其欄對應到編號、名稱、描述、類別、標籤、屬性、新屬性或略過。
- ID、Req ID、Requirement ID、Ref 或 Paragraph 之類的標題會對應到編號。
- Shall、Shall Statement、Requirement Statement、Requirement Text、Statement 或 Text 會對應到描述。
有編號或描述欄且有「shall」列的表格一開始會設為實體。
目前為止發現的警告會出現在各欄下方,或顯示「沒有警告。」
步驟 3:審查
在任何變更發生之前檢查結果。「審查」顯示變更的方式與「基準線和版本」比較版本的方式相同(請參閱基準線與版本比較):
- 第一行會列出檔案、格式與每個類別的項目數。
- 當每個項目都是 Statement 或 Requirement(或其子類別)時,會出現已勾選的從這 N 個需求建立需求文件。對於其他檔案,它會顯示為未勾選的從這 N 個項目建立文件。勾選時,請選擇文件類型(預設為需求文件)、名稱(預設為檔案名稱),以及是否匯入後為整份文件重新編號。
- 接著是警告。
- 圖磚會計算新項目、已更新的項目、已比對,未變更的項目與來自檔案的關係。
- 變更表格會列出每個新項目及其描述,以及已更新項目的每個已變更欄位,並附舊值與新值的字詞差異(前 500 項變更)。
按一下匯入 N 個項目。通知會顯示「已匯入 N 個新項目,M 個已更新」。
- 沒有警告時,Holarch 會開啟新的需求文件(或資料庫)。
- 否則,匯入完成卡片會列出警告(沒有問題時顯示「匯入未回報任何警告。」)。其按鈕為開啟文件、開啟資料庫、Spider 圖、樹狀圖、檢查品質與開始另一次匯入。
新文件的描述會列出匯入警告。
各格式的讀取方式
Word (.docx):
- 標題與 Word 清單編號會成為大綱,並保留其編號。
- 標題會成為 Statement。其下的內文會成為其描述。
- 含 shall、must、will 或 should 的段落會成為子 Requirement,並以情態動詞之後的字命名。編號清單項目也是如此;沒有情態動詞時則成為 Statement。
- 項目符號、圖片與表格會加入其前一個項目的描述,並保留粗體、斜體、清單與表格。
- 原始 .docx 若在每個檔案的附件上限之內,會附加到新文件。
- PNG、JPEG、GIF、WebP 與 SVG 圖片會保留。其他圖片格式會略過並顯示警告。
Excel (.xlsx, .xlsm) 與 CSV:
- 每個實體一列,欄不限。第一列為標題。
- 多行儲存格會保留其換行。
- 不會讀取 Excel 97-2003 (.xls) 檔案。請先將其另存為 .xlsx 或 .csv。
ReqIF (.reqif, .reqifz):
- 每個 SPEC-OBJECT 會成為一列,含 ReqIF ID、Parent ID(來自規格階層)、Type(其物件類型,對應到類別)、Long Name,以及每個屬性定義一欄。
- 沒有符合的欄預設為新增屬性。XHTML 屬性會成為格式化文字屬性,列舉屬性會成為選項清單。
- SPEC-RELATION 會依名稱成為關係。名稱不符合結構描述允許的關係時,會成為 traced to。
- .reqifz 封存檔會自動解壓縮。
純文字 (.txt) 或貼上的文字:
- 編號的行(「3.1 Battery」),或沒有句號的短行,會成為標題(Statement)。
- 每個含 shall、must、will 或 should 的句子會成為目前標題下的 Requirement。
- 其他文字會加入前一個項目的描述。
- 使用編號模式(從文字偵測或手動輸入)時,由模式決定層級。
從試算表更新需求
使用此方式可在試算表中一次變更多個需求。
- 在資料庫(或「需求」頁面)中,按一下匯出…並選擇表格 (CSV)。
- 勾選要編輯的屬性。在包含下勾選 ID,然後按一下匯出。
- 在試算表中編輯值。不要變更 ID 欄。
- 匯入檔案。在對應中,確認 ID 欄對應到全域 ID,並將依下列比對現有實體設為全域 ID。
- 在審查中,取消勾選建立文件…。
比對成功的列會計為已更新的項目,並列出每個已變更的欄位。
- 按一下匯入 N 個項目。
此版本之前匯出的檔案中的 I_… 值不會比對成功;請使用 ID 欄。每個步驟與選項請參閱匯入與匯出。
更新會寫入的內容:
- 只寫入已對應的欄。缺少 Description 欄時,每個現有的描述都會保留。
- 檔案中的標籤會加入現有的標籤。
- 沒有 Class 欄時,依全域 ID 比對到的列會保留其實體的類別。
匯入訊息
| 訊息 | 意義與修正方式 |
|---|---|
| 沒有任何欄對應到名稱或編號。請對應其中一個。 | 至少將一欄對應到名稱或編號。 |
| 第 N 列:未知的類別「X」,改用 <class>。 | Class 值不符合任何類別。請修正該值或將該欄對應為略過。 |
| 第 N 列:已忽略未知的標籤「X」。 | 請先在結構描述中建立該標籤,或修正該值。 |
| 第 N 列:「<attribute>」不適用於類別 <class>。 | 該列的類別沒有該屬性。 |
| 第 N 列:「<value>」不是「<attribute>」的有效 <type>。 | 無法將該值讀取為數字、日期、選項等。請檢查日期格式選項。 |
| 第 N 列:名稱超過 255 個字元,已縮短。/ 第 N 列:編號超過 255 個字元,已縮短。 | 名稱與編號限制為 255 個字元。 |
| 重複的編號 X(第 A 列與第 B 列)。 | 兩列共用同一個編號;階層可能會將子項附加到第一列。 |
| 第 N 列:X 缺少父項編號 P;已附加到 Q。/ …;已匯入為最上層。 | 直接父項編號不在檔案中。 |
| 第 N 列:找不到父項編號 P。/ 第 N 列:找不到父項 P。 | Parent Number 或 Parent Row ID 參照了不在檔案中的列。 |
| 第 N 列:找不到「<relationship>」目標「X」。 | 關係欄指定了不存在的實體。請檢查依下列比對相關實體。 |
| 第 N 列:結構描述不允許從 A 到 B 的「<relationship>」(仍已建立)。 | 即使結構描述未列出該關聯,仍已建立它。 |
| 結構描述不允許 A 與 B 之間的關係「X」;已略過。 | 無法建立 ReqIF 或 XMI 關係,即使以 traced to 也不行。 |
| 影像 X:不支援 .ext 影像,已略過。請在 Word 中將圖片另存為 PNG 或 JPEG 以保留它。 | Word 圖片為不支援的格式。 |
| 影像 X(大小)超過 <limit> 附件上限,已略過。 | 圖片大於每個檔案的上限。 |
| 找不到任何資料列。 | 檔案或工作表只有標題,或是空的。 |
| 無法讀取檔案:不支援 Excel 97-2003 (.xls) 檔案。請在 Excel 中將檔案另存為 .xlsx 或 .csv,然後再次匯入 | 轉換檔案。 |
| 無法讀取檔案:不接受含 DOCTYPE 或 ENTITY 宣告的 XML。請將檔案另存為不含該宣告的版本,然後再次匯入 | 從 ReqIF 或 XML 檔案中移除該宣告。 |
| 無法讀取檔案:無效的 XML | ReqIF 檔案不是格式正確的 XML。 |
| 匯入失敗:<reason> | 匯入已停止;沒有任何變更。 |
需求快速鍵
| 按鍵 | 位置 | 動作 |
|---|---|---|
| Enter | 文件快速輸入 | 新增輸入的需求。 |
| ⌘ / Ctrl+Enter / ⌥ / Alt+⌘ / Ctrl+Enter | 文件,已選取項目 | 新增同層項目 / 子項目。 |
| Enter 或 Space | 「品質」、「TBD/TBR」與「待檢查的連結」的列 | 在屬性面板中顯示該列的需求或待審查項目。 |
| ↑ / ↓ | 相同的列,列已取得焦點 | 移至上一列或下一列。 |
| ⌘ / Ctrl+按一下、⇧ / Shift+按一下、⌘ / Ctrl+⇧ / Shift+按一下 | 「品質」、「TBD/TBR」與「待檢查的連結」的列;資料庫的列;文件項目 | 切換一列、選取從上次按一下之列開始的範圍、加入該範圍。 |
| ⌘A / Ctrl+A, ⇧ / Shift+↑ / ⇧ / Shift+↓ | 相同的列,列已取得焦點 | 選取所有顯示的列;從取得焦點的列延伸選取範圍。 |
| 按右鍵、Shift+F10 或選單鍵 | 「需求」、「品質」、「TBD/TBR」與「待檢查的連結」的列;文件項目與大綱項目 | 開啟該列的選單:先是建議動作及其原因與 ✦ 更多 AI ▸,然後是該項目的命令。 |
| Esc | 品質、TBD/TBR、待檢查的連結、RVTM | 取消選取該列。 |
| Enter | 「基準線和版本」的名稱欄位 | 建立專案基準線。 |
| ⌘Z / Ctrl+Z | 任何位置 | 復原上一次變更,包括整個匯入、將關聯標記為已審查或狀態變更。 |
應用程式中的所有快速鍵請參閱鍵盤快速鍵。
設定
| 設定 | 位置 | 預設 | 範圍 |
|---|---|---|---|
| 文字變更時自動重新檢查 | 「品質」頁面範圍列 | 關閉 | 此瀏覽器 |
| 屬性面板群組摺疊或展開(品質及其他群組) | 按一下屬性面板中群組的標題,或其連結末端的全部摺疊 / 全部展開 | 「品質」摺疊,其餘展開 | 此瀏覽器,依類別 |
| 您在核准、決定與留言上的姓名 | 您的帳戶名稱 | — | 帳戶 |
| 追溯狀態(需求上的圓點) | 文件的檢視 ▾ | 作用對象 | 文件 |
訊息
| 訊息 | 位置 | 意義 |
|---|---|---|
| 已檢查 N 個需求 | 品質 | 已對該範圍執行檢查。 |
| 此範圍內沒有需求。 | 品質 | 該範圍沒有需求。 |
| 此文件沒有可檢查的 Requirement。Statement 不會被評分。 | 文件的「檢查品質」 | 將項目變更為 Requirement,或檢查另一份文件。 |
| 已過期 — 重新執行 / 已過時 / 品質:已過期 — 重新執行 | 品質、文件、屬性面板 | 文字在上次檢查之後已變更。 |
| 需要審查者的判斷 | 品質(Correct、Feasible) | 必須由人決定;按一下 ✘ 以標記為「是」。 |
| 已手動標記為否。 | 品質 | 審查者已將該準則設為「否」。 |
| N 個已核准需求已移至 In Review;N 個關聯已標記為待審查。 | 編輯之後 | 該編輯重新開啟了核准,並將關聯標記為待審查。 |
| 已核准 / 已拒絕 / 已移至 In Review | 核准方塊 | 已記錄該決定。 |
| 已將 N 個關聯標記為已審查。 | 待檢查的連結 | 已記錄這些審查。 |
| 請先選取要標記為已審查的關聯。 | 待檢查的連結 | 在將所選項目標記為已審查…之前先勾選列。 |
| 已關閉 / 屬性已關閉;文字仍包含 TBD。 | TBD/TBR | 該屬性已設為 None。 |
| 文字仍包含 TBD。請編輯文字以關閉它。 | TBD/TBR | 關閉僅來自文字的項目時顯示。 |
| 已儲存基準線 | 文件、基準線和版本 | 已儲存快照。 |
| 此文件沒有基準線。請先儲存一個。 | 與目前比較、變更報告 | 該文件沒有基準線。 |
| 已回復為「<name>」/ 已還原「<name>」 | 基準線 | 文件或專案已回復;可以復原。 |
| 沒有要審查的需求。請先選取或開啟需求。 | AI 需求檢查 | 範圍內沒有需求。 |
限制
- 檢查品質:範圍內的每個需求都會與其他需求比較是否重複(相似度門檻 75%)。
- AI 需求檢查:每個 AI 請求 20 個需求,並附最多 300 個其他需求作為背景資訊。
- 關聯審查差異會保留舊名稱的前 500 個字元與舊描述的前 4,000 個字元。
- TBD/TBR 燃盡圖:最多 60 個點。
- 匯入:
- 名稱與編號最多 255 個字元。
- 預覽會顯示前 500 列。會列出前 50 個警告(「…and N more」)。
- 編號模式最多 6 層(「編號模式超過 6 層。請最多使用 6 個標記。」)。
- ReqIF/XML 檔案最多 1 億個字元與 3,000,000 個元素。
- .reqifz 與 .docx 封存檔最多 10,000 個項目,每個項目 300 MB,總計 600 MB。
- 圖片與原始 Word 檔案只在每個檔案的附件上限內保留(Free 方案 10 MB、Individual 25 MB、Team 100 MB)。