需求
文件
以模型的即時檢視撰寫、組織、編號、建立基準線並發布規格,並提供範本、RTF 格式文字、報告和 Word 輸出。
本頁內容
概觀
文件是一份規格、計畫或程序,其章節與需求是模型中的實體。使用文件頁面撰寫並重新組織它們、為它們編號、建立基準線,並將它們發佈為 Word、Excel、ReqIF、Markdown 及其他格式。
文件中的每個項目都是一個實體。因此同一個需求也會出現在資料庫、圖、可追溯性矩陣與品質檢查器中。在任何這些地方所做的編輯都會顯示在文件中。
概念
什麼使某物成為文件
- 文件是符合下列兩個條件之一的 Artifact 實體:
- 它帶有文件類型標籤:名稱以「Document」結尾的任何標籤。
- 它是至少一個 Statement 或 Heading 的 source of。
- 其最上層項目是該文件作為 source of 的實體。更深層的項目透過 decomposed by 關係掛在它們之下。您看到的大綱就是這棵分解樹。
- 項目通常是 Statement(章節、標題、附註、假設)與 Requirement(及其子類別)。以其他類別…新增任何其他類別。
- Heading(LML 2.0 結構化文件)是可包含任何類別項目的章節。子章節是 Heading 下的 Heading(decomposed by)。Heading 下的任何其他項目都是該章節的內容:Heading contains 它,它保留自己的編號,並列在子章節之前。請參閱以 Heading 組織的結構化文件。
- 從文件移除項目不會刪除該實體。從資料庫刪除則會。
文件類型
類型就是文件的文件類型標籤。它決定優先提供哪些範本,以及文件是否以紙張模式開啟。
| 類型 | 內建範本 |
|---|---|
| Requirements Document | Requirements Specification;Stakeholder Requirements Specification (StRS);System Requirements Specification (SyRS);Software Requirements Specification (SRS);Interface Requirements Specification (IRS) |
| Interface Control Document | Interface Control Document (ICD) |
| Concept of Operations Document | Concept of Operations |
| Needs Analysis Document | Needs Analysis |
| Concept Exploration Document | Concept Exploration;Trade Study Report |
| Concept Definition Document | Concept Definition;Architecture Description |
| Systems Engineering Management Plan Document | Systems Engineering Management Plan |
| Test Plan Document | Test Plan;Verification and Validation Plan;Test Procedure;Test Report |
| Independent Verification & Validation Plan Document | IV&V Plan |
| Project Management Plan Document | Project Management Plan;Risk Management Plan;Configuration Management Plan |
| Integrated Logistics Support Plan Document | Integrated Logistics Support Plan |
| Standard Operating Procedure Document | Standard Operating Procedure |
其他類型的範本列在其他範本下,因此任何範本都可以用來開始任何文件。
若要新增文件類型,請在 Artifact 類別上新增一個名稱以「Document」結尾的標籤(請參閱結構描述擴充)。標示為審查套件的文件會彙整其他文件;請參閱彙編。
數字
每個項目都有一個編號,例如 3.2,顯示在其名稱之前。編號儲存在實體上,因此同一個需求在所有地方都顯示相同的編號。例外是文件編號,它會為每份文件保留各自的編號。
當新增或移動項目後自動重新編號開啟時(預設;勾選方塊位於撰寫 ▾ → 重新編號…中),Holarch 會為您保持編號的順序。
基準線
基準線是文件的唯讀快照。它包含:
- 文件的項目、項目的屬性與關係,包括連到文件之外一層之實體的關聯。
- 文件的設定。
- 附日期的核准記錄,之後無法編輯。
基準線會提供變更報告,以及 Word 輸出中修訂歷程與核准表格所需的資料。
在託管服務上:
- 每筆核准記錄都會取得伺服器的時間與儲存它的帳戶,而不是瀏覽器的時鐘。記錄會顯示「(伺服器時間)· 記錄者 {name}」,且該儲存會寫入稽核記錄。
- 只有專案擁有者可以重新命名或刪除基準線。對於其他人,刪除與名稱欄位會變灰,並顯示「只有專案擁有者可以重新命名或刪除基準線。」還原與回復的運作方式不變。
在桌面應用程式中,記錄帶有您的電腦儲存它們時的日期。
使用方式
使用時機與原因
當交付件是一份有人會閱讀、審查並簽署的規格時,請使用文件。例如:
- SRR 用的系統需求規格。
- 概念發展初期的操作概念。
- 驗證開始前的測試計畫。
- 操作用的程序。
在這裡撰寫需求,然後在模型的其他地方將它們追溯到功能、資產與測試。文件回答的是「這份規格說了什麼、以什麼順序,以及自核准以來有什麼變更?」
在系統工程流程中,文件最先出現:利害關係人需要與系統需求。它們為功能分析與分配提供資料。在審查時,它們會以已建立基準線、已核准且附可追溯性報告的產出形式回來。
從範本建立需求規格
- 在導覽列中,開啟需要與需求 → 文件。
- 按一下頁首中的 + 新增文件。
新增文件隨即開啟。
- 輸入名稱(必填)。編號與描述可以稍後在屬性面板中新增。
- 在範本下,範本適用於會顯示某種文件類型的範本,例如 Requirements Document。每張卡片都會顯示前幾個章節作為預覽。選擇下列其中之一:
- 空白:所示類型的空白文件。
- 組織範本項目(Holarch 伺服器,託管或自行架設),由您組織的管理員發佈。會預先選取組織對該類型的預設範本。
- 專案範本項目,儲存在此專案中。
- 內建範本項目。
- 其他文件類型的範本,位於其他範本下。
文件會取得所選範本的類型。
- 選取包含撰寫指引即可在內建範本的每個章節中加入簡短的撰寫指南。
- 按一下建立。
文件開啟時會帶有範本的編號章節,例如 1 Document Control、1.1 Revision History、1.2 Approvals、2 Introduction … 若您包含了撰寫指引,請在撰寫每個章節時將其刪除。
撰寫需求
- 按一下章節列以選取它。
- 按一下 + 子項目,或按 ⌥⌘↵ / Ctrl+Alt↵。
會出現一個名為「New Requirement」的新列及其編號,且其名稱已可輸入。
- 輸入名稱並按 Enter。
- 按一下描述並撰寫「shall」陳述。
- 按 ⌘↵ / Ctrl↵ 或按一下其他地方以儲存描述。
- 若要在同一層級新增下一個需求,請再按一次 ⌘↵ / Ctrl↵。
+ 新增 …(頁首)會將項目新增到文件末尾;+ 之後與 + 子項目會將其新增到所選項目旁(+ 新增 …的工具提示有此說明)。這三者都會新增您上次從其 ▾ 選單中選擇的類別(預設為 Requirement)。此瀏覽器會記住該選擇。
快速新增大量需求
使用文件底部的快速新增,接連輸入需求。
- 在快速新增列中選擇章節,例如 Under 4 Command and Data Handling。
- 輸入需求文字。
- 按 Enter。
Holarch 會新增該需求,並以「shall」之後的字為其命名。游標會留在欄位中以輸入下一個。
重新組織
以按鍵、拖曳或從右鍵選單變更大綱。自動重新編號開啟時,每次移動後編號都會更新。
- 使用按鍵:選取一列,然後按:
- ⌥⇧→ / Alt+Shift+→ 將其縮排到上方項目之下。
- ⌥⇧← / Alt+Shift+← 減少其縮排。
- ⌥ / Alt+↑ 或 ⌥ / Alt+↓ 在其同層項目之間移動它。
- Tab 不用於縮排,因此它一律移至下一個欄位。
- 以拖曳:在大綱窗格中拖曳列。放在某列的上緣或下緣即可將項目放在其前或其後。放在中間即可使其成為子項目。
- 從選單:在列上按右鍵並選擇移至下方 ▸,然後從清單中挑選新的父項(輸入以篩選)。子項目會一起移動。
審查、建立基準線並發佈
- 選擇檢查 ▾ → 檢查品質並修正較弱的需求(請參閱需求)。
- 選擇檢查 ▾ → 追溯狀態…,並關聯尚未分配或驗證的需求。
- 在檢查 ▾ → TBD/TBR 登錄表中清除未結項目。
- 審查檢查 ▾ → 待檢查的連結。
- 在標題欄中按一下版本 ▾並選擇儲存基準線…。
- 輸入名稱,例如「SRR Baseline」。
- 為每位核准者新增一列核准,含姓名、角色與聲明。
- 按一下建立。
基準線會出現在版本 ▾中,且按鈕會將其列為最新基準線。
- 按一下交付 ▾ → 規格 (Word)。
Word 檔案會以 Specification 範本的選項下載,包括從基準線填入的修訂歷程與核准表格。
- 在 Word 中開啟檔案,並接受更新欄位的提示。
目錄會自動填入。
若要在建立基準線之前讓文件接受審查,請按一下文件類型旁的要求審查。專案的審查者會在我的工作的待審查的文件下找到它,並在那裡或在標題下方的審查列中核准或拒絕它。
之後編輯時,查看有哪些變更:
- 按一下版本 ▾ → 比較版本…。
- 在自下選擇基準線,在至下選擇目前版本。
報告會列出每項新增、移除與編輯。按一下變更 (Excel) 即可下載,或按一下修訂標記版 (Word) 取得含追蹤修訂的 Word 檔案。
實例演練:CubeSat EO-1 示範
從管理專案 → 專案檔案 ▾ → 新增示範專案建立示範。然後開啟需要與需求 → 文件 → EO-1 System Requirements Specification(編號 SRS-001)。
閱讀結構。六個章節包含這些需求:
- 1 Mission Imaging
- 2 Attitude Determination and Control
- 3 Electrical Power
- 4 Command and Data Handling
- 5 Communications
- 6 Ground Segment and Operations
需求 1.6 Revisit Time 有兩個子項目:1.6.1 Ground Track Repeat 與 1.6.2 Off-Nadir Imaging。品質分數欄會顯示長條。2.5 Safe Mode Recovery 與 6.4 Operator Interface 的分數偏低。
修正較弱的措辭:
- 按 ⌘F / Ctrl+F 並輸入
should。計數器會顯示符合項目。
- 按 Enter 直到 2.5 被標示。
其文字為「The spacecraft should recover from safe mode quickly and resume imaging as appropriate」。
- 將其改寫,例如「The spacecraft shall resume imaging within 24 hours of a safe mode entry.」
在您再次執行檢查之前,分數欄會顯示已過時標籤。
分割複合需求:
- 選取 6.4 Operator Interface(「…shall be user friendly and/or easy to use.」)。
- 在其上按右鍵並選擇分割為多個項目…。
- 按一下 ✦ 建議分割。
您會得到每列一個可量測的需求。
- 取消勾選您不要的列,或按一下合併將某列與下一列合併,然後按一下套用。
快速新增需求:
- 在快速新增中選擇 Under 3 Electrical Power。
- 輸入「The EPS shall provide a 5 V regulated bus within 3%.」並按 Enter。
它會新增為 3.7,名為「Provide A 5 V Regulated」。
查看自 SRR 以來有哪些變更:
- 按一下標題欄中的版本 ▾並選擇 SRR Baseline。
橫幅會顯示「基準線「SRR Baseline」,唯讀,儲存於 {date}」。核准者為 J. Rivera, Systems Lead;R. Okafor, Mission Principal Investigator;以及 L. Brandt, Program Manager。
- 按一下與目前比較。
報告會列出:
- 3.1 Orbit Average Power:描述從 28 W 變更為 30 W,並有新的理由。
- 2.4 Target Slew:Status Draft → In Review。
- 新增的 4.4 Downlink Encryption,以及其兩個新的 satisfies 關聯。
- 您在此工作階段中自己所做的編輯。
發佈:
- 按一下返回目前。
- 按一下交付 ▾ → 規格 (Word)。
Word 檔案以標題與「Requirements Document · No. SRS-001」開頭。接著是 SRR Baseline 的修訂歷程列(「Initial baseline」)與三項核准,然後是編號的需求。
提示與良好做法
- 每列寫一個需求,只用一個「shall」。分割為多個項目…與品質檢查有助於保持需求的單一性。
- 將章節保持為 Statement,將需求保持為 Requirement。品質檢查只為 Requirement 評分。僅限需求的報告(RVTM、VCRM、RTM)會略過 Statement。
- 在每次審查與大幅改寫之前建立基準線。回復與變更報告都依賴它。
- 按一下某列會選取它。若要編輯,請按一下欄位本身,或在選取的列上按 Enter 或 F2。
- 使用檢視 ▾ → 紙張,即可像閱讀頁面一樣閱讀文件,不顯示屬性欄。關閉它即可在欄中編輯屬性。
- 留意追溯狀態圓點:當需求的圓點為綠色時,它就已準備好接受審查。
常見錯誤
- 新增功能變灰。有篩選或排序正在作用(工具列中的已篩選檢視:無法編輯。清除篩選),或您正在檢視基準線。按一下該警告,或按一下返回目前。
- 移動後編號跳號。自動重新編號會改寫同層群組的編號。若要保留手動設定的編號,請在撰寫 ▾ → 重新編號…中清除新增或移動項目後自動重新編號,或鎖定編號不得變更的項目。
- 移除了某個項目,但它仍在資料庫中。移除只會將它從文件中拿出。若要刪除它,請在隨後的訊息中選擇刪除項目…、⇧ / Shift+按一下移除,或按 ⇧Delete / Shift+Delete。
- 字母或羅馬數字編號變成了十進位。自動重新編號與重新編號…會產生十進位編號(1、1.1、1.1.1)。若要保留以字母編號的附錄,請關閉自動重新編號並手動為其編號。
與其他功能的關聯
- 資料來源:
- 匯入可從 Word、Excel、CSV、ReqIF、XMI 與文字建立文件。
- 範本可建立骨架。
- AI 產生器可新增需求。
- 提供資料給:
- 需求可追溯到功能、資產與測試案例(可追溯性)。
- 品質檢查器、TBD/TBR 登錄表、待審查的關聯與核准會作用於文件的需求。
- 檢視 ▾ → 開啟於 ▸ 功能分析會從文件推導出功能。
- 報告會產生 RVTM、VCRM 與變更報告。
- 審查會將文件彙整成彙編。
- 其他所有地方:每個項目都是一個實體。它會出現在資料庫、項目檢視,以及 Spider 圖與樹狀圖等圖中。
文件清單
文件清單會以卡片顯示專案中的每份文件,與「圖」頁面使用相同的圖庫。以需要與需求 → 文件開啟它。
每張卡片會顯示:
- 文件大綱的縮圖。
- 名稱、類型與上次編輯的時間(文件或任何項目的最新變更)。
- 「N 個項目 · N 個需求」。
- 需求有分數時的平均品質 N%。
- N 個 TBD/TBR:未結項目。
| 控制項 | 功能 |
|---|---|
| 搜尋文件… | 顯示名稱、編號或描述包含該文字的卡片。 |
| 排序 | 最近編輯(預設)、編號(大綱順序)、名稱、類別。 |
| 類型膠囊按鈕 | 全部,以及每種文件類型一個附其數量的膠囊按鈕。 |
| 顯示更多 (N) | 顯示更多卡片。 |
| 匯入(頁首) | 開啟「匯入」頁面(匯入與匯出)。 |
| + 新增文件(頁首) | 開啟新增文件。 |
| 卡片上的 ⋯ | 開啟、開啟於 ▸ 項目檢視、再製…與刪除…。 |
刪除…會開啟刪除文件:「刪除「…」。其 N 個章節會作為項目保留在專案中。」當某些章節不在任何其他文件中時,同時刪除沒有其他文件使用的 N 個章節也會刪除它們。復原可還原所有內容。
按一下卡片即可開啟文件。
位址 documents/<id> 會直接開啟文件。加上 ?baseline=<id> 或 ?baseline=latest 可開啟基準線,?find=<text> 可開始搜尋,?comments=1 可在屬性面板中顯示文件的留言。
文件頁面
文件頁面以大綱與表格顯示一份文件,並在屬性面板中顯示所選項目。
頁首
- + 新增 {Class} 會在文件末尾新增一個目前類別的項目。其 ▾ 會開啟類別選單:
- 新增現有項目…。
- 插入文件…與插入產生的章節…(僅限彙編)。
- 在標題新增到末尾下:每個 Statement 類別與 Heading(目前的那一個帶有 ✔),以及其他類別…。
- ✦ AI ▾(在頂端列中)包含文件的 AI 工具(請參閱AI 工具)。
工具列
| 控制項 | 功能 |
|---|---|
| + 之後 | 在所選項目之後、同一層級新增項目(⌘↵ / Ctrl↵)。其 ▾ 會加入新增現有項目…、新增子項目 (⌥⌘ / Ctrl+Alt↵),以及在所選項目之後新增下的類別清單。 |
| + 子項目 | 新增所選項目的子項目(⌥⌘↵ / Ctrl+Alt↵)。其 ▾ 提供新增現有項目…與新增子項目下的類別清單。 |
| ⇤ / ⇥ | 減少縮排(⌥⇧← / Alt+Shift+←)/ 縮排(⌥⇧→ / Alt+Shift+→)所選項目。 |
| ↑ / ↓ | 在同層項目之間上移或下移所選項目(⌥ / Alt+↑ / ⌥ / Alt+↓)。 |
| 移除 | 立即將所選項目及其子樹從文件中拿出(Delete 的效果相同)。已從文件中移除。會提供復原與刪除項目…。⇧ / Shift+按一下或 ⇧Delete / Shift+Delete 會在確認對話方塊列出要刪除的內容後,刪除這些項目及其子項目。Esc 或屬性面板的 × 會清除選取。 |
| 撰寫 ▾ | 新增、插入、產生與編輯內容(請參閱「撰寫」選單)。 |
| 檢查 ▾ | 此文件的品質、模型檢查、追溯狀態、待審查的關聯、TBD/TBR 與留言,並附數量(請參閱「檢查」選單)。 |
| 交付 ▾ | 交付件與頁面設定、Word 範本、版本,以及依輸出分組的匯出(請參閱「交付」選單)。 |
| 檢視 ▾ | 此文件的直接切換:紙張、大綱窗格、追溯狀態與欄(請參閱「檢視」選單)。 |
| 已篩選檢視:無法編輯。清除篩選 | 在類別或標籤篩選或欄排序開啟時出現。按一下即可清除它們。 |
| 尋找 | 開啟搜尋方塊(⌘F / Ctrl+F)。 |
下列情況下結構按鈕會停用:
- 未選取任何項目。
- 所選項目已鎖定。
- 有篩選或排序正在作用。
- 您正在檢視基準線。
大綱窗格
左側的大綱窗格會顯示文件的階層,頂端有一個篩選。沒有分頁:基準線位於標題欄的版本 ▾中,留言則在屬性面板中開啟。
- ‹ 會隱藏窗格,左緣的 › 會再次顯示它(也可使用檢視 ▾ → 大綱窗格)。
- 拖曳其右緣即可調整其大小(180 到 500 px)。
- 選取項目會在窗格旁開啟屬性面板;窗格保持開啟。
- 當窗格與文件合計寬度不足 900 px 時(將屬性面板計為開啟,因此選取項目不會改變此狀態),窗格會收合。之後它會從 › 以覆疊方式開啟。按一下外部即可關閉它。
窗格頂端的篩選:
- 篩選大綱會將大綱縮小到編號或名稱包含該文字的項目,包括已摺疊的項目。其父項會以暗色保留在大綱中作為背景。它不會篩選文件。
- 類別晶片,文件中每個類別一個並附其數量(文件有多個類別時顯示)。按一下晶片即可在文件中只顯示該類別及其子類別;再按一下即可顯示所有類別。在晶片上按右鍵可使用 {Class} 及子類別、僅 {Class} 與清除類別篩選。
- 標籤晶片,文件中使用的每個標籤一個,並附數量。按一下晶片即可只顯示具有所有所選標籤的項目。若要顯示具有數個標籤中任一個的項目,請使用資料庫查詢。
- 晶片超過六個時,它們會收合到依類別或標籤篩選 (n) 之後;收合時,只有正在作用的晶片保持可見。減少篩選會再次收合它們。此瀏覽器會記住該選擇。
- 篩選或排序開啟時會出現清除篩選。篩選後的列會保留其縮排。篩選或排序開啟時無法編輯。
大綱:
- 每個項目都有其色票、編號與名稱,鎖定時有 🔒,並有 ▾/▸ 切換鈕。
- 按一下某個項目即可選取該項目並捲動至該處。
- 拖曳即可重新排序(請參閱拖放)。無效的放置目標會加上標示並被拒絕:項目不能放到其自身子項目之下、已鎖定的項目之下,或無法被它 decomposed by 的類別之下。
- 文件中可見部分的列會反白顯示,且大綱會隨文件一起捲動。當您指向它、在其中操作,或在過去兩秒內捲動過它時,它會停留在原處。
- 放不下的深層層級會顯示 L{n} 層級標記,而不是更多縮排。
文件本文
本文以標題欄開頭:文件的類型與標籤、項目數、開啟文件編號時的「依文件編號」、💬 n 則未解決留言(有留言時;請參閱留言)與版本 ▾(請參閱基準線)。版本 ▾會顯示目前版本、目前 · 最新基準線 {name}或基準線:{name}。其下方:
- 編號與標題:按一下即可編輯文件編號與名稱,或以 Tab 移至它們並按 Enter 或 F2。
- 文件描述:按一下即可在格式化文字編輯器中編輯,或以 Tab 移至它並按 Enter 或 F2。
- 表格。實體欄包含每個項目:切換鈕、編號、名稱、徽章與描述。其他欄是在檢視 ▾ → 欄 ▸中選擇的屬性欄:在您變更之前為 Status、Verification Method 與品質分數。紙張檢視沒有任何屬性欄。
每一列會顯示:
- ▾/▸,用於摺疊或展開其子項目。
- 編號與名稱。按一下即可編輯,或以 Tab 移至其中之一並按 Enter 或 F2。Enter 會儲存,Esc 會取消;焦點會留在欄位上。貼上的換行會變成空格。
- 徽章:
- 🔒:項目已鎖定。
- ⚡:項目帶有指引。指向它即可閱讀。
- 💬 n:未解決的留言。按一下即可在屬性面板中開啟它們。
- ⚠ 審查:上游需求已變更。
- 類別徽章。
- 追溯狀態圓點(僅限需求;請參閱追溯狀態)。
- 描述,在格式化文字編輯器中編輯。
- 左緣的彩色長條:項目自最新基準線以來未變更時為藍色,新增或已變更時為琥珀色。
- 屬性儲存格:
- 標籤以晶片顯示,× 用於移除,+ 用於新增。選單會列出類別允許的標籤,或顯示「沒有其他標籤」。
- 文字屬性可就地編輯。其他屬性使用其類型的編輯器。
- 品質分數會顯示彩色長條:67% 以上為綠色,34% 到 66% 為琥珀色,以下為紅色。文字在上次檢查之後變更時,它會顯示附時鐘圖示的已過時標籤;指向它即可查看原因。
- 「—」表示該類別沒有此屬性。
排序與欄寬:
- 按一下欄標題即可遞增排序,再按一次為遞減,第三次則關閉排序。
- 排序會以平面方式列出項目,不顯示階層,並暫停撰寫。
- 拖曳標題的右緣即可調整欄寬。實體欄至少 300 px 寬,其他欄至少 80 px。寬度會依文件保留在此瀏覽器中。
- 空白的間隔列會分隔最上層章節。
選取列:
- 按一下某列即可選取它。按一下只會選取;若要編輯,請按一下欄位,或在該列上按 Enter 或 F2。
- 若要取消選取,請按一下表格下方的空白處、按 Esc 或按一下 ✕。
- ↑ 與 ↓ 會在列之間移動選取。
- ⌘ / Ctrl+按一下(Windows 與 Linux 上為 Ctrl+按一下)會將項目加入選取或從選取中移除。
- ⇧ / Shift+按一下會依顯示的順序(含任何排序或篩選)選取從上次按一下的項目到此項目的範圍。⌘ / Ctrl+⇧ / Shift+按一下會將該範圍加入選取。
- 在取得焦點的項目上(非編輯中)按 ⌘A / Ctrl+A 會選取所有顯示的項目。⇧ / Shift+↑ 與 ⇧ / Shift+↓ 會從取得焦點的項目延伸選取範圍。
- 相同的手勢也適用於大綱。工具列會顯示數量(「已選取 21 項」)。直接按一下或按 Esc 會回到只選取一個項目。
- 在您正在編輯的欄位中按一下會保留其文字行為:在那裡 ⇧ / Shift+按一下會延伸文字選取範圍。
右鍵選單
在文件中的項目(其編號、名稱、徽章或周圍的空白處)或大綱中的項目上按右鍵,即可在指標處開啟其選單。使用鍵盤時,將焦點移至該列或大綱項目,然後按 Shift+F10 或選單鍵;選單會在該項目處開啟,Esc 會將焦點送回該處。在觸控螢幕上,長按該項目。該項目會成為選取項目。
選單開頭最多有三項依項目狀態挑選的建議動作,每項的右側都有其原因:例如 ✦ 新增可量測準則…(未通過:Unambiguous)、✦ 產生測試案例…(未驗證)、檢查連結…(上游已變更)或解決 TBD…(未結 TBD)。沒有需要修正的內容時,它會建議 ✦ 用 AI 檢查…與 ✦ 詢問 AI 關於此項目…。✦ 更多 AI ▸會列出該項目的所有 AI 動作。規則與完整清單請參閱模型與資料庫。每個 AI 動作都會在任何變更發生之前顯示其結果以供審查。AI 關閉時,AI 部分會是一列變暗的項目並說明原因。
分隔線之後的命令。命令右側顯示的按鍵可從鍵盤執行相同操作(請參閱鍵盤快速鍵):
| 命令 | 功能 |
|---|---|
| 前往 | 僅限大綱。將文件捲動至該項目並將焦點移至它(在大綱項目上按 Enter)。 |
| 開啟 | 開啟項目檢視。 |
| 重新命名… | 變更名稱。在文件中取得焦點的項目上按 F2 即可就地編輯名稱。 |
| 在之後新增 {class} | 在此項目之後新增一個目前類別的項目,與 + 之後相同(⌘↵ / Ctrl↵)。 |
| 新增子項目 {class} | 在此項目之下新增一個目前類別的項目,與 + 子項目相同(⌥⌘↵ / Ctrl+Alt↵)。 |
| 縮排、減少縮排 | 與工具列中的 ⇥ 與 ⇤ 相同(⌥⇧→ / Alt+Shift+→ 與 ⌥⇧← / Alt+Shift+←)。 |
| 上移、下移 | 與工具列中的 ↑ 與 ↓ 相同(⌥ / Alt+↑ 與 ⌥ / Alt+↓)。 |
| 狀態 ▸、優先順序 ▸ | 設定屬性;目前的值會打勾。 |
| 關聯到 ▸ | 先列出該類別最常用的關係,然後是所有關係 ▸,其中包含該類別允許的每種關係。選擇其一會開啟目標實體的選擇器。 |
| 在圖中顯示 ▸ | 列出可顯示該項目的圖類型;選擇其一即可開啟。 |
| 複製連結 | 複製指向該項目之項目檢視的連結。 |
| 複製編號 | 複製該項目的編號。 |
| 開啟於 ▸ | 項目檢視、歷程記錄…、可顯示該項目的圖(階層、樹狀、Spider、Action、Asset、Risk、時間軸)、可追溯性矩陣、需求品質與功能分析。 |
| 移至下方 ▸ | 可容納此項目之項目的清單(可輸入篩選),依文件順序縮排;當項目有父項時,還有文件頂層。子項目會一起移動。 |
| 分割為多個項目… | 請參閱分割為多個項目。 |
| 變更類別… | 開啟變更類別(與資料庫中的對話方塊相同;請參閱模型與資料庫)。 |
| 從此處重新編號… | 為此項目、其後的同層項目及其子項目開啟重新編號。 |
| 為此分支設定屬性… | 請參閱為此分支設定屬性。 |
| 鎖定 / 解除鎖定 | 鎖定項目使其無法編輯,或解除其鎖定。 |
| 從此文件移除 | 將項目及其子項目從文件中拿出(Delete)。實體會保留在專案中;訊息會提供復原與刪除項目…。 |
| 刪除項目… | 確認後刪除該項目及其子項目(⇧Delete / Shift+Delete)。 |
每個命令都能以一次復原撤回。無法套用的命令會變暗,其工具提示會說明原因:
- 在基準線中,或只有檢視權限時,只有前往、開啟、在圖中顯示 ▸、複製連結與複製編號可用。在基準線中,建議與 ✦ AI 動作也會變暗。
- 在已鎖定的項目上,重新命名…、Status ▸、Priority ▸、關聯至 ▸、移動命令與刪除項目…會變暗。
- 篩選或排序作用中時,新增與移動會變暗(「請先清除篩選或排序」)。
- 會將項目移出其層級開頭或結尾的命令會變暗(例如第一個項目上的上移)。
選取了多個項目。在選取範圍內的項目上按右鍵會作用於所有選取的項目。選單會顯示已選取 N 項,並提供 ✦ 批次動作(✦ 用 AI 檢查(n 個需求)…、✦ 改寫 (n) ▸、✦ 產生測試案例 (n)…、✦ 詢問 AI 關於這些項目 (n)…、✦ 建議追溯 (n)…;請參閱對多個選取項目使用 AI)、設定 Status ▸、設定 Priority ▸、新增至文件 ▸、從此文件移除 n 項與刪除 n 個項目…(確認後;所選項目的子項目會一起刪除)。單一項目的命令(前往、開啟、重新命名…、新增、縮排與移動)仍會列出但變暗,原因為「作用於單一實體」。每個命令都是一個復原步驟。在選取範圍以外的項目上按右鍵,會使其成為唯一選取的項目。
描述與您正在編輯的任何欄位會保留瀏覽器自己的選單,因此您可以在那裡複製、貼上與檢查拼字。⌥ / Alt+按右鍵會在任何地方顯示瀏覽器的選單。
快速新增
快速新增可讓您不使用工具列就連續輸入需求。文件下方的列包含快速新增、章節清單、文字欄位與新增。章節清單提供文件末尾,以及每個最上層章節的 Under {number name}。
輸入需求並按 Enter 或按一下新增。新項目會取得:
- 目前的類別。
- 以該文字作為其描述。
- 以「shall」、「must」、「will」或「should」之後的前幾個字組成的名稱:最多五個字,採標題大小寫。
此欄位最多接受 2,000 個字元。篩選或排序開啟時,欄位會顯示「清除篩選或排序以新增實體」。
屬性面板
所選項目會在右側的屬性面板中開啟,並顯示完整的實體面板(請參閱模型與資料庫)。
- 在文件中,decomposed by 與 decomposes 關係在那裡是唯讀的,因為由大綱控制它們。
- 標題的 ×(Esc)會清除選取。檢視 ▾ → 摺疊子項目會摺疊所選項目下的章節。
- 已鎖定的項目會以唯讀方式開啟。
新增項目
新項目
- + 新增 {Class} 會新增到末尾。
- + 之後會新增到所選項目之後。
- + 子項目會新增為所選項目的最後一個子項目,並展開父項。
- 沒有選取項目時,+ 之後與 + 子項目會新增到末尾。
新項目會命名為「New {Class}」。它會被選取,且其名稱會開啟以供編輯。
其他類別
其他類別…會開啟將項目新增到文件,含類別(任何類別)與名稱。將它用於非 Statement 的項目,例如 Asset 描述或測試計畫中的 Test Case。
以 Heading 組織的結構化文件
Heading 是文件的章節(LML 2.0 的結構化成品做法)。當章節混合多種類別(例如需求、動作與風險),或同一個需求出現在多份文件中時,請使用 Heading。
- 在類別選單(+ 新增 ▾、+ 之後 ▾或 + 子項目 ▾)中選擇 Heading。最上層的 Heading 由文件作為其 source of;在另一個 Heading 之下時,它是有編號的子章節。
- 選取 Heading 並使用 + 子項目 ▾新增其內容:任何類別的新項目,或新增現有項目…。Heading contains 該項目。
- 內容會保留自己的編號:新增、移動與重新編號…只會為 Heading 編號,內容的編號維持原樣,因此像 RQ.CLN.1 這樣的需求在每份文件中都相同。章節內容會列在子章節之前。
將內容移至另一個 Heading(拖曳、移至下方 ▸)會移動其 contains 關聯。模型檢查會將 Heading 所包含的需求計為已放入文件。
若要記錄需求的出處,請以 originated by 將其關聯到來源 Artifact(屬性面板 → 關係;Artifact 會將其列在 originates 下)。在 Heading 推出之前建立的專案會保留其結構描述;結構描述 → 新增新的內建項目…會新增 Heading、contains 與 originates。
CubeSat EO-1 示範中的範例:EO-1 System Requirements Specification 的章節 7 Applicable Documents 是一個 Heading。其內容是兩項專案標準,它們保留編號 STD-1 與 STD-2。STD-1 originates 需求 3.4 Bus Regulation,STD-2 originates 5.2 UHF Command Uplink。
現有實體
新增現有項目…會開啟實體選擇器。選擇器會排除該文件及其目前的項目。實體會連同其整個分解一起加入。帶入子項目時,通知會顯示「已新增 {entity} 及 N 個子實體」。
重新組織
縮排、減少縮排與移動
- 縮排會使項目成為其上方同層項目的最後一個子項目。群組中的第一個項目無法縮排。
- 減少縮排會使項目成為其父項的下一個同層項目。
- 上移/下移會將項目與其相鄰項目交換。已鎖定的項目與已鎖定的相鄰項目不會移動。
- 無法移動時,通知會顯示「所選實體無法再往該方向移動。」
拖放
在大綱窗格中拖曳。拖曳到接近其頂端或底端邊緣時,清單會捲動。放置的位置決定結果:
- 列的上方 28%:項目會放在其前面。
- 列的下方 28%:項目會放在其後面。
- 列的中間:項目會成為其子項目。
- 頂端的文件名稱:項目會成為末尾的最上層項目。
移至下方
在項目上按右鍵並選擇移至下方 ▸。清單包含可將其作為子項目的項目,依文件順序縮排;當項目有父項時,還有文件頂層。輸入以篩選清單,然後選擇新的父項。子項目會一起移動;通知會顯示「已移動 {item}」。
清單會排除項目自身的子樹、其目前的父項、已鎖定的項目,以及結構描述不允許的父項。移動失敗時,訊息會顯示「項目無法移到那裡:新的父項位於其內部,或項目已鎖定。請選擇其他父項或將其解除鎖定。」
編號
自動重新編號
新增或移動項目後自動重新編號預設為開啟;請在撰寫 ▾ → 重新編號…中變更。開啟時,下列動作會為受影響的同層群組及所有子代重新編號:新增、移動、縮排、減少縮排、移除與分割。
- 最上層項目會取得文件的編號模式與流水號。它從文件的起始編號開始:1,除非在重新編號…中變更。
- 子項目會取得其父項的編號、一個句點與流水號(
3、3.1、3.1.1)。 - 已鎖定的項目與詞彙表項目(標示為 Acronym 的項目,其編號就是術語)會保留其編號,但仍佔有一個位置。
關閉時:
- 新項目會取得其前一個項目之後的下一個編號。第一個子項目會取得父項的編號加上
.1。 - 現有編號不會變更。
- 移動項目只會為移動的子樹重新編號。
- 上移/下移會交換兩個編號。
下一個編號的規則
為了延續序列,Holarch 會遞增前一個編號的最後一部分。它會保留分隔符號以及結尾的句點、冒號或括號。
- 數字:
1.9→1.10、2.→3. - 字母:
a→b、z→aa、Z→AA、Appendix A→Appendix B - 兩個字母以上的羅馬數字:
IV→V、IX→X。單一字母視為字母(I→J)。 - 其他任何內容則會附加
.1。
重新編號
撰寫 ▾ → 重新編號…會一次為整份文件重新編號。項目右鍵選單中的從此處重新編號…會為該項目、其後的同層項目及其所有子項目重新編號。
此對話方塊包含:
- 模式:
{n}是位置,{n:3}會將其補足為三位數。SYS-{n:3}會產生 SYS-001、SYS-002;其子項目在其下編號為 SYS-001.1、SYS-001.2。沒有{n}的模式會在其末尾加上編號。從項目開啟時,模式與起始編號會依其編號預先填入。 - 起始編號(僅限數字)。其他輸入會顯示「請以數字輸入起始編號,例如 1。」
- 含項目、目前與新的預覽表格(變更的編號會反白顯示;最多 400 列),以及「40 個編號中有 12 個會變更。」之類的計數。
- 新增或移動項目後自動重新編號(僅限整份文件)。
- 附註「已鎖定的項目會保留其編號。按一次復原即可撤回整個重新編號。」詞彙表項目也會保留其編號。
- 重新編號。通知會顯示「已更新文件編號」。
對整份文件執行時,會將模式與起始編號隨文件一起儲存。之後的自動重新編號會使用它們。
文件編號(中繼編號)
文件編號會為每份文件保留各自的編號。當同一個需求以不同的編號出現在兩份文件中時,請使用它。
以交付 ▾ → 交付件設定… → 編號 → 文件編號(僅保留在此文件中)開啟它。模型編號(項目自身的編號)會將其關閉。
- 開啟時,每個項目目前的編號會複製到文件中。
- 從此之後,編號的編輯只會變更此文件。
- 開啟期間,標題欄會顯示「· 依文件編號」。
- 匯出與報告會使用文件編號。
範本
範本來自四個地方。新增文件與使用範本依此順序列出它們,此文件類型的範本排在前面:
| 群組 | 保存位置 | 誰可以新增或變更它 |
|---|---|---|
| 組織範本:{name} | 在 Holarch 伺服器上(託管或自行架設),供組織使用 | 組織管理員 |
| 專案範本 | 在專案檔案中;專案的每位成員都能看到 | 專案擁有者(在桌面應用程式中:任何開啟該專案的人) |
| 內建範本 | 在 Holarch 中 | 沒有人 |
| 已儲存在此瀏覽器中 | 僅在此瀏覽器中(1.8.0 版之前儲存的範本) | 將它們匯入專案 |
內建範本
每個內建範本都有附起始表格的編號章節(例如修訂歷程與核准表格)。使用包含撰寫指引時,每個章節也會以簡短的撰寫指南開頭。
「新增文件」會顯示每個範本的章節數,例如 Requirements Specification 為「39 個章節」。
這些範本依循各類文件常見的系統工程實務:利害關係人、系統、軟體與介面需求規格、介面控制文件、架構描述、驗證與確認、測試與風險計畫、測試程序與報告、權衡研究,以及組態管理。
許多章節包含即時區塊,每當文件顯示或匯出時都會從模型更新:
| 區塊 | 存在於 |
|---|---|
| 文件自身需求的 VCRM、依層級的 VCRM、RVTM 與 RTM | 需求規格(Verification 與 Traceability 章節) |
| 整個專案的 VCRM 與 RVTM | Test Plan、Verification and Validation Plan、Test Procedure、Test Report |
| 介面矩陣與管道清單 | Interface Control Document、Architecture Description |
| 分配矩陣(功能到元件) | Concept Definition、Architecture Description |
| 標示為 Acronym 的陳述 | 每個 Acronyms 章節 |
| 標示為 Reference 的成品 | 每個 References 章節 |
| Risk;Trade Study 成品 | Risk Management Plan;Trade Study Report |
涵蓋「此文件」的矩陣會指向新文件。對於 Test Report,請以插入 ▸ 矩陣… ▸ Test Report 加入某個測試週期的結果,並選擇測試套件與週期。
將文件另存為範本
將文件的結構另存為範本,即可從它開始新文件。
- 選擇撰寫 ▾ → 範本 ▸ 另存為範本…。
將 {Type} 另存為範本隨即開啟。
- 輸入範本名稱。
- 在儲存到中選擇:
- 此專案:專案的每位成員都可以使用它。只有專案擁有者會看到此選項。
- 組織:{name}(Holarch 伺服器,組織管理員):組織的每位成員都可以使用它。勾選將它設為組織的 {Type} 預設範本,即可在「新增文件」中預先選取它。
- 若範本應保留檔案與影像,請勾選包含檔案和影像。
- 按一下儲存。
範本會儲存每個項目的類別、名稱、編號、描述、層級、標籤與一般屬性值。品質結果不會包含在內。套用範本時,涵蓋已儲存文件的矩陣會改為涵蓋新文件。
若兩種都無法儲存,對話方塊會說明:請洽專案擁有者或組織管理員。
管理範本
撰寫 ▾ → 範本 ▸ 管理範本…會列出專案的範本。擁有者可以重新命名與移除它們;復原可還原已移除的範本。從範本建立的文件不會變更。
組織管理員在組織設定 → 文件範本中管理組織範本:開啟組織並使用文件範本來重新命名範本、開啟或關閉預設(每種文件類型一個預設範本),或移除它。
儲存在此瀏覽器中的範本
在 1.8.0 版之前,自訂範本儲存在瀏覽器中。專案擁有者第一次開啟範本清單時,Holarch 會提議將它們複製到專案中:匯入至專案或暫不。在此之前,它們會列在已儲存在此瀏覽器中下。管理範本…為它們提供匯入至專案與從瀏覽器移除。
將範本套用到現有文件
撰寫 ▾ → 範本 ▸ 套用範本…會開啟使用範本,含文件類型、範本、將此文件另存為範本…與管理範本…。
套用會將範本的章節連同其編號與巢狀結構加到文件末尾。通知會顯示「已新增 N 個章節。」復原會移除它們。
格式化文字編輯器
格式化文字編輯器可編輯帶有格式、表格、影像與即時內容的描述。按一下描述(或文件描述)即可編輯它。使用鍵盤時,以 Tab 移至描述並按 Enter 或 F2;螢幕閱讀器會將其宣告為以其項目命名的文字欄位(「1.2 Power Budget 的描述」)。
編輯器會就地開啟,附工具列、字數與字元計數器(「字數:N · 字元:N」)以及提示「⌘↩ / Ctrl+Enter 儲存 · Esc 取消 · Tab 離開」。
- 若要儲存,請按 ⌘↵ / Ctrl↵、按一下 ✓、按一下編輯器外部,或按 Tab 離開它。
- 若要取消,請按 Esc。焦點會返回描述。
- 每次儲存都能以一次復原撤回。
- Tab 永遠不會縮排,因此它不會將您困在編輯器中。請以 ⌘ / Ctrl+
]/ ⌘ / Ctrl+[或 ⇤ / ⇥ 縮排清單。
工具列
| 按鈕 | 功能 |
|---|---|
| + | 插入選單:✦ 使用 AI 撰寫…、影像…、替代文字…(文字中有影像時)、表格…、程式碼區塊、線條、連結…、連結到文件…、檔案…、圖…、即時值…、計數或合計…、即時表格…、矩陣…、交互參照…、符號…,以及文字中有圖的圖片時的更新圖插圖 |
| ✦ | AI 文字工具(見下文) |
| ¶ ▾ | 段落樣式:文字、標題 1 到標題 4、引述、程式碼區塊 |
| B / I / U | 粗體(⌘B / Ctrl+B)、斜體(⌘I / Ctrl+I)、底線(⌘U / Ctrl+U) |
| ⋯ | 底線 (⌘U / Ctrl+U)、刪除線、上標、下標、行內程式碼、醒目提示、清除格式設定 (⌘⇧M / Ctrl+Shift+M) |
| • / 1. | 項目符號清單(⌘⇧8 / Ctrl+Shift+8)/ 編號清單(⌘⇧7 / Ctrl+Shift+7) |
| ⇤ / ⇥ | 減少縮排(⌘[)/ 縮排(⌘]) |
| ≡ ▾ | 對齊:靠左、置中、靠右、左右對齊 |
| ▦ | 插入表格…,以及在表格內的表格操作 |
| 🔗 | 連結(⌘K / Ctrl+K) |
| A | 文字色彩與背景色票(各十種色彩)以及移除色彩 |
| Aa | 所選內容的字型(Arial、Brush Script MT、Comic Sans MS、Garamond、Georgia、Helvetica、Impact、monospace、Times New Roman)與大小(10 到 60 px) |
| ↶ / ↷ | 在編輯器內復原(⌘Z / Ctrl+Z)/ 重做(⇧⌘Z / Ctrl+Shift+Z) |
</> | HTML 原始碼(⌘/ / Ctrl+/);切換回來時會清理原始碼 |
| ⤢ | 全螢幕;Esc 會先離開全螢幕 |
| ✓ | 儲存(⌘↵ / Ctrl↵) |
套用於所選內容的字型、大小與樣式需要先選取內容。未選取時,通知會顯示「請先選取一些文字。」
表格
插入表格會要求輸入列(預設 2)、欄(預設 3)與標題列(開啟)。Tab 與 Shift+Tab 會在儲存格之間移動。在最後一個儲存格按 Tab(或在第一個儲存格按 Shift+Tab)會離開編輯器。
在表格內,按一下 ▦ 或在儲存格上按右鍵即可使用表格操作:
- 在上方新增列、在下方新增列、在左側新增欄、在右側新增欄。
- 新增標題列、新增標號、與右側儲存格合併。
- 刪除列、刪除欄、移除標題列、移除標號、刪除表格。
影像與檔案
- 影像…會將圖片檔案插入為插圖。插入影像對話方塊會要求輸入替代文字(影像顯示的內容),對於不提供資訊的圖片則可選擇裝飾性(不需替代文字)。
- 您也可以貼上影像,或將影像檔案拖放到編輯器中。這些影像一開始沒有替代文字;通知會顯示「已新增沒有替代文字的影像。請以 + 選單(替代文字…)新增。」
- 貼上影像位址(以 .png、.jpg、.jpeg、.gif 或 .webp 結尾)會插入該圖片。
- 最長邊超過 4,000 px 的影像會縮小以符合限制。通知會顯示「影像已縮小為 W × H px(最長邊上限為 4000 px)。」
- 超過每個檔案上限的影像檔案會以 1,600 px 寬度重新繪製為 JPEG。若仍然太大,通知會顯示「影像超過 N MB 的上限。」
- 檔案…會將任何檔案附加為下載連結,並附其類型的圖示。超過上限的檔案會顯示「檔案超過 N MB 的上限。」
替代文字
替代文字會為螢幕閱讀器及 Word 的協助工具檢查描述影像。
- + → 替代文字…會列出文字中的每個影像及其替代文字與裝飾性方塊。當影像沒有替代文字,或替代文字是檔案名稱時,它會發出警告。
- 按兩下影像,或在其上按右鍵並選擇編輯替代文字…,即可只編輯該影像。
- 圖的圖片(圖…)會從標號取得其替代文字:圖類型與實體名稱。
- Word 輸出會將替代文字寫入每張圖片的描述。裝飾性圖片會標示為裝飾性。
連結與內嵌連結
- 連結…(插入連結)需要 URL 與文字。沒有
http:、https:、mailto:或#的位址會加上https://。連結會在新分頁中開啟。 - 連結到文件…(插入文件連結)會連結到另一份文件。它需要文件、版本(目前或基準線:{name})與文字。
- 在 Word 輸出中,以此方式連結的文件可以附加為附錄。
- 沒有其他文件時,通知會顯示「此專案沒有其他文件。請先建立一份。」
即時內容
無論文字顯示在何處,即時內容都會與模型保持同步:在文件中、屬性面板中、匯出中與搜尋中。
- 圖…(插入圖):選擇圖類型與實體(或白板或框架)。它會插入一張附標號、連結到該圖的圖片。
- 該圖片是即時的。模型變更時,文件會在片刻後顯示新圖片,Word 與其他匯出也會重新繪製它。
- 若要保留目前的圖片,請在編輯器中按兩下插圖(圖插圖)並關閉模型變更時更新圖片。插圖就會成為快照。
- 更新圖插圖(在 + 中)會立即重新繪製文字中的每個即時插圖。
- 當圖的實體被刪除時,插圖會保留其最後的圖片。
- 即時值…:挑選一個實體與一個屬性。編輯器會顯示其「即時值」。若要變更該屬性,請按兩下即時值(編輯動態值)。
- 計數或合計…會插入一個從模型重新計算的數字,用於執行摘要或狀態行,例如「40 個需求中有 12 個已驗證」(兩個計數)。其欄位:
- 查詢:要計算哪些實體,例如
class:Requirement AND Requirement:"Status=Approved"。請參閱搜尋語法。 - 範圍:整個專案、此文件或另一份文件。以彙編作為範圍會涵蓋其所有部分。
- 函數:計數、加總、平均值、最小值或最大值。除了「計數」之外,都需要一個數字屬性,例如 Cost 的 Amount。沒有可合計的數字時,值為 N/A。
- 目前的值。若要稍後變更計數,請按兩下它。
- 查詢:要計算哪些實體,例如
- 矩陣…會插入即時的 RTM、RVTM、VCRM、分配矩陣或其他矩陣。請參閱文件產生。
- 即時表格…會插入依查詢列出實體的表格。每當文字顯示或匯出時,列都會重新計算。其欄位:
- 查詢,例如
class:Requirement AND label:"Functional Requirement"。預設為order:modified-。請參閱搜尋語法。 - 範圍:整個專案、此文件,或另一份文件或彙編。
- 欄(依順序):預設為 Number、Name。+ 新增屬性…會新增一個屬性欄。+ 新增關係欄…會新增一個列出相關實體的欄,例如 Verified by。
- 上限:預設 10。所有列會列出每個符合項目。
- 最多 50 列的預覽。
- 若要稍後變更即時表格,請按兩下它。
- 查詢,例如
- 試算表範圍…會將試算表的儲存格插入為表格,或您選擇之類型的圖表(或工作表本身的圖表之一),並附標號。挑選試算表、工作表與範圍,並可選擇要依循的共用檢視。表格與圖表會顯示目前的值,並在儲存格變更時更新;Word 與其他匯出會使用匯出當下的值。範圍被刪除時,表格會保留其最後的列並標示為遺失。
- 交互參照…(插入交互參照)會依目前的編號參照已開啟文件的某個部分:
- 章節或項目會顯示項目的編號與名稱,例如「3.2 Frost Warning」。其他實體…會挑選文件之外的實體。
- 插圖與表格會列出文件中有標號的插圖與表格,顯示為「圖 2」或「表 1」。選擇尚無參照鍵的項目時,會為其新增一個鍵。
- 文字會隨重新編號更新。在 Word 輸出中,交互參照會成為 Word 以標號編號更新的欄位。目標已刪除的交互參照會保留其文字並加上標示。
- 符號…會插入下列其中之一:± ° µ Ω ≈ ≠ ≤ ≥ × ÷ √ ∞ ∑ π Δ、箭頭、• … — –、© ® ™ § ¶、€ £ ¥ ¢、½ ¼ ¾ ² ³、✓ ✗。
AI 文字工具
✦ 會改寫所選內容;未選取任何內容時則改寫目前的段落。沒有可處理的內容時,通知會顯示「沒有可改寫的文字。」
這些工具:
- 改善措辭、簡化、修正拼字和文法、縮短、新增詳細資訊、完成句子。
- 以某種語氣改寫…:學術、堅定、隨意、自信、建設性、同理、振奮、流暢、正式、友善、激勵、專業。
- 翻譯…與翻譯全文…:阿拉伯文、中文、英文、法文、德文、希臘文、義大利文、日文、韓文、葡萄牙文、俄文、西班牙文、瑞典文、烏克蘭文。
- 使用 AI 撰寫…。
預覽會顯示「目前」、「建議」與「變更」。選擇取代、重試或捨棄。
貼上
貼上的格式化文字會保留其結構:標題、清單、表格與連結。它會失去類別、行內樣式(表格儲存格除外)與 Office 標記。所有格式化文字中的指令碼、框架與不安全的連結都會被移除。
格式化文字快速鍵
| 按鍵 | 動作 |
|---|---|
| ⌘↵ / Ctrl↵ | 儲存並關閉 |
| Esc | 取消(或離開全螢幕) |
| ⌘B / Ctrl+B / ⌘I / Ctrl+I / ⌘U / Ctrl+U | 粗體 / 斜體 / 底線 |
| ⌘K / Ctrl+K | 連結 |
| ⌘⇧7 / Ctrl+Shift+7 / ⌘⇧8 / Ctrl+Shift+8 | 編號 / 項目符號清單 |
⌘] / ⌘[ | 縮排 / 減少縮排 |
| Tab / Shift+Tab | 下一個 / 上一個表格儲存格;在其他地方則離開編輯器(會儲存) |
| ⌘⇧M / Ctrl+Shift+M | 移除格式設定 |
| ⌥⌘0 / Ctrl+Alt+0 | 文字段落 |
| ⌥⌘1 / Ctrl+Alt+1 到 ⌥⌘4 / Ctrl+Alt+4 | 標題 1 到標題 4 |
| ⌘/ / Ctrl+/ | HTML 原始碼 |
| ⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+Z | 在編輯器中復原 / 重做 |
在文件中尋找
按一下尋找或按 ⌘F / Ctrl+F 即可搜尋文件。搜尋方塊會顯示「m 個中的第 n 個」。
搜尋涵蓋每個項目的編號、名稱與描述、顯示的欄中的值,以及品質檢查訊息。它會略過被篩選隱藏的項目。
- Enter 或 ▼ 會前往下一個符合項目。
- Shift+Enter 或 ▲ 會前往上一個符合項目。
- Esc 會清除文字,× 會關閉方塊。
摺疊的章節會展開以顯示符合項目。符合的列會反白顯示,目前的那一列會加上標示。
尋找與取代
撰寫 ▾ → 尋找及取代…會開啟尋找及取代。它包含:
- 尋找與取代。
- 要搜尋的欄位:名稱、編號與描述。編號預設為關閉。
- 大小寫須相符與全字拼寫須相符。
欄位下方的那一行會顯示「N 個實體符合(已鎖定的實體會略過)。」全部取代會變更文件項目中的每個符合項目,一次復原即可全部撤回。通知會顯示「已更新 N 個實體」或「沒有符合項目」。在格式化文字中只有文字會變更:格式、連結與表示法保持不變。
「撰寫」選單
撰寫 ▾包含新增與變更內容的命令。在基準線中、只有檢視權限時以及篩選或排序開啟時,新增項目的命令會變暗;工具提示會說明原因。
| 項目 | 功能 |
|---|---|
| 新增項目 ▸ | Statement 類別與其他類別…。在所選項目之後新增項目;未選取任何項目時則新增到末尾。所選的類別會成為目前的類別。 |
| 新增現有項目… | 請參閱現有實體。 |
| 插入 ▸ | 將即時內容插入所選項目的描述:即時值…、計數或合計…、即時表格…、矩陣…、圖的圖片…、試算表範圍…與交互參照…。描述編輯器會在文字末尾開啟,並顯示所選的對話方塊(請參閱即時內容)。在選取未鎖定的項目之前會變暗(「請先選取一個未鎖定的項目」)。在彙編中,它還會提供文件…與產生的章節…(請參閱彙編)。 |
| ✦ 產生需求… | AI 產生器,用於所選項目之下或整份文件。每個結果在加入之前都會先預覽。 |
| ✦ 產生子需求… | 選取了 Statement 或需求時:為其建立新的子項目。 |
| ✦ 產生風險… | 選取了項目時:為其產生風險。 |
| ✦ 產生測試案例… | 選取了需求時:產生一個驗證它的測試案例。 |
| ✦ 摘要… | 撰寫一個摘要項目,保持在文件最前面,不附編號。 |
| ✦ 翻譯… | 翻譯文件的文字,並附預覽。 |
| 尋找及取代… | 請參閱尋找及取代。 |
| 重新編號… | 請參閱重新編號。 |
| 範本 ▸ | 套用範本…(套用範本)、另存為範本…(將文件另存為範本)與管理範本…(管理範本)。 |
為此分支設定屬性
在項目上按右鍵並選擇為此分支設定屬性…,即可為該項目及其所有子代設定同一個值。選擇新增標籤、移除標籤或某個屬性,然後選擇值。對話方塊會註明「套用至 {item} 及其 N 個子代。已鎖定的實體會略過。」通知會顯示「已更新 N 個實體(略過 k 個已鎖定)」。
分割為多個項目
在項目上按右鍵並選擇分割為多個項目…,即可將複合需求拆分為單一需求。對話方塊的標題為分割為多個項目:{item}。
- 選擇依句子分割或依段落分割,以及新項目作為其子項目或在其後新增項目。
表格會為每個部分顯示一個建議的項目,附其編號、可編輯的名稱與文字。
- 或按一下 ✦ 建議分割,讓 AI 建議單一需求(最多 20 個)。
- 文字中含有網址的列一開始不勾選。
- 當原始項目已核准、已建立基準線或已鎖定時,取代其文字是一個未勾選的選擇性選項。
- 差異會顯示第 1 列與原始項目的比較。
- 編輯名稱與文字。合併會將某個部分與下一個部分合併。
- 取消勾選您不要的部分,然後按一下套用。
第 1 部分(「保留」)會留在原始項目中。每個已勾選的部分都會成為相同類別、相同標籤的新項目。編號會自動建議;自動重新編號開啟時,分割後會重新指派編號。按一次復原即可撤回整個分割;通知會顯示「已分割為 N 個項目」。
「檢查」選單
檢查 ▾會列出此文件中需要處理的內容,右側附數量:
| 項目 | 功能 |
|---|---|
| 檢查品質 | 檢查文件中通過目前篩選的每個需求,並開啟結果。選取了需求時,該項目為檢查此需求的品質。沒有需求時:「此文件沒有可檢查的 Requirement。Statement 不會被評分。」 |
| 此文件的模型檢查… | 開啟此文件的模型檢查:該文件及其項目的模型檢查發現事項(規則、項目、發現事項),以及指向遺失內容的即時內容。按一下某個項目即可選取它。沒有時:「此文件沒有發現事項。」開啟模型檢查會開啟整個專案的頁面。 |
| 追溯狀態… | 顯示「M 個中有 N 個已完成」,並開啟追溯狀態:尚未分配或驗證的需求,每個都附其圓點與缺少的內容(satisfied by、verified by)。按一下其中一個即可選取它。開啟 RVTM 會開啟 RVTM 頁面。文件有需求時顯示。 |
| 待檢查的連結 | 開啟此文件的「待檢查的連結」。 |
| TBD/TBR 登錄表 | 開啟此文件的 TBD/TBR 登錄表。 |
| 尋找縮寫… | 請參閱尋找縮寫。 |
| 留言 | 顯示未解決留言的數量,並在屬性面板中開啟它們(請參閱留言)。 |
追溯狀態
每個需求徽章之後的圓點會顯示其追溯狀態:
- 綠色:需求被某物 satisfied by(已分配)且被某物 verified by。
- 琥珀色:缺少兩者之一。
- 紅色:兩種關聯都不存在。
指向圓點即可查看狀態與缺少的內容,例如「追溯狀態:部分追溯。缺少:沒有 verified by 關聯(未驗證)。」按一下它會開啟選單,含滿足者(配置)與 Verified by 下的項目(按一下即可開啟)、在 RVTM 中開啟與關聯至 ▸。Statement 與其他類別沒有圓點。在基準線中,圓點會顯示基準線的關聯。以檢視 ▾ → 追溯狀態關閉圓點。
尋找縮寫
檢查 ▾ → 尋找縮寫…會在文件的編號、名稱與描述中找出縮寫,並在一份審查清單中將它們加入其 Glossary 章節。
- 縮寫是兩個以上的大寫字母,最多八個字元,且不全為數字。
- 全稱來自專案的現有項目,或來自術語旁其首字母拼成該術語的字(「Concept of Operations」→ CONOPS)。
- 每一列都有保留、術語、全稱及其使用次數(按一下「N 次使用」即可查看它出現的每個位置)。附註會標示已「在 Glossary 中」、「專案中已有項目」或「找不到全稱」的術語。
- 有全稱但尚未在 Glossary 中的術語一開始會勾選。標題列中的方塊會全部勾選或全部取消勾選。
- 將文字中的每次使用連結到其詞彙表項目(即時值)(開啟)會將描述中的每次使用轉換為該項目編號的即時值,並連結到該項目。
按一下新增到詞彙表。每個勾選的術語都會成為標示為 Acronym 的 Statement,Number = 術語、Name = 全稱,位於文件最上層的 Glossary 章節之下(會使用現有名為 Glossary 或 Acronyms 的章節;否則會在末尾新增一個)。專案中已有的項目會被重複使用,而不會建立第二個。一次復原即可全部撤回。什麼都沒找到時,您會看到「此文件中沒有縮寫。縮寫是有兩個以上大寫字母的字,例如 CONOPS。」;未勾選任何項目時,會看到「至少勾選一個術語。」重新編號不會變更詞彙表項目。
「交付」選單
交付 ▾會設定交付件並匯出它,依輸出分組:
| 項目 | 功能 |
|---|---|
| 交付件設定… | 編號、標題頁、頁首與簽署區塊(請參閱交付件設定)。 |
| 頁面設定… | 機密等級標示、封面頁與頁碼(請參閱頁面格式)。 |
| Word 範本 ▸ | Word 範本,此文件使用的範本附 ✔,以及編輯 Word 範本…。選擇其一會使其成為此文件的範本。 |
| 版本 ▸ | 儲存基準線…與比較版本…(請參閱基準線)。 |
| Word:每個 Word 範本一個 {template} (Word) | 立即以該範本的選項下載 Word 格式的文件;文件自身的範本會顯示「此文件」。從基準線下載時,輸出為該基準線。 |
| 大綱 (Word)… | 以標題呈現的大綱,可選擇附目錄。 |
| 修訂標記版 (Word)… | 請參閱修訂標記。需要基準線。 |
| Excel:可追溯性矩陣… | 以 Excel、Word、CSV 或網頁輸出的標準矩陣(請參閱文件產生)。 |
| 變更 (Excel)… | 從某個基準線到較晚的基準線或目前版本的變更。需要基準線。 |
| 交換:需求 (ReqIF)…、文件資料 (JSON)… | 交換格式(請參閱報告)。 |
| 列印或 PDF… | 請參閱列印 / PDF。 |
| 所有匯出… | 每種匯出及其選項(請參閱報告)。 |
Word 範本
Word 範本是一組具名的 Word 匯出選項與頁面設定。它決定 Word 檔案的樣式,而非內容(文件範本填入內容;請參閱範本)。每份文件使用一個;預設為 Specification。請在交付 ▾ → Word 範本 ▸中選擇它。
內建範本:
| 範本 | 選項 |
|---|---|
| 規格 | 目錄到第 3 層、編號的標號、圖目錄與表目錄、來自基準線的修訂歷程與核准、作為附錄的關聯文件。文件顯示屬性欄時會包含屬性欄。 |
| Deliverable by Chapter | 與 Specification 相同,但標號依章節編號(圖 3-1),且描述中的標題會出現在目錄中。 |
| Review Copy | 橫向頁面,每個項目下方附文件的屬性欄;目錄到第 2 層,沒有前置表格。 |
| Plain | 標題、標題與文字:沒有目錄、標號編號或前置表格。 |
所有內建範本都使用 Letter 頁面。
編輯 Word 範本…會開啟 Word 範本。內建範本有複製;副本會成為專案範本,保存在專案中供每位成員使用。選取專案範本即可變更:
- 名稱、頁面大小(Letter (8.5 × 11 in) 或 A4 (210 × 297 mm))與方向(直向或橫向)。
- 目錄(無、第 1 層、第 1–2 層、第 1–3 層、第 1–4 層、所有層級)與標號編號(圖 1、表 1、依章節:圖 3-1或關閉)。
- 圖目錄和表目錄(有標號時)、說明中的標題會出現在目錄中、文件中顯示的屬性欄,位於每個項目下方、作為附錄的關聯文件與來自基準線的修訂歷程記錄和核准。
- 刪除範本。
按一下儲存(按一次復原即可撤回;通知會顯示「已儲存 Word 範本。」)。範本已刪除的文件會回到 Specification。
公司 Word 檔案
專案範本可以帶有您組織自己的 Word 檔案(.docx 或 .dotx,最大 5 MB)。匯出接著會使用該檔案的:
- 樣式:字型、色彩、標題與內文樣式。檔案缺少的樣式(標號、目錄項目)會被加入;檔案中的標題編號會被捨棄,因為 Holarch 會為標題編號。
- 頁面:大小、方向與邊界。選擇該檔案會將範本的頁面大小與方向設為相符。
- 頁首與頁尾,以及其中的標誌與頁碼。專案或文件的機密等級標示會加入每一個頁首與頁尾。
- 標題頁:檔案第一個分節符號之前的內容,或沒有分節符號時的整個檔案。它會取代 Holarch 的標題頁。
在標題頁以及頁首與頁尾中,會填入下列預留位置:{{Title}}、{{Type}}、{{Number}}、{{Version}}、{{Date}}、{{Project}}、{{Organization}}、{{Contract}}、{{CDRL}}、{{Prepared For}}、{{Prepared By}} 與 {{Baseline}}。大小寫與空格不影響。大括號中的其他文字會保持原樣。
若要新增一個:
- 選擇交付 ▾ → Word 範本 ▸ → 編輯 Word 範本…。
- 按一下公司 Word 檔案列中的選擇…,或選取專案範本並按一下公司 Word 檔案下的選擇…。
- 選擇該檔案。按一下儲存。
取代…會更換檔案,移除會回到 Holarch 的樣式與標題頁。不是 Word 文件的檔案會被拒絕,並顯示「該檔案不是 Word 文件(.docx 或 .dotx)。」連到文件外部的內容會被排除:連結的圖片、內嵌物件與控制項,以及 INCLUDETEXT、INCLUDEPICTURE、DDE、LINK 與 IMPORT 欄位。巨集永遠不會被讀取。
範本的頁面也會設定紙張檢視的寬度:Letter 頁面寬 816 px,A4 為 794 px,橫向時更寬。在所有匯出… → 文件 (Word)中,選項會從文件的範本開始;那裡的 Word 範本可從另一個範本填入選項,您也可以只為一次匯出變更它們。
「檢視」選單
檢視 ▾包含此文件的直接切換:
- 紙張(開啟時有 ✔):將文件顯示為頁面,寬度與 Word 範本的頁面相同,不顯示屬性欄。Requirements Document 一開始為關閉;其他類型一開始為開啟。
- 大綱窗格:顯示或隱藏大綱窗格。
- 追溯狀態:顯示或隱藏追溯狀態圓點。預設為開啟。
- 欄 ▸(在紙張檢視中變暗):文件中各類別的每個屬性與項目欄位(Class、Number、Created On、Modified On、Labels),顯示的欄附 ✔。選擇其一即可顯示或隱藏它;新欄會放在末尾。預設欄會還原 Status、Verification Method 與品質分數。
- 全部摺疊,以及有內容摺疊時的全部展開。
- 摺疊子項目:摺疊所選項目下的章節(在選取有子章節的項目之前會變暗)。
- 重設檢視:清除摺疊、篩選、排序與搜尋。它也會以預設寬度顯示大綱窗格、重設欄寬並還原預設欄。
- 開啟於 ▸:在另一個檢視中開啟所選項目(未選取任何項目時為文件):項目檢視、歷程記錄…(每項記錄的變更,每個欄位附字詞差異)、可顯示它的圖、可追溯性矩陣(以文件作為列軸)、需求品質(範圍限於該文件)與功能分析。
- 說明。
在欄標題上按右鍵可使用左移、右移和隱藏欄。
欄會依文件記憶在此瀏覽器中。最後一次的選擇會作為尚未設定之文件的起點。Paper 和 Trace Status 會隨文件一起儲存。選取列時,水平捲動位置保持不變。
基準線
標題欄中的版本 ▾列出目前版本、此文件的基準線,以及在專案基準線下的專案基準線(各附日期;✔ 標示目前顯示的那一個)。選單最後是儲存基準線…和比較版本…。交付 ▾ → 版本 ▸也有這兩個指令。
建立基準線
- 按一下版本 ▾ → 儲存基準線…(顯示基準線時為灰色:「請先返回目前版本」)。
儲存基準線開啟時附有說明:「基準線會保留此版本的文件(其項目、屬性和關係),供日後檢視、比較和還原。核准紀錄的日期為現在,之後無法編輯。」
- 輸入名稱(必填)。預設為「{document} Baseline N」。
- 在核准下,每位核准者填寫一列:名稱、角色和聲明。第一列已預先填入您的名稱。預設聲明為「Approved for release.」(核准發行。)
- 按一下+ 新增核准者以新增列,或按×移除一列。沒有名稱的列會被忽略。
- 按一下建立。
通知會顯示「已儲存基準線」。
檢視基準線
在版本 ▾中選擇基準線。橫幅顯示「基準線“{name}”,唯讀,儲存於 {date}」(專案基準線會加上「· 專案基準線」),並列出核准者。橫幅提供:
- 返回目前:返回工作副本。
- 編輯(文件基準線):開啟編輯基準線。可重新命名基準線,或在新增核准下新增核准紀錄。「新紀錄的日期為現在,並加入清單。現有紀錄無法變更。」
- 與目前比較(文件基準線):從此基準線開啟比較版本。
- 還原基準線:詢問「要以基準線「{name}」覆寫此文件的實體、順序和結構嗎?之後新增的實體會從文件中移除(不會刪除)。可以復原。」
- 對於專案基準線,會開啟以基準線取代專案:「要以專案基準線「{name}」取代整個專案嗎?可以復原。」
- 刪除:詢問「要刪除基準線「{name}」嗎?」
在基準線中,編輯、快速新增和結構工具都會關閉,大綱會顯示 🔒。交付 ▾會從基準線產生輸出(「匯出(基準線“{name}”)」)。
基準線中的即時內容會顯示基準線的模型,畫面上和輸出中皆然:即時值、計數和合計、即時表格、矩陣和交互參照都會依快照解析,圖的圖形則保留隨基準線儲存的圖片。文件基準線包含文件、其項目以及相隔一個關係的實體,因此其中的計數或表格涵蓋這些實體;基準線以外實體的即時值會顯示其目前的值。
比較版本
版本 ▾ → 比較版本…會開啟比較版本。它將From(一個基準線)與To比較:較晚的基準線或目前版本。沒有基準線時會顯示「此文件沒有基準線。請先儲存一個。」
它列出「N 項變更」,包含Number、名稱、變更類型、欄位和變更。對於修改過的文字,變更會顯示逐字差異。
變更類型:
- Added(已新增)和已移除。
- 修改時間:欄位為 Name、Number、Description、Class、Image 或任何屬性。
- Label Added(已新增標籤)和Label Removed(已移除標籤)。
- Relationship Added(已新增關係)、Relationship Removed(已移除關係)和Relationship Attribute(關係屬性)。
變更 (Excel)會下載比較結果,包含 Number、Name、Class、Change Type、Field、Old Value 和 New Value。修訂標記版 (Word)會將相同的比較下載為 Word 修訂標記版(請參閱修訂標記版)。
報告
交付 ▾可將文件匯出為 Word、PDF、試算表和其他格式。{template} (Word)項目會立即下載(請參閱Word 範本);每個 Word 項目的名稱下方都有一行說明。選單最後的刪除文件…會刪除文件,並可選擇一併刪除沒有其他文件使用的章節(請參閱文件清單),然後返回清單。大綱 (Word)…、修訂標記版 (Word)…、變更 (Excel)…、需求 (ReqIF)…、文件資料 (JSON)…和列印或 PDF…會以該選擇開啟匯出對話方塊;所有匯出…則以您上次的選擇開啟。
- 按一下交付 ▾ → 所有匯出…。
匯出會開啟。
- 在匯出為中選擇要匯出的內容。選項命名為「<內容> (<格式>)」,並依輸出分組:Word、Excel、CSV、網頁、文字、交換和列印。
- 設定其選項。
- 編輯檔案名稱(最多 99 個字元)。
- 按一下匯出。
預覽會顯示試算表報告的前 60 列。對於其他匯出,會顯示「預覽僅顯示試算表匯出。請選擇 Excel 匯出。」報告使用文件編號,在基準線中則使用基準線的內容。
| 報告 | 輸出 | 選項 |
|---|---|---|
| 文件 (Word) | Word 格式的文件(請參閱Word 輸出) | Word 範本(文件的範本;選擇其他範本會依該範本填入下列選項)、新增目錄、目錄深度 1 至 6、標號編號(圖 1、表 1、依章節:圖 3-1、表 3-1或Off(關閉))、圖目錄和表目錄(文件有標號時)、說明中的標題會出現在目錄中、包含文件中顯示的屬性欄、將關聯文件新增為附錄、根據基準線填入修訂歷程記錄和核准表。預設值來自範本;使用 Specification 時:目錄到第 3 層、簡單標號編號、圖表目錄、顯示時的欄、附錄和基準線表格開啟,標題關閉。頁面大小和方向依範本而定。 |
| 變更 (Excel) | 兩個版本之間每個新增、移除和變更的項目、屬性和關係 | From(一個基準線,預設選取最舊的)、To(目前版本或一個基準線);沒有基準線時顯示「此文件沒有基準線。請先儲存一個。」 |
| 表格 (CSV) | 每個項目一列 | 屬性(依欄順序)(預設為 Number、Name、Description 和顯示的欄;也可選任何Relationship: {name},列出相關項目)、排序依據 階層式、Number或名稱 |
| 留言 (Excel) | 文件及其項目上的每則留言各一列,附留言作者 | 包含類別、名稱、編號和說明、日期、已解決(全部開啟) |
| 文件資料 (JSON) | 供重新匯入的文件 | Directly related entities(直接相關的實體,關閉)、留言(開啟)、基準線(關閉)、History(歷程記錄,關閉) |
| 大綱 (Word) | 僅標題,附編號 | 新增目錄(關閉) |
| 文件 (Markdown) | 以 Markdown 標題和文字呈現的文件 | 無 |
| 文件(列印或 PDF) | 瀏覽器的列印對話方塊;在其中選擇另存為 PDF | 無 |
| 修訂標記版 (Word) | 含 Word 追蹤修訂的文件(請參閱修訂標記版) | 從基準線(最新的)、目標(較晚的基準線或目前) |
| 品質發現事項 (Excel) | 每個需求九列(每個準則一列),附訊息和綠色 Yes 或紅色 No,最後一列為「Report score」(報告分數) | 更多屬性、包含建立時間、修改時間和全域 ID |
| 需求 (ReqIF) | ReqIF XML,包含階層以及文件內的 traced to、satisfied by、verified by、satisfies、verifies 和 traced from 關聯 | 無 |
| RSM (Excel) | Requirement → satisfied by 項目 | 需求屬性(Number、Name)、Related entity attributes(相關實體屬性:Class、Number、Name、Description) |
| RTM (Excel) | Requirement → traced to 項目 | 同 RSM |
| RVM (Excel) | Requirement → verified by 項目 | 同 RSM |
| RVTM (Excel) | Requirement → 驗證它的 Test Case,包含每個文件列 | 需求屬性(Number、Name、Description、Verification Method(s))、Test Case 屬性(Number、Name、Description、Status) |
| TVM (Excel) | 文件中的 Test Case → 它們驗證的需求 | Test Case 屬性(Number、Name、Status)、需求屬性(Number、Name、Description) |
| VCRM (Excel) | 需求 × 驗證方法,以 X 標示 | 需求屬性(Number、Name)、驗證方法(全部) |
| Traceability matrix (Excel)(可追溯性矩陣)、(Word)、(CSV)、(HTML) | 文件或整個專案的標準矩陣(請參閱文件產生) | 矩陣、範圍(此文件或整個專案) |
在矩陣報告中:
- 沒有關聯項目的需求會以紅色底色標示。在 VCRM 中,沒有方法的需求會以紅色底色標示。
- 需求儲存格會合併其相關的列。
- 兩列標題列會凍結。
Word 輸出
文件 (Word)會依下列順序建立 Word 檔案:
- 標題頁(在版面設定中開啟Cover page,或在交付項目設定中開啟Title page),否則為標題及一行斜體字,顯示類型和「No. {number}」。從基準線匯出時,該行會加上「Baseline: {name} ({date})」。機密等級標示聲明(版面設定)會以方框顯示在標題下方。
- 修訂歷程記錄(Version、Date、Author、Changes):文件的每個基準線一列,由舊到新,直到匯出的基準線為止。
- 第一列為「Initial baseline」(初始基準線)。之後的列為「N added, N removed, N modified」(N 項新增、N 項移除、N 項修改)或「No changes」(無變更)。
- Author 為基準線的建立者或其核准者。
- 核准(Role、Name、Statement、Date),來自最新(或匯出的)基準線。沒有核准紀錄時,交付項目設定中的計畫核准者會得到簽名區塊:Role、Name、Signature 和 Date,附空白線供簽名。
- 文件說明,接著是目錄、List of Figures(圖目錄)和List of Tables(表目錄),以及分頁符號。
- 每個項目為一個 Word 標題,附其編號和名稱,接著是其說明。Heading 1 至 Heading 6 依深度而定;更深的層級維持 Heading 6。Attribute/Value 表格列出所選且有值的欄。
- 附錄:每份以內嵌關聯連結的文件從新頁開始,標題為「{document} Appendix」,其內容降一層。
產生的表格可以放入某個章節,而不是放在最前面。當文件有下列名稱之一的章節時就會如此(內建範本使用這些名稱):
- 修訂歷程記錄:「Revision History」或「Document Revision History」。
- 核准:「Approvals」、「Approval」、「Sign-off」、「Signoff」、「Signatures」或「Signature」。
標號、清單與交互參照
- 圖標號(圖片的標號、圖的圖形)在圖片下方顯示為「Figure 1: {caption}」。表標號(矩陣區塊的標題、表格的標號)在表格上方顯示為「Table 1: {caption}」。
- 依章節會依頂層章節編號:「Figure 3-1」是第 3 節中的第一個圖。沒有標號的表格不編號。
- 編號是 Word SEQ 欄位,List of Figures和List of Tables是針對標號的 Word 欄位。它們只在文件有圖或表標號時出現。在 Word 更新欄位之前,清單會顯示標號但沒有頁碼。
- 每個標題、圖標號和表標號都帶有書籤。說明中的交互參照會成為指向書籤的 Word REF 欄位,因此在 Word 更新欄位後會顯示目前的標題(「3.2 Frost Warning」)或標籤(「Figure 2-1」)。指向不在匯出文件中之項目的交互參照會保留其文字。
- 說明中的標題會出現在目錄中會使說明中的標題成為比項目低一層的真正 Word 標題。關閉時,它們保持為粗體段落。
交付件設定
交付 ▾ → 交付項目設定…保存合約交付項目通常會顯示的資料。套用會儲存設定;⌘Z / Ctrl+Z可一步復原。
| 欄位 | 出現位置 |
|---|---|
| 編號 | 模型編號(項目自身的編號)(預設)或文件編號(僅保留在此文件中)(請參閱文件編號)。 |
| 標題頁 | 開啟標題頁(與版面設定中的Cover page為同一個開關)。 |
| 版本、編製者 | 標題頁和頁首(與版面設定中的欄位相同)。 |
| 組織、編製對象、合約編號、CDRL 項目、DID 編號 | 標題頁。CDRL 項目也會出現在頁尾。 |
| 標誌 | 標題頁頂端。PNG、JPEG 或 GIF,最大 400 KB。 |
| 標題頁聲明 | 標題頁底部的方框,例如發布聲明。空白時:使用版面設定中的機密等級標示聲明。 |
| 頁首和頁尾 | 預設開啟。頁首顯示「{number}, Version {version}」和標題;頁尾顯示日期、「Page X of Y」和「CDRL {item}」。需要文件編號或版本。 |
| 計畫核准者 | 每位核准者的角色和名稱。在基準線記錄核准之前,他們會得到簽名線。 |
文件編號是文件標題旁的編號欄位。
頁面格式
- Word 範本的頁面:US Letter 或 A4,直向或橫向,上下邊界 1 英吋,左右邊界 0.875 英吋。
- Calibri 11 pt。
- 真正的標題樣式,因此 Word 的導覽窗格和目錄可正常運作。
- 表格標題列加上底色,並在每頁重複。
- 頁面橫幅(機密等級標示)會在每頁的頁首和頁尾重複,包括標題頁。
- 有標題頁時,檔案分為三個節:標題頁(僅橫幅,沒有頁首也沒有頁碼)、前置資料(修訂歷程記錄、核准、說明、目錄和圖表目錄,以 i、ii、iii 編號)和正文(從 1 開始編號;「Page X of Y」只計算正文)。
- Word 開啟檔案時會詢問是否更新欄位。在此之前,目錄顯示「Right-click and choose Update Field to build the table of contents.」(按右鍵並選擇更新功能變數以建立目錄。)
格式化文字轉換
- 保留:粗體、斜體、底線、刪除線、上標、下標、行內程式碼 (Consolas)、醒目提示、文字色彩和網頁連結。
- 說明中的標題會成為粗體段落,或在開啟上述選項時成為 Word 標題。
- 清單會成為縮排的「•」或「1.」段落。
- 程式碼區塊會成為有底色的等寬字型行。引文會成為縮排的斜體。
- 表格保留合併的欄和標題底色。
- PNG、JPEG 和 GIF 圖片會內嵌,寬度最多約 6.5 英吋,並以其替代文字作為圖片描述。SVG 和 WebP 圖片不會放入 Word 檔案。
修訂標記
交付 ▾ → 修訂標記版 (Word)…會以 Word 追蹤修訂寫出文件。選擇從基準線和目標(較晚的基準線或目前)。比較版本中的修訂標記版 (Word)會對其中顯示的兩個版本執行相同操作。
- 檔案以變更摘要表格開頭:變更報告中的每項變更,包括屬性、標籤和關係。
- 接著是目標版本的文件:新增的項目為追蹤的插入;移除的項目為追蹤的刪除,放在其前一個項目之後;變更的名稱或說明會顯示刪除和插入的字詞。
- 在 Word 的Review(校閱)分頁中接受或拒絕變更。變更過的說明以純文字顯示;未變更的則保留其格式。
- 變更的作者為目標基準線的建立者,若為目前則為您的名稱。
列印 / PDF
列印或 PDF…會用瀏覽器列印文件頁面。橫幅會列印在每頁的頂端和底部。有頁首時(交付項目設定),「{number}, Version {version}」和標題會在每頁頂端重複,日期和 CDRL 項目則在底部。在彙編中,每個部分從新頁開始。頁碼、目錄和標號編號只在 Word 輸出中提供。
留言
在屬性面板的實體面板(Discussion 部分)中對項目留言。Check ▾ → 留言,或標題欄中的💬 n open comments,會在屬性面板中顯示留言:
- 文件及其項目上的每則留言,依項目分組,並附「(N open)」(N 則未解決)。回覆會縮排在其回覆的留言下方。按一下項目名稱即可選取它。
- 顯示已解決會包含已解決的留言。
- 每個討論串的第一則留言上有解決/重新開啟,每則留言都有×(刪除)。
- 若要對文件本身留言,請在對此文件留言…中輸入,然後按一下新增留言。
- 頂端的×會關閉留言;選取項目則改為顯示其實體面板。
- 有未解決留言的列會顯示💬 n;按一下即可開啟該項目的討論。
- 在任一處都可以解決、重新開啟和刪除留言。
- 所有匯出…中的Comments (Excel)(留言)會彙整這些留言。
請參閱留言與審查。
彙編
彙編會組合其他文件。在審查頁面或透過建立審查套件建立的新彙編會標示為審查套件;之前建立的套件標示為Compilation(彙編),運作方式相同。請參閱審查。
插入文件…會新增一份文件。它位於撰寫 ▾ → 插入 ▸和+ 新增 ▾ 選單中。
- 它列出尚未包含的文件。
- 插入的文件會顯示為頂層項目,其內容在下方。快顯通知顯示「已插入 {document}」。
- 沒有其他文件時,會顯示「沒有其他文件可插入。」
產生的章節
插入產生的章節…(位於撰寫 ▾ → 插入 ▸和+ 新增 ▾ 選單中)會新增一個部分,其內容在每次顯示或匯出彙編時從模型重新建立。
| 內容 | 該部分包含的內容 |
|---|---|
| 矩陣或測試報告… | 插入會開啟插入矩陣;在其中選擇矩陣(或測試報告)及其範圍。範圍Compilation (all parts)(彙編,所有部分)涵蓋每個部分。章節名稱留空則使用矩陣名稱。 |
| 縮寫清單 | 標示為 Acronym 之 Statement 的表格(Number、Name),依編號排序。 |
| 查詢表格 | 符合查詢之實體的表格,包含您列出的欄(屬性名稱,以逗號分隔)。 |
該部分編號在最後一個部分之後,因此各部分文件保留其編號。⌘Z / Ctrl+Z可一步移除它。沒有名稱時會顯示「請輸入章節名稱。」;沒有查詢或欄的查詢表格會顯示「請輸入查詢和至少一欄。」
Word 中的彙編
彙編的 Word 匯出會將每個頂層項目匯出為一個部分:
- 部分標題為「Part A: {document}」(Heading 1),並有一行顯示文件類型、編號和固定的基準線。
- 部分內的章節編號會加上部分字母:「A.1 Scope」、「B.1 Scope」。章節編號不會重複。
- 第一部分之後的每個部分從新頁開始。
- 使用By chapter(依章節)標號時,Part B 中的圖顯示為「Figure B-1」。
彙編中的交付項目設定…會加入彙編部分:
| 設定 | 選項 |
|---|---|
| 部分標籤 | 部分 A、部分 B、…(預設)、第 1 卷、第 2 卷、…、附錄 A、附錄 B、…或無部分標籤 |
| 章節編號 | 依部分,帶部分字母或編號(A.1、B.1)(預設)、跨部分連續編號(1、2、3)或每份文件保留各自的編號 |
| 每個部分從新頁開始 | 預設為開啟 |
| 每個部分的標題頁 | 部分標題及其說明行獨立成一頁 |
| 每個部分的匯出來源 | 目前,或該部分文件的其中一個基準線。固定的部分在其列上顯示 📌 和基準線名稱,並匯出該基準線的內容。 |
AI 工具
頂端列的✦ AI ▾列出適用於所選項目和文件的 AI 工具。每個 AI 結果都會先預覽,一次復原即可全部撤回。在基準線中這些工具會停用。請參閱AI。
- 對於選取的 Requirement 或 Statement:改寫得更清楚…、新增可量測的標準…(需求)、簡化…、拆分複合需求…、草擬理由…、建議名稱…、用 AI 檢查(此需求)…、產生子需求…和產生測試案例…(需求)。
- 對於任何選取的項目:產生風險…。
- 對於文件:產生需求…、摘要文件…、翻譯文件…和用 AI 檢查(N 個需求)…。
鍵盤快速鍵
| 按鍵 | 動作 |
|---|---|
| ⌘F / Ctrl+F | 在文件中尋找 |
| Enter / Shift+Enter | 下一個 / 上一個相符項目(在搜尋方塊中) |
| ⌘↵ / Ctrl↵ | 在選取的項目之後新增項目 |
| ⌥⌘↵ / Ctrl+Alt↵ | 新增選取項目的子項目 |
| ⌥⇧→ / Alt+Shift+→ / ⌥⇧← / Alt+Shift+← | 增加 / 減少選取項目的縮排 |
| ⌥ / Alt+↑ / ⌥ / Alt+↓ | 將選取的項目上移 / 下移 |
| ↑ / ↓ | 選取上一列 / 下一列;焦點隨之移動 |
| Tab | 下一個欄位:選取的列,然後是其編號、名稱和說明 |
| Enter / F2 | 在列上時編輯其名稱;在編號、名稱或說明上時編輯該欄位 |
| Delete 或 Backspace | 從文件中移除選取的項目(訊息中可復原) |
| ⇧Delete / Shift+Delete | 確認後刪除選取的項目及其子項目 |
| Esc | 取消選取;在搜尋方塊中則清除搜尋 |
| Enter / Esc | 儲存 / 取消編號或名稱的編輯(焦點留在欄位上) |
| 大綱中的 ↑ ↓ Home End | 在大綱項目間移動 |
| 大綱中的 → / ← | 展開 / 摺疊項目,或移至其第一個子項目 / 其父項目 |
| 大綱中的 Enter / Space | 在文件中開啟項目(焦點移至其列)/ 選取它 |
| ⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+Z | 復原 / 重做(在編輯器以外) |
在 Windows 和 Linux 上,⌘ / Ctrl 請用 Ctrl,⌥ / Alt 請用 Alt。列快速鍵在沒有欄位取得焦點時有效。編輯編號或名稱時,⌘↵ / Ctrl↵ 和 ⌥⌘↵ / Ctrl+Alt↵ 也有效。請參閱鍵盤快速鍵和上述的 RTF 按鍵。
記住在此瀏覽器中的設定
保留在此瀏覽器中:
- 大綱窗格是否隱藏,以及其寬度。
- 每份文件的欄和欄寬。
- 清單排序。
- 新項目目前的類別。
- 上次的報告類型。
- 1.8.0 版之前儲存的範本,直到您將其匯入專案為止。
隨文件儲存並與專案中所有人共用:Paper、Trace Status、Word 範本、文件編號、編號模式和起始編號,以及自動重新編號。專案 Word 範本隨專案儲存。
訊息
| 訊息 | 意義與修正方式 |
|---|---|
| 沒有文件 /「使用 + 新增文件建立文件,或使用匯入來匯入 Word、Excel、CSV 或 ReqIF。」 | 專案尚無文件。 |
| 「沒有相符的文件。請清除搜尋或選擇全部。」 | 清除搜尋文件…或按一下全部。 |
| 找不到文件 | 網址指向已刪除的文件。請使用返回文件。 |
| 此文件是空的 /「使用「+ 新增需求」新增需求,或使用撰寫 → 套用範本… 從範本填入文件。」 | 新增項目或套用範本。 |
| 「沒有項目符合篩選條件。清除篩選即可看到每個項目。」 | 變更或清除類別和標籤晶片。 |
| 已篩選檢視:無法編輯。清除篩選 /「清除篩選或排序以新增實體」 | 撰寫已暫停;按一下警告即可清除。 |
| 「請先輸入文字。」 | 快速新增送出時是空的。 |
| 「所選實體無法再往該方向移動。」 | 該項目在第一個或最後一個、已鎖定,或位於鎖定項目旁。 |
| 「實體不能放在自己的子項目下。請選擇其他父項目。」 | 請選擇該項目子樹以外的目標。 |
| 已過時(Quality Score 欄) | 上次品質檢查後文字已變更。請再執行一次。 |
| 「無法載入文件範本。」 | 範本目錄載入失敗;請重新載入頁面。 |
| 「預覽僅顯示試算表匯出。請選擇 Excel 匯出。」 | 預覽僅適用於 Excel 報告。 |
| 「此文件沒有基準線。請先儲存一個。」 | 執行變更報告前請先建立基準線。 |
| 「匯出失敗:… 請檢查 Word 範本,然後再匯出一次。」 | 一鍵 Word 匯出失敗;請在編輯 Word 範本…中檢查範本。 |
| 「圖片超過 N MB 的限制。」/「檔案超過 N MB 的限制。」 | 檔案大於伺服器的單一檔案限制。 |
限制
限制:在文件列中編輯的名稱限制為 200 個字元,編號限制為 139 個字元。快速新增接受 2,000 個字元。
限制:圖片的最長邊會縮小至 4,000 px。附加的檔案和圖片受伺服器單一檔案限制(Free 方案 10 MB、Individual 25 MB、Team 100 MB)和專案儲存配額的限制。
限制:Word 輸出僅內嵌 PNG、JPEG 和 GIF 圖片。深於 6 的標題層級會顯示為 Heading 6。
限制:組織範本存在於 Holarch 伺服器(託管或自行託管)上,而非桌面應用程式中;桌面應用程式將專案範本保存在專案檔案中。一個組織最多可保存 200 個範本,每個範本最多 3,000 個章節。在某個專案中儲存的範本不會提供給其他專案:請將範本儲存到組織,或在其他專案中再儲存一次。