Holarch
课程章节

培训 · 课程 6. 迁移到 Holarch · 第 6.3 章,共 5 章

6.3 从 Word 和 ReqIF 导入需求 2:22

将 Word 规格说明作为文档导入,并导入供应商的 ReqIF 文件及其层级和关联。

演示 Holarch 2.21。

您将学到

  • 说明 Word 文件的哪些部分会变成章节、哪些会变成需求
  • 将 Word 规格说明导入为带编号的需求文档
  • 导入 ReqIF 文件及其层级、属性和关系
  • 在“追溯”部分检查导入的关系

从 Word 导入 Plant Inspection Drone 的载荷规格说明(标题变成章节,shall 句子变成需求),并从 ReqIF 导入电池供应商的需求,包括其层级、属性和一条 refines 关系。

项目文件

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

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

练习

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

  1. 打开您的 EO-1 演示项目(如果没有,请创建:管理项目 → 项目文件 ▾ → 新建演示项目 → CubeSat(引导式系统工程))。打开 文档 → EO-1 System Requirements Specification,然后单击 交付 ▾ → 规格说明 (Word)。
  2. 在同一文档中单击 交付 ▾ → 需求 (ReqIF)…,然后单击 导出。
  3. 在 管理项目 中单击 + 新建项目,将其命名为 EO-1 Import Practice,然后单击 创建项目。打开 需要与需求 → 导入和导出,拖入 .docx 文件,单击两次 继续,然后导入。
  4. 将新文档与 SRS 比较:留意哪些标题变成了 Statement、哪些 shall 句子变成了 Requirement,以及它们是如何命名的。
  5. 将 .reqif 文件导入同一项目,然后打开它创建的文档,选择 1.6 Revisit Time 查看其子项和标签。

当项目包含两个文档(一个来自 Word,一个来自 ReqIF),且您能说出哪个保留了原始名称和编号时,即完成练习。

自测

  1. Word 导入将什么读取为章节,将什么读取为需求?
  2. 供应商可以发送 Word 或 ReqIF。为什么要索取 ReqIF?
  3. 某个 ReqIF 关系的名称 Holarch 无法识别。会发生什么?
显示答案
  1. Word 导入将什么读取为章节,将什么读取为需求?

    使用 Word 标题样式的段落会变成 Statement(章节)。包含 shall、must、will 或 should 的段落会变成 Requirement,并以动词之后的前几个词命名。以普通粗体文字输入的标题会被当作普通文本读取。

  2. 供应商可以发送 Word 或 ReqIF。为什么要索取 ReqIF?

    ReqIF 包含每条需求的标识符、层级、属性和关系。当供应商发送更新的文件时,导入它会更新相同的条目,而不是添加副本。

  3. 某个 ReqIF 关系的名称 Holarch 无法识别。会发生什么?

    它以 traced to 的形式导入。如果架构不允许这两个类之间存在 traced to,则跳过该关系并给出警告。

延伸阅读

文字稿

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

Introduction

Chapter three: requirements from Word and ReqIF. Many specifications live in Word, and many suppliers exchange requirements as ReqIF files. Both come in through the same Import and Export page.

We import the payload specification and the battery supplier's requirements into the Plant Inspection Drone project.

Word

The Word file uses heading styles for its sections, and plain sentences with shall for its requirements. That is what the Word import reads. Heading styles or Word's list numbering matter: headings typed as ordinary bold text are read as ordinary text.

On screen: Card: what Holarch reads in Word.

Open Import and Export, and drop the file. Holarch detects Word from the file and analyzes it.

On screen: Import and Export → drop the .docx → Word detected.

Click Continue. The numbering pattern stays automatic, which uses numbered headings and shall sentences. Click Continue for the review: Holarch creates a requirements document with the name of the file, and lists the sections and the requirements under them.

On screen: Continue → Map: numbering → Continue → Review.

Click Import. The document opens, numbered from the Word headings, with each shall sentence as a requirement you can now trace and check.

On screen: Import → the document.

ReqIF

Now the supplier's file. ReqIF is the standard exchange format between requirements tools. Open Import and Export again, and drop the file.

On screen: Import and Export → drop the .reqif → ReqIF detected.

Click Continue. Each requirement in the file is a row. Its ReqIF identifier and its parent rebuild the hierarchy, its type becomes the class, and its attributes map by name: the chapter name to the number, the name, and the text to the description.

On screen: Continue → Map.

Click Continue, check the review, and click Import.

On screen: Continue → Review → Import.

Check the result

The supplier's relations come in as relationships. Select Charge Time, and open Trace: it refines Pack Capacity, just as the file says.

On screen: Select B.4 Charge Time → Trace.

Recap

Let's recap. You imported a Word specification, where headings became sections and shall sentences requirements, and a supplier's ReqIF file, with its hierarchy, attributes and relations.

Next, a whole model from another tool.