課程章節
培訓 · 第 4 單元:文件與交付成果 · 第 4.1 章,共 5 章
4.1 文件範本 2:54
從範本開始撰寫計畫或規格書,每個章節都有指引。
展示 Holarch 2.13。
您將學到
- 從內建範本建立所選類型的文件
- 包含撰寫指引,並閱讀章節中的指引
- 以您自己的文字取代章節的指引並儲存
- 說明為什麼每個文件章節都是模型項目
從內建範本建立 Bike-Share Dock 的系統工程管理計畫:選擇文件類型,比較大綱與引導式範本,閱讀每個章節中的指引,以您自己的文字取代它,並確認每個章節都是模型項目。
練習
在 Holarch 中於 CubeSat EO-1 示範專案上親自操作。
- 開啟您的 EO-1 示範專案,或建立它:管理專案 → 專案檔案 ▾ → 新增示範專案 → CubeSat(引導式系統工程)。
- 開啟需要與需求 → 文件,然後按一下 + 新增文件。將其命名為
EO-1 Interface Control Document。 - 在範本適用於下,選擇介面控制文件,勾選包含撰寫指引,選擇介面控制文件(ICD)卡片,然後按一下建立。
- 選取章節 2.3 Interface Owners and Change Authority 並閱讀其指引。按一下其描述,以 EO-1 介面的擁有者(例如 Payload Lead 與 Comms Lead)取代指引,然後按 ⌘ / Ctrl↵ 儲存。
- 選取章節 3.2 Interface Matrix,閱讀範本放在該處的即時介面矩陣。
- 若要進行有檢查的逐步練習,請執行教學課程 11 Produce the Deliverable(說明 → 教學課程)。
當新的 ICD 在 2.3 中顯示您自己的文字而非指引,且 3.2 顯示 EO-1 元件的矩陣時,即完成。
自我檢查
- 什麼決定了「新增文件」優先提供哪些範本?
- 含撰寫指引與不含撰寫指引的範本有什麼不同?
- 為什麼每個章節都是模型項目很重要?
顯示答案
什麼決定了「新增文件」優先提供哪些範本?
在「範本適用於」下選擇的文件類型。其他類型的範本仍會列在「其他範本」下;文件會採用您所選範本的類型。
含撰寫指引與不含撰寫指引的範本有什麼不同?
兩者都提供相同的編號章節與起始表格。含指引的範本,每個章節還會以一段簡短指引開頭,說明該章節應包含的內容,您在撰寫時將其取代。
為什麼每個章節都是模型項目很重要?
章節是一個 Statement,因此您可以像處理需求一樣關聯它、對它留言並將其納入基準線,而文件仍是模型的一個檢視。
延伸閱讀
文字稿
顯示文字稿 (旁白與畫面內容)
Introduction
Welcome to track four: documents and deliverables. Programs are reviewed through their documents: plans, specifications, and the matrices reviewers ask for. In Holarch, these are built from the model. This first chapter covers document templates.
You will pick a document type and its template, compare an outline with a template that has guidance, and write your own text over that guidance.
Choose a type
We continue with the Bike-Share Dock. It already has requirements, functions, parts and test cases. Open Needs and Requirements, then Documents, and click New Document.
On screen: Needs & Requirements → Documents → + New Document.
The type decides which templates are offered. Holarch has templates for the documents most programs write, from the concept of operations to the test plan, and for the concept stage: needs analysis, concept exploration and concept definition.
On screen: Card: document types with templates.
Name it Bike-Share Dock SEMP. Then, under Templates for, choose Systems Engineering Management Plan Document.
On screen: Name, then Templates for ▾ → Systems Engineering Management Plan Document.
Outline or guidelines
Each template comes in two forms. The outline has only the section headings. With writing guidance, every section also explains what it should hold, with an example. Tick Include writing guidance, choose the template, and click Create.
On screen: Include writing guidance → the template card → Create.
The plan opens with fifteen numbered sections: the life cycle, the technical reviews, requirements management, baselines, interfaces, verification, risk, and the tools and model.
On screen: The new plan and its outline.
Write your plan
Click section 2.1, Purpose. Its text is the guidance: state why this plan exists and who uses it, followed by an example.
On screen: Outline → 2.1 Purpose.
Replace the guidance with your own text. Click the description to edit it, select its text, and type the purpose of this plan. Then press Command Return to save it.
On screen: Edit 2.1's description → type → Save.
The guidance often points to where the work lives in Holarch. Section 8.1, Baselines, says to use Holarch baselines, so that later changes can be compared against them. Chapter four of this track shows how.
On screen: Outline → 8.1 Baselines.
Every section is a model item, a statement, so you can link it, comment on it and baseline it, like a requirement.
On screen: 8.1's class badge: Statement.
Recap
Let's recap. You chose a document type and its template, picked the template with guidelines, read the guidance in a section, and replaced it with your own text.
Next, you put live traceability and verification matrices into a document.