課程章節
培訓 · 第 1 單元:入門 · 第 1.5 章,共 8 章
1.5 文件 2:46
撰寫需求皆為模型項目的規格書。
展示 Holarch 1.27。
您將學到
- 從內建範本建立需求規格書
- 在章節下新增需求,並撰寫其 shall 陳述
- 以「快速新增」迅速新增多項需求
- 在資料庫中以模型項目的形式找到文件的需求
- 從「交付」選單將規格書匯出為 Word
從內建範本建立 Bike-Share Dock 的系統需求規格書,以「+ 子項目」與屬性面板在章節下撰寫需求,以「快速新增」新增更多需求,確認文件中的每項需求都是資料庫中的模型項目,並將文件匯出為 Word。
練習
在 Holarch 中於 CubeSat EO-1 示範專案上親自操作。
- 開啟您的 EO-1 示範專案(或建立它:管理專案 → 專案檔案 ▾ → 新增示範專案 → CubeSat(引導式系統工程))。
- 開啟需要與需求 → 文件,然後按一下 + 新增文件。將其命名為
EO-1 Ground Station Specification,選擇範本需求規格書,然後按一下建立。 - 選取章節 4.1 Primary Functions,按一下 + 子項目,將需求命名為
Track the Spacecraft,並在屬性面板的描述中撰寫其 shall 陳述。 - 在底部的快速新增中,選擇位於 10 Design Constraints 之下,輸入
The ground station antenna shall have a diameter of no more than 3.7 m.,然後按 Enter。以相同方式新增第二項約束。 - 開啟資料庫,並在搜尋方塊中輸入
in:"EO-1 Ground Station Specification" class:Requirement,以列出新的需求。 - 回到文件,選擇交付 ▾ → 規格書 (Word),然後開啟檔案。
當 Word 檔案在其編號章節下顯示您的三項需求時,即完成。
自我檢查
- 在 Holarch 文件中輸入的需求,與在文書處理器中輸入的需求有什麼不同?
- 「快速新增」如何決定新需求的名稱?
- 什麼時候會勾選「包含撰寫指引」?
顯示答案
在 Holarch 文件中輸入的需求,與在文書處理器中輸入的需求有什麼不同?
在 Holarch 中,文件裡的每項需求都是模型項目:您可以追溯它、檢查其品質、在圖上繪製它,並在資料庫中找到它。
「快速新增」如何決定新需求的名稱?
它以 shall 之後的字詞為需求命名,並依所選章節中同層項目的順序為其編號。
什麼時候會勾選「包含撰寫指引」?
當作者初次接觸該文件類型時:每個章節會得到一段簡短註記,說明該章節應包含的內容,您在撰寫時將其刪除。
延伸閱讀
文字稿
顯示文字稿 (旁白與畫面內容)
Introduction
Chapter five: documents. Requirements usually live in a specification. In Holarch a document is an outline of model items, so every requirement in it is an item you can trace, check and draw.
We continue with the Bike-Share Dock project, and write its system requirements specification.
Create from a template
Open Needs and Requirements, then Documents, and click New Document.
On screen: Needs & Requirements → Documents → + New Document.
Name it Bike-Share Dock System Requirements. The templates below are for requirements documents; the menu next to them shows the templates for other kinds of document.
On screen: New Document: name; templates for Requirements Document.
A template gives the document its sections. Include writing guidance adds notes that explain what each section should hold. Choose Requirements Specification, with the sections only, and click Create.
On screen: Template: Requirements Specification → Create.
The document opens with the template's numbered sections, from document control to the appendices. The outline on the left lists them, and clicking an entry jumps to it.
On screen: The new document and its outline.
Write requirements
Select section 4.1, Primary Functions. Open the menu next to After, and choose Add Child. A new requirement appears under the section, numbered 4.1.1, with its name ready to type. Type Show Available Bikes, and press Enter.
On screen: 4.1 → + After ▾ → Add Child → Show Available Bikes.
Then write the shall statement. Click the description in the inspector, type it, and click elsewhere to save.
On screen: Inspector → Description.
To add many requirements quickly, use Quick add at the bottom of the document. Choose the section Design Constraints, type the requirement, and click Add, or press Enter.
On screen: Quick add → Under 10. Design Constraints → Add.
Holarch adds it under the section, and names it from the words after shall. The cursor stays in the field, so the next requirement is one more line.
On screen: Second Quick add.
One model
Each requirement in the document is a model item. Open the Database and filter to requirements: the new ones are listed with the requirements from chapter two.
On screen: Database → + Filter → Requirement.
Export
Back in the document, the Deliver menu makes the Word file: the specification with a table of contents and the numbered requirements, ready to send for review. Choose Specification (Word).
On screen: Back to the document → Deliver ▾ → Specification (Word).
Recap
Let's recap. You created a specification from a template, wrote a requirement under a section, added more with Quick add, saw that they are model items, and exported the document to Word.
Next, you learn the quickest ways to find anything in a growing model.