Holarch
课程章节

培训 · 课程 1. 入门 · 第 1.5 章,共 8 章

1.5 文档 2:46

编写一份其需求均为模型条目的规格说明。

演示 Holarch 1.27。

您将学到

  • 根据内置模板创建需求规格说明
  • 在章节下添加需求并编写其 shall 语句
  • 使用“快速添加”快速添加多条需求
  • 在数据库中以模型条目的形式找到文档的需求
  • 从“交付”菜单将规格说明导出到 Word

根据内置模板创建 Bike-Share Dock 的系统需求规格说明,使用 + 子条目 和属性面板在章节下编写一条需求,使用“快速添加”添加更多需求,确认文档中的每条需求都是数据库中的模型条目,并将文档导出到 Word。

项目文件

  • 起始项目 (.holarch.json;管理项目 → 项目文件 ▾ → 导入项目 (.json)…)
  • 完成项目 (.holarch.json;管理项目 → 项目文件 ▾ → 导入项目 (.json)…)

视频从 holarch.app 播放;参见隐私政策。

练习

在 Holarch 中基于 CubeSat EO-1 演示项目亲自完成此操作。

  1. 打开您的 EO-1 演示项目(或创建它:管理项目 → 项目文件 ▾ → 新建演示项目 → CubeSat(引导式系统工程))。
  2. 打开 需要与需求 → 文档,单击 + 新建文档。将其命名为 EO-1 Ground Station Specification,选择模板 Requirements Specification,然后单击 创建。
  3. 选择章节 4.1 Primary Functions,单击 + 子条目,将需求命名为 Track the Spacecraft,并在属性面板的描述中编写其 shall 语句。
  4. 在底部的 快速添加 中选择 Under 10 Design Constraints,输入 The ground station antenna shall have a diameter of no more than 3.7 m. 并按 Enter。用同样方式再添加一条约束。
  5. 打开 数据库,在搜索框中输入 in:"EO-1 Ground Station Specification" class:Requirement,列出新需求。
  6. 回到文档,选择 交付 ▾ → 规格说明 (Word) 并打开文件。

当 Word 文件在各编号章节下显示您的三条需求时,即完成练习。

自测

  1. 在 Holarch 文档中输入的需求与在文字处理软件中输入的需求有什么区别?
  2. “快速添加”如何确定新需求的名称?
  3. 什么情况下应勾选“包括编写指南”?
显示答案
  1. 在 Holarch 文档中输入的需求与在文字处理软件中输入的需求有什么区别?

    在 Holarch 中,文档中的每条需求都是一个模型条目:您可以追溯它、检查其质量、在图上绘制它,并在数据库中找到它。

  2. “快速添加”如何确定新需求的名称?

    它根据 shall 之后的词语为需求命名,并按所选章节中同级条目的顺序为其编号。

  3. 什么情况下应勾选“包括编写指南”?

    当作者初次接触该文档类型时:每个章节会附带一条简短说明,指出应包含的内容,您在编写时将其删除。

延伸阅读

文字稿

显示文字稿 (旁白和屏幕内容)

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.