课程章节
培训 · 课程 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。 - 在 模板适用于 下选择 Interface Control Document,勾选 包括编写指南,选择 Interface Control Document (ICD) 卡片,然后单击 创建。
- 选择章节 2.3 Interface Owners and Change Authority 并阅读其指南。单击其描述,用 EO-1 各接口的负责人(例如 Payload Lead 和 Comms Lead)替换指南,然后按 ⌘ / Ctrl↵ 保存。
- 选择章节 3.2 Interface Matrix,查看模板放在那里的实时接口矩阵。
- 如需带检查的分步演练,请运行教程 11“生成交付物”(帮助 → 教程)。
当新的 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.