需求
需求
编写、检查、审批、建立基线和导入需求,并跟踪未关闭的 TBD/TBR 条目和待检查的链接。
概述
使用需求页面编写、检查、审批需求并为其建立基线,以及跟踪仍未关闭的内容。需求是 LML 类 Requirement 的实体:系统必须具备的能力、特性或质量因素。
需求通常位于需求文档中(请参阅文档)。每条需求仍是模型中的一个实体。因此,同一条需求会出现在数据库、图、可追溯性矩阵和 RVTM 中。
导航栏中的需要与需求组包含所有需求页面:
| 页面 | 显示内容 |
|---|---|
| 文档 | 规格说明及其大纲。需求在这里编写。 |
| 需求 | 所有需求集中在一个表格中(筛选为 class:Requirement 的数据库)。 |
| 质量 | 需求质量:按九项准则为每条需求评分。 |
| TBD/TBR | 仍待确定或评审的未关闭值的登记册。 |
| 待审查的关联 | 上游需求在关联上次评审后发生更改的关联。 |
| 审批 | 状态为“评审中”的需求。 |
| 导入与导出 | 通过同一个放置区域导入 Word、Excel、CSV、ReqIF、纯文本、XMI 和项目文件,以及模型导出。 |
基线是用于评审的冻结快照。可从文档或从控制与评审 → 基线和版本创建。与功能、资产和测试的关联在可追溯性中介绍。
概念
Requirement 和 Statement
Statement 是 Requirement 的父类。
- 对不具约束力的文本使用 Statement:章节标题、假设、背景。
- 对每个具有约束力的“shall”陈述使用 Requirement。
只有 Requirement 会被质量检查评分、列入 TBD/TBR 登记册、在更改时被标记为待审查并计入 RVTM。Statement 会被跳过。
需求具有通用实体字段编号、名称和描述。描述就是需求陈述本身,为富文本。下列属性补充其余内容。
需求属性
| 属性 | 类型和值 | 含义 |
|---|---|---|
| 理由 | 长文本 | 需求背后的原因。 |
| 状态 | 草稿、评审中、已审批、已拒绝 | 需求在审批工作流中所处的位置。 |
| 优先级 | 高、中、低 | 需求对利益相关方的重要程度。 |
| 关键性 | 高、中、低 | 未满足需求时对任务或安全的后果。 |
| 所有者 | 文本 | 负责该需求的人员或团队。 |
| 来源 | 文本 | 需求所来自的利益相关方、文档或标准。 |
| 验证方法 | 多选:Analysis、Demonstration、Inspection、Test | 如何验证该需求。 |
| 验证级别 | Component、Subsystem、System | 验证该需求所在的装配级别。 |
| 成功标准 | 长文本 | 表明需求已满足的可测量结果。 |
| TBD/TBR | None、TBD、TBR | TBD = 某个值仍待确定;TBR = 某个值待评审。关闭后设回 None。 |
| TBD 所有者 | 文本 | 负责关闭 TBD/TBR 的人员。 |
| TBD 截止日期 | 日期和时间 | 必须关闭 TBD/TBR 的日期。工作流组中的截止日期显示并设置同一日期(请参阅TBD/TBR 登记册)。 |
| 质量评分 | 百分比,计算得出 | 上次检查质量的结果。 |
| Appropriate、Complete、Conforming、Correct、Feasible、Necessary、Singular、Unambiguous、Verifiable | 是/否,计算得出或手动设置 | 九项质量准则。 |
属性面板对需求的字段分组(请参阅属性面板):Requirement(编号、名称、描述、标签、理由、来源、成功标准)、工作流(带状态、优先级、关键性、所有者、受理人、截止日期、TBD/TBR、TBD 所有者、TBD 截止日期的评审条)、验证(验证方法和级别、验证依据,以及正式项目群的关闭字段)、值(预算数量、阈值、目标值和当前值、单位)、符合性(正式项目群)和质量。
得分和九项准则位于质量组中,该组起初是折叠的。其标题显示例如“89% · 9 项中满足 8 项”或“尚未检查”。Holarch 会按类记住您是否让该组保持展开。
项目可以添加自己的需求属性和选项;请参阅架构扩展。
需求标签
标签对需求进行分类而不改变其类。内置的需求标签有:
- Functional Requirement、Performance Requirement、接口需求。
- Environmental Requirement、Reliability Requirement、Safety Requirement。
- Verification Requirement。
- Stakeholder Need:由利益相关方提出、尚未转化为系统需求的需要。
验证方法也是一个标签组,含标签 Analysis、Demonstration、Inspection 和 Test。标签和属性保持同步,处于同一个撤销步骤中:
- 添加标签 Test 会将验证方法设为 Test。
- 在属性中选择 Test 会添加该标签。
只带有标签的旧项目和导入内容会在项目打开时合并到该属性中。
需求工作流
每条需求经过四种状态:
- 草稿:正在编写。
- 评审中:等待决定。列在审批页面上。
- 已审批或已拒绝:已决定。每项决定都会记录由谁做出、何时做出以及可选的原因。
审批之后,有三种机制保证记录真实可信:
- 编辑时重新评审。编辑已审批需求的名称或描述会将其移回“评审中”,并附注“审批后文本已更改”。
- 质量过期。编辑名称或描述会将其质量结果标记为过期,并清除手动质量覆盖。
- 待审查的关联。编辑名称、描述或关键属性会将指向其下游条目的关联标记为待审查。
三者都属于该编辑,因此一次撤销(⌘Z / Ctrl+Z)会将它们一并撤回。
未关闭条目:TBD、TBR 和 TBS
未关闭条目是尚未确定的值。满足以下任一条件时,需求即为未关闭条目:
- 其 TBD/TBR 属性为 TBD 或 TBR。
- 其名称或描述包含 TBD、TBR 或 TBS 一词。
未关闭条目在关闭前一直显示在 TBD/TBR 登记册上。
基线
基线是只读快照。共有两种:
- 文档基线保存一个文档。它包括文档 Artifact、其条目及其属性、涉及它们的关系、相隔一跳的实体,以及文档的大纲设置。
- 项目基线保存项目中的每个实体和关系。
基线可以带有审批记录(姓名、角色、声明、日期)。记录一经保存即被锁定。
如何使用
何时使用及原因
需求工作覆盖系统工程 V 模型的左侧:
- 收集利益相关方需要。
- 导出系统需求。
- 检查每条陈述是否格式良好。
- 使需求获得审批。
- 在评审(SRR、PDR、CDR)时冻结它们。
建立基线后,工作转向变更控制。每项变更都要重新评审,并检查其下游影响。未关闭的 TBD/TBR 值会在设计确定之前关闭。
需求页面回答以下问题:
| 问题 | 页面 |
|---|---|
| 每条需求是否写得好? | 质量 |
| 哪些值仍未知,由谁负责,是否已逾期? | TBD/TBR |
| 由于某条需求更改,哪些内容必须重新检查? | 待审查的关联 |
| 哪些内容正在等待决定? | 审批 |
| 评审以来发生了哪些更改? | 文档版本 ▾ → 比较版本…、基线和版本 |
| 每条需求是否已分配并验证? | 可追溯性矩阵和 RVTM |
质量、待审查的关联、TBD/TBR 和审批页面在导航栏的需要与需求下彼此相邻。从那里依次完成全部四项检查。
编写需求
- 打开需要与需求 → 文档。
- 打开需求文档。
要新建文档,请点击+ 新建文档(请参阅文档)。
- 在文档下方的快速添加栏中,选择条目的位置,例如Under 3 Electrical Power。
- 键入需求陈述并按 Enter。
Holarch 会添加一个文档默认类的条目(在需求文档中为 Requirement)。它按其同级条目顺序编号。
- 选中该需求后,打开右侧的属性面板。
- 在Requirement组中填写理由、来源和成功标准,在工作流中填写优先级、关键性和所有者,在验证中填写验证方法和验证级别。
- 使用属性面板Requirement组中的+ 标签添加类型标签,例如Performance Requirement。(标签列位于视图 ▾ → 列 ▸下。)
该需求的状态为“草稿”,并显示在需要与需求 → 需求上。
如果某个值尚未知:
- 在陈述中写下您的最佳估计值。
- 将TBD/TBR设为 TBD。
- 填写TBD 所有者,并在工作流组的截止日期中设置日期。
该需求现在也会显示在 TBD/TBR 登记册上,并带有该截止日期。
检查措辞
- 打开需要与需求 → 质量。
也可以在文档中选择检查 ▾ → 检查质量。
- 在范围栏中,选择所有需求或文档:<name>。
- 点击页面标题中的检查质量。
提示消息显示“已检查 32 条需求”(或您的数量)。每条需求获得 0 至 100% 的得分,每项准则显示 ✔ 或 ✘。
需求超过 2,000 条时,检查在后台运行:进度卡片显示“正在检查需求”、数量和剩余时间,您可以继续工作。点击卡片上的取消即可停止;不会有任何更改。随后卡片显示“正在保存质量结果”及已保存的数量;保存期间,其他编辑会被拒绝,并显示“正在保存质量结果。请在完成后重试。”只有结果发生变化的需求才会被保存,因此在没有更改的情况下再次检查不会保存任何内容。整个检查是一个步骤:一次 ⌘Z / Ctrl+Z 即可将其撤销。
- 查看各卡片:需求、平均分数、良好 (≥ 67%)、需要返工 (< 67%),以及存在时的已过期(文本已更改)。
- 对于每条低于 67% 的需求,阅读建议列。
或将指针指向 ✘,查看该准则的消息。
- 点击需求名称将其打开,然后修改文本。
- 再次运行检查。
Correct 和 Feasible 始终需要人的判断。无论其他检查结果如何,检查都不会将它们标记为满足。因此,自动检查最多达到 9 项准则中的 7 项 (78%)。没有验证测试或验证需求的需求最多达到 9 项中的 6 项 (67%)。对每条需求,请自行判定这两项:
- 评审需求后,点击 ✘ 将该准则标记为“是”。
- 如需初步意见,请使用✦ AI ▾ → 用 AI 检查(N 条需求)…(AI 需求检查)。
注意:早期版本存储的得分可能在其他检查未通过时仍将 Correct 或 Feasible 计为满足。再次运行检查即可更新这些得分。
使用 EARS 模板编写
EARS(Easy Approach to Requirements Syntax,需求语法简易方法)将每条需求写成一句话:可选的条件,然后是“the [system] shall [response]”。条件的第一个词决定模式。
| 模式 | 模板 | 示例 |
|---|---|---|
| Ubiquitous | The [system] shall [response]. | The pump controller shall record every start command with its time.(泵控制器应记录每条启动命令及其时间。) |
| Event-driven | When [trigger], the [system] shall [response]. | When the tank level falls below 20 %, the pump controller shall start the backup pump.(当储罐液位低于 20 % 时,泵控制器应启动备用泵。) |
| State-driven | While [state], the [system] shall [response]. | While the vehicle is charging, the battery manager shall keep each cell below 45 °C.(车辆充电期间,电池管理器应使每个电芯保持在 45 °C 以下。) |
| Unwanted behavior | If [unwanted condition], then the [system] shall [response]. | If the supply voltage drops below 10 V, then the flight computer shall switch to the reserve battery.(如果供电电压降至 10 V 以下,则飞行计算机应切换到备用电池。) |
| Optional feature | Where [feature is included], the [system] shall [response]. | Where a heated windshield is fitted, the climate controller shall clear frost within 5 minutes.(在装有加热风挡的情况下,空调控制器应在 5 分钟内除霜。) |
| Complex | While [state], when [trigger], the [system] shall [response]. | While the drill is in standby, when the operator presses Start, the drill controller shall reach full speed within 3 s.(钻机处于待机状态时,当操作员按下 Start 时,钻机控制器应在 3 s 内达到全速。) |
- 在属性面板或条目视图中打开需求。
- 点击描述旁边的EARS ▾。
第一行显示该陈述的模式(✓ Event-driven)或需要修正的内容(No EARS pattern: 1 to fix)。
- 选择一种模式。
其模板会成为描述。如果需求已有描述,请点击替换确认;旧陈述保留在条目的历史记录中。一次 ⌘Z / Ctrl+Z 即可撤销。
- 替换方括号中的词。
要检查每条需求,请在模型检查 → 设置中将Requirement.11设为警告或错误。它默认关闭。
在 SysML v2 项目中,EARS ▾位于属性面板中需求的文档下,并写入其文档注释。
审批需求
- 需求准备就绪后,将其状态设为“评审中”。
可在属性面板(工作流组评审条中的状态)、数据库或文档列中进行。
- 评审人打开需要与需求 → 审批。
该页面列出状态为“评审中”的每条需求。
- 点击一行。
属性面板的工作流组显示评审条:状态、由谁及何时设置(“由 J. Rivera · Mar 9, 2026 at 9:58 AM”)以及按钮。
- 点击审批。
或点击拒绝…并输入可选的原因。
提示消息显示“已审批”或“已拒绝”。该决定会连同您的姓名和时间一起记录,需求随即离开审批列表。
当需求位于某个基线中且有验证条目或文档追溯到它时,审批会先打开一个对话框,在需要重新评审下列出它们(影响)。点击一行查看,然后点击审批确认。
要将已决定的需求退回评审,请点击重新打开。提示消息显示“已移到“评审中””。
如果项目对需求状态设有工作流(架构 → 工作流),评审条会显示该工作流的转换,而不是审批、拒绝…和重新打开。需要审批的转换以…结尾,并打开请求审批:请参阅为状态更改请求审批。对于已建立基线的需求,请求审批和变更请求的审批…对话框会显示相同的需要重新评审列表。
为评审冻结文档
- 在文档的标题栏中,点击版本 ▾。
- 选择保存基线…。
或选择交付 ▾ → 版本 ▸ 保存基线…。
- 保留或更改名称。默认值为“<document> Baseline <n>”。
- 在审批下,为每位审批人填写一行:名称、角色和声明(默认为“Approved for release.”)。
+ 添加审批人添加一行;× 删除一行。
- 点击创建。
提示消息显示“基线已保存”。版本 ▾显示“当前 · 最新基线 <name>”。
从现在起,每一行与最新基线不同时都会显示更改条。
处理基线之后的变更
- 在文档中编辑需求文本。
提示消息会汇总所发生的情况,例如“1 项已审批需求已移到“评审中”;6 个关联已标记为待评审。”作为您编辑的一部分(一次撤销即可全部撤回):
- 已审批的需求移到“评审中”。
- 其质量结果变为过期(“质量:已过期 — 重新运行”)。
- 其下游关联被标记为待审查。
- 打开需要与需求 → 待审查的关联。
- 对于每一行,点击差异查看文本更改,并评审所关联的条目。
- 当关联的条目仍然成立时,点击其所在行的标记为已评审…。
要一次标记多项,请选择它们所在的行并点击将所选项标记为已评审…。
- 写下您检查的内容,然后点击标记为已评审。
- 再次运行“检查质量”。
- 将需求重新送交审批。
- 点击版本 ▾ → 比较版本…,在从下选择该基线,在到下选择当前版本。
报告列出自该基线以来的每项更改。
- 点击更改 (Excel),生成供变更委员会使用的文件。
关闭 TBD 和 TBR 条目
- 打开需要与需求 → TBD/TBR。
- 查看各卡片:未关闭的 TBD/TBR、已逾期、无所有者,以及每个文档的数量。
- 先处理已逾期的行。它们带有底色,截止日期下方显示“已逾期”。
- 如果所有者显示“—”,请指定TBD 所有者。
- 某个值确定后,将需求文本编辑为最终值。
- 点击该行上的关闭。
关闭会将 TBD/TBR 设为 None,该行随即离开登记册。
要将登记册发送给各所有者,请点击导出 XLSX。
导入现有规格说明
- 打开需要与需求 → 导入和导出。
- 将文件放到放置区域,或点击该区域选择文件:Word (.docx)、Excel 或 CSV、ReqIF 或纯文本。
状态行显示例如“已分析“SRS.docx”:48 行,5 列。”格式显示检测到的格式。
- 点击继续。
- 检查每一列映射到什么,并将无类的行所用的类设为 Requirement。
- 点击继续。
- 保持勾选Create a requirements document from these N requirements,检查文档类型和名称,并检查新条目、已更新的条目和警告。
- 点击Import N items。
没有警告时,Holarch 会打开新文档。有警告时,导入完成卡片会列出它们。
导入完成卡片上有按钮,可打开文档、数据库、Spider 图或树图,或运行“检查质量”。一次 ⌘Z / Ctrl+Z 即可移除整个导入。
实例:CubeSat EO-1 演示
从管理项目创建演示项目CubeSat EO-1 — Earth Observation Demo。它有一份包含 32 条需求的规格说明SRS-001 EO-1 System Requirements Specification,带有一个 SRR 基线以及之后所做的更改。
质量。
- 打开需要与需求 → 质量并点击检查质量。
卡片显示 32 条需求,平均 92%,29 条良好,3 条需要返工。
这三条较弱的需求是有意这样写的。每条得分 44%:
- 2.5 Safe Mode Recovery:“The spacecraft should recover from safe mode quickly and resume imaging as appropriate”。建议包括:
- “R34 - 无法衡量的性能用语:[quickly]”
- “R8 - 例外条款削弱了需求:[as appropriate]”
- “R19 - 合并了两条需求;请拆分为单独的需求:[and]”
- “请以句号结束该语句。”
- “Link a Test Case or Requirement that verifies it.”(关联一个验证它的测试用例或需求。)
- 3.5 Battery Thermal Control:“…keep the battery warm enough (TBD).”建议为“R21 - 包含括号;请将括号内的文字移到理由中。”和“请替换 TBD/TBR 占位符。”
- 6.4 Operator Interface:“…shall be user friendly and/or easy to use.”建议为“R34 - 无法衡量的性能用语:[user friendly, easy to use]”和“R19 - “and/or” 含义模糊;请说明是两者还是任一:[and/or]”。
要修正 2.5:
- 将其改写为“The spacecraft shall resume imaging within 6 hours of a safe mode entry.”
- 用verified by关联一个测试用例。
- 再次运行检查。
关于组合词、例外条款和模糊用语的消息随即消失。
TBD/TBR。打开TBD/TBR。它显示三个未关闭条目:
- 3.5 Battery Thermal Control:由 Thermal Engineer 负责的 TBD。它已逾期。
- 2.4 Target Slew(ADCS Lead)和5.3 Downlink Link Margin(Comms Lead):截止日期较晚的 TBR。
基线之后的变更。文档的版本 ▾列出SRR Baseline。它由 J. Rivera(Systems Lead)、R. Okafor(Mission Principal Investigator)和 L. Brandt(Program Manager)审批。
SRR 之后,需求3.1 Orbit Average Power从 28 W 改为 30 W。由于 3.1 已审批,它被移回“评审中”,并附注“审批后文本已更改”。
待审查的关联列出来自 3.1 的六个关联:
- 1.3.1 Solar Arrays
- F3 Generate and Store Power和F3.1 Convert Sunlight to Power
- EQ-1.1 Solar Power Generation和EQ-1.4 Power Margin Check
- TC-06 Solar Array Power Test
点击任意一行上的差异:“28 W”被划掉,插入了“30 W”。然后评审这些条目:
- TC-06 期望峰值功率 ≥ 72 W,实测为 75.1 W。通过EQ-1.3 Orbit-Average Array Power(峰值 × 0.62 光照比例 × 0.6 功率路径效率),75.1 W 相当于 27.9 W 的轨道平均功率,低于新的 30 W。让该关联保持未评审状态,并添加评论“75.1 W peak = 27.9 W orbit average; re-test against about 80.6 W peak”。该测试需要新的预期结果和新的运行。
- 在将 1.3.1 标记为已评审之前,检查太阳能电池阵的尺寸计算是否仍然闭合。
与当前比较。在版本 ▾中选择SRR Baseline,然后点击其横幅中的与当前比较。报告列出:
- 3.1 的描述、理由、状态和质量评分的更改。
- 2.4 Target Slew 的状态更改(草稿 → 评审中)。
- 新需求4.4 Downlink Encryption,及其两个新的satisfies关联。
审批。打开审批。九条需求处于“评审中”,包括 3.1、1.5 Daily Collection Volume 和 5.3 Downlink Link Margin。
提示和良好做法
- 每条需求只写一个“shall”,使用主动语态,并带有数值、单位和条件。质量检查奖励的正是这一点。
- 将原因写在理由中,而不是写在陈述中。目的短语(“so that”、“in order to”)和括号会被标记为 R20 和 R21。
- 编写时填写验证方法。这样,有方法但没有测试用例的需求在 RVTM 中会显示为“仅计划”,而不是“未验证”。
- 设置TBD/TBR并指定所有者和截止日期,而不是只在文本中键入“TBD”。该属性为登记册提供可跟踪的所有者和截止日期。
- 每次评审前建立基线。更改条和与当前比较只能相对于基线工作。
- 将关联标记为已评审时附上评论。评论会添加到所关联的条目并记录在关联上,因此评审会留下审计跟踪。
常见错误
| 现象 | 原因 | 修正 |
|---|---|---|
| 某条需求未被评分、不在登记册上或不在 RVTM 中。 | 它是 Statement,而不是 Requirement。 | 在属性面板中将其类更改为 Requirement。 |
| 每条需求的 Correct 和 Feasible 都显示 ✘。 | 它们需要人的判断(“Needs a reviewer’s judgment”)。 | 逐条评审,然后点击 ✘ 将其标记为“是”,或运行 AI 需求检查。 |
| 得分显示“已过期 — 重新运行”。 | 上次检查之后文本已更改。 | 点击检查质量,或开启文本更改时自动重新检查。 |
| 手动的“是/否”覆盖消失了。 | 编辑文本会清除它们。 | 评审后重新设置;撤销会恢复它们,并且它们保留在历史记录中。 |
| 修正拼写错误后需求不再是“已审批”。 | 对名称或描述的任何编辑都会重新打开已审批的需求。 | 再次审批。在审批前修正拼写错误。 |
| TBD/TBR 行上没有“关闭”。 | 该未关闭条目仅来自文本。 | 编辑文本以删除 TBD、TBR 或 TBS。 |
| 导入创建了副本而不是更新。 | Match existing entities by没有匹配上。 | 带ID列导出,编辑,然后以Match existing entities by: Global ID导入(请参阅从电子表格更新需求)。 |
与其他功能的关联方式
- 输入来源:通过导入获得的利益相关方输入和现有规格说明,以及在文档中编写的文档。
- 输出去向:
- AI:文档和条目视图的✦ AI ▾菜单包含 Rewrite Clearly…、Add Measurable Criteria…、Simplify…、Split Compound Requirement…、Draft Rationale…、Suggest Name… 和 Check with AI(AI 需求检查)。AI 更改在应用前会先预览。请参阅询问 AI 和 AI 工具。
需求页面
使用需求页面在一个表格中查看和编辑每条需求。需要与需求 → 需求是筛选为 class:Requirement 的数据库。
数据库的每项功能在这里都可用:
- 对列排序和筛选,并就地编辑单元格。
- 选择行以显示批量操作栏,一次为多条需求设置属性或标签。
- 导出,并为所选行打开可追溯性矩阵。
点击一行可在属性面板中显示该需求。双击可打开其条目视图。有待审查关联的需求在其行上显示⚠ 评审徽标。右键点击一行可打开其菜单:最多三个建议操作及其原因(例如需求未通过 Unambiguous 时的✦ Add Measurable Criteria…,未验证时的✦ 生成测试用例…)、✦ More AI ▸,然后是Open、重命名…、Duplicate、添加子条目…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、复制链接、Copy Number和删除…(请参阅右键菜单)。
有关表格、查询和批量编辑,请参阅模型和数据库。
实用的查询:
| 查询 | 显示内容 |
|---|---|
class:Requirement | 每条需求。 |
Requirement:"Status=In Review" | 审批列表。 |
Requirement:"Status=Draft" | 尚未送交评审的需求。 |
class:Requirement AND is:leaf | 叶需求(没有子需求)。 |
class:Requirement AND NOT relationship:"verified by" | 没有验证条目的需求。 |
需求质量
使用质量页面(标题为“需求质量”)找出措辞不佳的需求。它按九项准则为每条需求评分。
九项准则以及建议中的规则编号(R2、R19 等)遵循 INCOSE Guide to Writing Requirements 中的特性和规则。Holarch 的词表和模式是对这些规则的近似;它们不是该指南的原文,有些规则需要评审人的判断。
- 得分 = 100 × (满足的准则数)/ 9,四舍五入。未检查的准则(–,请参阅其他语言的需求)不计入:100 × 满足数 / 8。
- 67% 或以上为良好。低于 67% 为需要返工。
- 进度条低于 34% 为红色,34% 至 66% 为黄色,67% 起为绿色。
页面布局
- 页面标题:
- 更多 ▾:清除手动评级会重置所显示需求的每个手动“是/否”,并重新运行检查。在“需求”中打开会在需求表格中打开所显示的需求。范围为某个文档时,会出现打开文档。
- 导出 ▾:所显示需求的Excel (.xlsx)和CSV。
- 检查质量:检查范围内的每条需求,不受筛选显示内容的限制(重复规则会将每条需求与范围内的其他需求进行比较)。
- ✦ AI ▾(位于顶栏):用 AI 检查(N 条需求)…,即对所显示需求进行的 AI 需求检查。
- 范围栏:范围(所有需求或文档:<name>)和复选框文本更改时自动重新检查。待审查的关联、TBD/TBR和审批在导航栏中位于质量旁边。
- 查询栏:+ 筛选、筛选标签和搜索文本、清除、?(搜索语法)和视图 ▾:与需求页面上的栏相同(请参阅筛选质量页面)。
- 卡片:需求(筛选隐藏了部分需求时,在显示的需求下显示“12/40”)、平均分数、良好 (≥ 67%)、需要返工 (< 67%),以及存在过期结果时的已过期(文本已更改)。过期得分不计入平均值。
- 卡片下方的说明:“自动检查最多覆盖 9 个属性中的 7 个 (78%);Correct 和 Feasible 需要人工验证——单击 ✘ 可标记为“是”。每次单击依次切换为手动“是”、手动“否”和恢复自动。”
- 表格:编号、名称(下方为描述)、质量评分、每项准则一列,以及建议。“建议”列出每条消息,并以其准则作前缀。行按编号排序。右键点击一行,或在行上按 Shift+F10,可打开数据库行菜单:建议操作及其原因(修正未通过准则的改写排在最前)、✦ More AI ▸、Open、重命名…、Duplicate、添加子条目…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、复制链接、Copy Number和删除…。该行成为所选内容。
- 多行:⌘ / Ctrl-点击(在 Windows 和 Linux 上为 Ctrl-点击)切换一行,⇧ / Shift-点击选择从上次点击的行起的范围,⌘ / Ctrl+⇧ / Shift-点击添加该范围,在获得焦点的行上按 ⌘A / Ctrl+A 或 ⇧ / Shift+↑ / ⇧ / Shift+↓ 可选择所有行或扩展选择。工具栏显示数量;Esc 清除选择。右键点击所选的一行可对所有所选行操作:✦ Check with AI (n requirements)…、✦ Rewrite (n) ▸、✦ Generate Test Cases (n)…、✦ Ask AI About These (n)…、✦ Suggest Traces (n)…(各有一个预览;请参阅对多个所选条目使用 AI)、Duplicate n Entities、Set Status ▸、Set Priority ▸、Add to Document ▸和Delete n Items…,每项都可通过一次撤销撤回。TBD/TBR 登记册和待审查的关联的工作方式相同;在待审查的关联中,所选内容还会为将所选项标记为已评审…勾选这些行。
特殊情况:
- 没有结果的行在得分列中显示“未运行”。
- 过期的行显示“已过期 — 重新运行”。
- 范围内没有需求时,页面显示“没有需求”和“仅对 Requirement 类的条目评分;跳过 Statement。”
- 筛选或搜索文本隐藏了所有需求时,页面显示“没有匹配的需求”和“没有与搜索或筛选器匹配的需求。清除它们以查看所有需求。”
筛选质量页面
查询栏的工作方式与需求页面上相同(请参阅键入的筛选条件如何变为标签):键入的筛选词在按 Enter 后变为标签,其余文本匹配名称、编号和描述,在空搜索框中按 Backspace 会删除最后一个标签,清除会删除全部标签。卡片、表格、导出 ▾和✦ AI ▾ → 用 AI 检查都遵循筛选条件。
+ 筛选列出以下内容,并附带范围内的计数:
| 组 | 筛选条件 | 词项 |
|---|---|---|
| 质量 | 良好 (≥ 67%)、需要返工 (< 67%)、未运行、已过期(文本已更改)、手动评级、AI 发现项 | quality:good, quality:rework, quality:notrun, quality:stale, quality:manual, quality:ai |
| 未通过某项准则 | 每项准则一个:评为“否” | quality:Verifiable=no(=yes:评为“是”) |
| 规则发现项 | 范围内发现的规则,例如R7 Imprecise wording或R30 Closely resembles(可能的重复项) | quality:R7 |
| 结构、类、需求属性、标签、关系、图 | 与需求页面相同;需求属性列出时不带类标签 | is:tbd, Requirement:"Status=Draft", label:"…" |
同一组内的筛选条件以或组合;不同组之间以和组合。分数范围使用该属性:Requirement:"Quality Score>=50"。quality: 词项也可在需求页面和数据库中使用。
视图 ▾应用内置视图(需要返工、尚未检查、结果已过期、含糊、不可验证、可能的重复项、手动评级)或您保存的某个视图。保存视图…将当前筛选条件和搜索文本保存在此浏览器中,适用于所有项目;使用已保存的视图时会出现删除“<name>”。所有需求清除筛选条件。地址 quality?q=<query> 会打开已筛选的页面。
筛选读取已存储的结果,不会重新检查。在 50,000 条需求上,更改筛选或搜索所需时间远低于十分之一秒。
准则和检查
每项准则显示以下三种标记之一:
- ✔(是):没有消息。
- ✘(否):至少有一条消息。
- –:未检查。
检查匹配完整的单词和短语,不区分大小写。只有列出的形式才计入:“effective”和“effectively”都已列出,“effectiveness”则没有。引号内的单词也计入。下列消息是显示的确切文本。消息末尾方括号中的列表列出找到的单词。
Unambiguous(无歧义)
| 规则 | 留言 | 触发条件 |
|---|---|---|
| R6 | R6 - 无法识别的单位;请使用标准 SI、美制或英制单位:[...] | 数字后跟一个非已知单位的单词(例如“12 sorties”)。已知单位包括 SI、美制和英制单位及其缩写、%、度、°C 和 °F。 |
| R2 | R2 - 使用主动语态:[...] | “shall/must/will/should be”后跟过去分词(“shall be measured”)。 |
| R5 | R5 - 请使用定冠词(“the”)代替:[...] | “a”或“an”。 |
| R7 | R7 - 措辞不精确:[...] | some、many、several、few、little、much、various、appropriate(ly)、adequate(ly)、efficient(ly)、effective(ly)、sufficient(ly)、reasonable、reasonably、suitable、suitably、significant(ly)、minimal(ly)、maximal(ly)、approximately、almost、nearly、generally、usually、typically、normally、robust(ly)、flexible、flexibly、easy、easily、etc、similar、relevant、substantial(ly)、large、small、good、bad、better、best、worst、proper、properly、acceptable、acceptably、accurate(ly)、extreme、high-contrast、high contrast。 |
| R8 | R8 - 例外条款削弱了需求:[...] | if necessary、where possible、as appropriate、as practicable、as far as possible、if practical、as required、as needed、to the extent possible、if possible。 |
| R10 | R10 - 不必要的不定式短语:[...] | to be designed to、to be able to、to be capable of、to enable、to allow、be able to、be capable of。 |
| R16 | R16 - 避免否定:[...] | not、n't、never。 |
| R17 | R17 - 避免使用斜线(“/”)。 | 两个单词之间的斜线,但 km/h、m/s、and/or 及其在德语、法语、西班牙语、意大利语和荷兰语中的对应形式除外。 |
| R24 | R24 - 使用代词而非明确的名词:[...] | it、its、they、them、their、he、she、him、her、someone、something、anyone、anything、anybody、somebody、this、these、those。 |
| R32 | R32 - 请用“each”代替全称限定词:[...] | all、any、both、every、everything、everyone。 |
| R34 | R34 - 无法衡量的性能用语:[...] | fast、quick、quickly、user friendly、user-friendly、high speed(s)、high-speed、best practice(s)、state of the art、state-of-the-art、seamless(ly)、intuitive(ly)、easy to use、timely、rapid、rapidly、real-time、real time。“Real-time clock”不计入:它指的是一个组件。 |
| R35 | R35 - 含义不清的时间用语:[...] | as、eventually、before、after、until、meanwhile、simultaneous(ly)、soon、later、sometimes、occasionally、often、subsequently、previously。 |
| — | 请替换 TBD/TBR 占位符。 | 描述中的 TBD、TBR 或 TBS(大写)。 |
| — | AI:含糊 — <reason> | 来自 AI 需求检查的已接受 AI 发现项。 |
| — | 表示最大值(“up to”);如果指最小值,请使用“at least”。 | “up to”后跟一个数字,以数字或单词表示(“up to 72 hours”、“up to five tonnes”)。“Up to date”不计入。 |
Complete(完整)
| 规则 | 留言 | 触发条件 |
|---|---|---|
| — | 缺少描述。 | 描述为空。 |
| — | 缺少名称。 | 名称为空。 |
| R9 | R9 - 开放式列举用语:[...] | including but not limited to、etc、and so on、and so forth、such as、among others。 |
Singular(单一)
| 规则 | 留言 | 触发条件 |
|---|---|---|
| R18 | R18 - 写成单个句子(发现 N 句)。 | 多于一个句子(也包括以 。、! 或 ? 结尾的日语和中文句子)。 |
| — | 请以句号结束该语句。 | 描述不以“.”(或 。)结尾。 |
| R19 | R19 - 合并了两条需求;请拆分为单独的需求:[...] | and、or、but、however 或 whereas 连接两个动作或两项义务(“shall log and report each fault”、“… and the operator shall …”),“nor shall”,“;”之后的第二个子句;第二个动作之前的“and/or”。请参阅一条中含两条需求 (R19)。 |
| R19 | R19 - “and/or” 含义模糊;请说明是两者还是任一:[and/or] | 位于值之间或条件中的“and/or”。 |
| R19 | R19 - 合并了两个值;如果分别验证,请拆分:[...] | and、or 在一个动作之后连接两个对象或值(“measure the temperature and the humidity”)。这是一条提示:Singular 仍为“是”。 |
| R20 | R20 - 包含目的短语;请移到理由中:[...] | purpose of、in order to、so that、for the purpose of、so as to。 |
| R21 | R21 - 包含括号;请将括号内的文字移到理由中。 | “(”或“[”(也包括全角括号)。 |
Conforming(合规)
| 留言 | 触发条件 |
|---|---|
| 请使用情态动词:[need, shall, will, should, must] | 这些词都没有出现。 |
Appropriate(适当)
| 规则 | 留言 | 触发条件 |
|---|---|---|
| R31 | R31 - 强加了解决方案:[...] | using、by means of、utilizing、utilising、implemented in、implemented with、via a、via the、built with、written in。 |
Necessary(必要)
| 规则 | 留言 | 触发条件 |
|---|---|---|
| R30 | R30 - Closely resembles: [3.2 Battery Capacity (81.3% similar), ...](高度相似) | 范围内另一条需求的描述至少 75% 相似(字符对相似度)。该发现项最多列出五条,其余计数(“and 3 more”)。需求的直接父级和子级(decomposed by、decomposes)不参与比较:细化需求常常重复其父级的措辞。同级需求和无关需求参与比较。 |
Verifiable(可验证)
| 留言 | 触发条件 |
|---|---|
| Link a Test Case or Requirement that verifies it.(关联一个验证它的测试用例或需求。) | 该需求没有指向 Requirement 或 Test Case 的verified by关联。 |
| AI:按所写内容不可验证 — <reason> | 来自 AI 需求检查的已接受 AI 发现项。 |
Feasible(可行)
| 规则 | 留言 | 触发条件 |
|---|---|---|
| R26 | R26 - 很难达到的绝对化用语:[...] | always、never、100%、100 percent、all the time、totally、completely、absolutely、zero defects、forever、continuous、continuously、uninterrupted。 |
| — | Needs a reviewer’s judgment(需要评审人判断) | 未发现绝对化用语和近似重复项;必须由人来判定。 |
Correct(正确)
| 留言 | 触发条件 |
|---|---|
| Needs a reviewer’s judgment(需要评审人判断) | 所有文本检查(Appropriate、Complete、Conforming、Necessary、Singular、Unambiguous)均已通过;必须由人来判定。 |
由于在有人判定之前,Correct 和 Feasible 都以“Needs a reviewer’s judgment”结束,自动评分最高为 9 项中的 7 项 (78%)。
一条中含两条需求 (R19)
一条需求只陈述一件事。R19 会查看每个“and”、“or”、“nor”、“but”、“however”、“whereas”、“as well as”和“and/or”,并将其归入以下类别之一:
| 类型 | 示例 | 结果 |
|---|---|---|
| 两条需求 | “The unit shall log and report each fault.”“The pump shall stop, and the operator shall be alerted.”“… to acknowledge alarms and to silence the horn.”“…; it shall also …” | 一个发现项。Singular 为“否”。 |
| 含糊的“and/or” | “The log shall record the user ID and/or the badge number.” | 一个发现项:说明是两者还是任一。Singular 为“否”。 |
| 两个值 | “The station shall measure the temperature and the humidity.” | 一条提示:如果每个值分别验证,请拆分。Singular 仍为“是”;该提示以灰色显示,不会降低得分。 |
| 无发现项 | “between 5 °C and 30 °C”;“When A and B, the unit shall …”;“… when the door is open and the fan is off”;“requirements 2.1 and 2.2”;引号中的文本;“The command and control unit shall …”;“ASME Boiler and Pressure Vessel Code”;“5 Nm at 3000 rpm and 24 V”;“including batteries and strap”;“either open or closed” | 无。 |
同一量的两个值(“at -20 °C and 60 °C”)会得到提示。“, and”会结束条件:“… when the level falls below 10 %, and restart when …”是一个发现项。作为一个整体行动的主语(“The Owner and the Contractor shall agree …”、“The power and data connector shall …”)不会得到提示;各自行动的两个主语(“The pump and the valve shall close …”)会得到提示。比较词(“12 or more”)不会被标记。动作之后的名称无法与两个值区分开,因此请将其列在复合名称下。
复合名称。在质量页面上,更多 ▾ → 复合名称…会打开项目的名称列表,其中的名称包含“and”或“or”但指代单一事物,每行一个(例如“power and data connector”)。R19 不会标记它们。项目缩略语词汇表中的展开形式(Acronym 陈述,请参阅查找缩略语)也计入,此外还内置了一些常见名称(“command and control”、“research and development”、“operations and maintenance”…)。该列表随项目保存,并且可以撤销。再次点击检查质量以应用更改。
其他语言的需求
Holarch 会根据文本检测每条需求的语言。单词规则(R2–R10、R16、R19、R20、R24、R26、R31–R35、“up to”、情态动词、单位)为英语需求评分。
德语、法语和西班牙语(测试版)。这些需求会以其自身语言应用相同的规则,例如德语中的“angemessen”或“bei Bedarf”,法语中的“approprié”或“si possible”,西班牙语中的“adecuado”或“según corresponda”。当某种语言的规则处于测试版时:
- 每个发现项都是标记为(测试版)的建议。它与其他提示一起以灰色显示,从不降低准则或得分;
- 会显示提示“此语言的措辞规则为测试版:仅作建议,不计分。结构检查仍适用。”,并且在用 AI 检查措辞或手动评级之前,Unambiguous为–(未检查);
- 表示“each”的词(jede、chaque、cada)是正确的选择,不会被标记,“alle 5 s”或“tous les 5 s”(every 5 s)也不会被标记。
只有在某条规则针对该语言编写的至少 300 条陈述进行了测量,并由以该语言为母语的需求工程师评审(其发现项至少 90 % 正确)且评审人签核之后,该规则才开始对该语言计分。届时,该语言的得分可能会在下一次检查时发生变化;发布说明会注明这一点。
其他语言(日语、意大利语、中文及其余语言)会得到:
- 提示“措辞规则适用于英语。结构检查仍适用。”,并且Unambiguous为–(未检查):在检查措辞或手动评级之前不计入得分。其他 Unambiguous 发现项(例如 TBD)仍会使其不通过;
- 适用于任何语言的检查:R18(也包括 。)、末尾句号(也包括 。)、R17、R21、TBD/TBR、R30、名称、描述和验证关联。
无论是否为测试版,每种语言也都会得到这些检查。建议以英语存储,所发现的单词按原文引用(“R7 - Imprecise wording: [angemessen] (beta)”),因此quality:R7筛选和导出在每种语言中的工作方式都相同。公共 API 会连同其规则、单词和模式一起返回它们(findings)。
用 AI 检查措辞。质量页面上的✦ AI ▾ → 用 AI 检查措辞…(或单条需求上的✦ More AI ▸)会通过所配置的 AI,以每条需求自身的语言应用相同的规则。预览列出发现项以及以该语言给出的可选改写(未勾选)。应用所选项会将发现项添加为 AI 发现项并移除提示(测试版建议仍保留为提示),作为一个撤销步骤。编辑文本会清除它们。此功能需要包含 AI 的方案。
手动覆盖
当您不同意自动结果时,或为了记录评审人的决定,可以覆盖某项准则。
- 在质量页面上:点击准则单元格可循环切换:第一次点击设为手动“是”(✔),下一次设为手动“否”(✘),第三次清除手动值,由自动检查重新决定。手动单元格显示手动标记;其工具提示显示“(手动设置)”以及下一次点击的作用。
- 在属性面板或条目视图中:每项准则都是一个含是和否的列表。手动设置的准则还提供自动(重新检查),可将其恢复为自动结果。手动设置的值显示“手动”。
检查重新运行时,手动值会保留。没有其他消息的手动“否”会显示“Marked No manually.”(已手动标记为“否”。)
覆盖在两种情况下会被清除:
- 需求的名称或描述发生更改。覆盖保留在历史记录中,撤销可将其恢复。
- 您选择更多 ▾ → 清除手动评级。这也会清除已接受的 AI 发现项。
过期结果
检查之后,如果需求的名称或描述发生更改,其结果会被标记为过期:
- 质量页面显示“已过期 — 重新运行”,工具提示为“上次检查后文本已更改。请再次检查质量。”
- 文档的质量评分列显示带时钟图标的已过时标签(指向它可查看原因)。
- 属性面板显示“质量:已过期 — 重新运行”。
开启文本更改时自动重新检查可避免过期结果。Holarch 随后会立即对编辑过的需求重新运行规则检查。该设置保存在此浏览器中。
从文档检查质量
在文档中,选择检查 ▾ → 检查质量。选中某条需求时,该项显示为检查此需求的质量,并只检查这一条。未选中需求时,它会检查文档中所有可见的需求。
结果在检查质量 — <name>对话框中打开,包含卡片和表格。其按钮为导出 CSV、导出 XLSX、在“质量”中打开和关闭。
没有需求的文档会显示“此文档中没有要检查的 Requirement。Statement 不评分。”
AI 需求检查
对于规则无法判定的准则Correct、Feasible和Necessary,可使用 AI 需求检查获取初步意见。它还会在Unambiguous下查找规则遗漏的措辞(例如似乎指最小值时的“up to 72 hours”,或没有度量的“accurately”),并在Verifiable下查找问题(任何测试、分析、检查或演示都无法证明按所写内容已满足该需求)。AI 会收到规则发现项,并只报告它们遗漏的内容。
- 选择✦ AI ▾ → 用 AI 检查(N 条需求)…。
对于单条需求,在其✦ AI ▾菜单中选择用 AI 检查(此需求)…,或在其右键菜单中选择✦ More AI ▸ → ✦ Check with AI…。
AI 会评审这些需求。它们以每组 20 条发送,并附带最多 300 条其他需求用于重复检查。使用内含 AI 时,检查按每 100 条需求计一次请求(向上取整);在运行超过 100 条需求的检查之前,对话框会说明将使用多少次,例如“This review uses 3 of your 52 included AI requests left this month (1 request per 100 requirements).”所需请求数超过剩余次数的检查不会启动。
- 在对话框中评审每条需求。
顶部的一行说明哪些项默认勾选:“勾选的条目将被应用。改写默认不勾选,以便您先阅读。已锁定、已审批和已纳入基线的需求默认不勾选。”
- 勾选您接受的更改和改写。
按钮上方的一行统计“应用”将执行的操作,例如“Applies 7 values and 2 rewrites to 5 requirements.”未勾选任何项时显示“未选择任何内容。”,应用所选项变暗。
- 点击应用所选项。
勾选的条目会被应用,一次撤销即可全部撤回。提示消息显示“Applied N AI changes”。
对于每条需求,对话框显示:
- 针对 Correct、Feasible、Necessary、Unambiguous 和 Verifiable 的“是/否”判定及原因。
- 在每项判定下,有一个复选框,其标签说明应用后会更改什么;如果存储的值已经一致,则显示“无更改”而没有复选框:
- Correct、Feasible 和 Necessary:判定与存储值不同时显示“No → Yes”或“Yes → No”,没有存储值时显示“Set to Yes”或“Set to No”。
- Unambiguous 和 Verifiable:AI 发现问题时显示“添加一个发现项”,之前的 AI 发现项不再成立时显示“清除之前的发现项”。
- 可选的评论。
- 如果 AI 提出了改写,则有一个带逐词差异的应用改写:复选框。
默认勾选的内容:
- 每项值更改默认勾选。
- 改写默认不勾选,以便您先阅读。
- 已审批、已纳入基线和已锁定的需求默认不勾选,并会被标记。
勾选改写会使该需求的 Unambiguous 和 Verifiable 复选框变暗,并标为“改写后已重新检查”:规则检查会在新文本上重新运行。取消勾选改写会将这些复选框恢复原状。Correct、Feasible 和 Necessary 仍会应用。
| 按钮 | 效果 |
|---|---|
| 选择所有值更改 | 勾选每项值更改,已审批、已纳入基线和已锁定的需求除外。 |
| 选择所有改写 | 勾选每项改写,被标记的除外。 |
| 全不选 | 取消勾选所有内容。 |
“应用”的作用:
- Correct、Feasible 和 Necessary 成为手动“是/否”值。
- Unambiguous 或 Verifiable 的“否”成为 AI 发现项:质量页面将其与规则发现项一起列出,显示为“AI:含糊 — <reason>”或“AI:按所写内容不可验证 — <reason>”,该准则显示 ✘。“是”会移除之前的 AI 发现项。
- 当需求的名称或描述发生更改时(包括接受改写),以及通过更多 ▾ → 清除手动评级,AI 发现项都会被清除。
应用所选项的作用:
- 判定成为手动值,消息为“AI:<reason>”。检查重新运行时它们会保留。
- 改写会替换描述并重新运行检查。
质量导出
| 导出 | 内容 |
|---|---|
导出 ▾ → CSV(quality_report.csv) | 每条需求的每项准则一行:编号、名称、描述、质量评分、属性、消息、结果。 |
导出 ▾ → Excel (.xlsx)(quality_report.xlsx) | 编号、名称、描述、理由、质量评分、属性、消息、结果,需求单元格在其九行上合并,“是”为绿色,“否”为红色,末尾有报告评分(“是”的回答数占全部回答数的比例)。 |
| 文档交付 ▾ → 所有导出… → Quality findings (Excel) | 单个文档的相同布局,使用文档的显示列。 |
审批
使用需要与需求 → 审批查看所有等待决定的内容。它会以查询 Requirement:"Status=In Review" 打开数据库。
它具有数据库的每项功能:
- 选择多行,并使用批量操作栏一起设置状态或标签。
- 导出该列表。
- 双击一行可打开条目视图和完整历史记录。
审批框
审批框显示在每条需求的属性面板和条目视图中。它显示:
- 以彩色标签表示的当前状态(未设置时为“草稿”)。
- 最后记录的决定:“<status> 由 <name> · <date and time>”,有附注时后接“— <note>”(例如“— 审批后文本已更改”),或显示“未记录审批”。
- 适用于当前状态的按钮:
| 按钮 | 显示条件 | 效果 |
|---|---|---|
| 审批 | 状态既不是“已审批”也不是“已拒绝” | 设为“已审批”,并记录您和时间。提示消息:“已审批”。 |
| 拒绝… | 状态既不是“已审批”也不是“已拒绝” | 在拒绝需求对话框中询问原因(可选),然后设为“已拒绝”。提示消息:“已拒绝”。 |
| 重新打开 | 状态为“已审批”或“已拒绝” | 设为“评审中”。提示消息:“已移到“评审中””。 |
记录的姓名是您的账户名称。在表格或属性面板中手动设置状态也会以您的姓名和时间记录一项决定。查看者看到的审批框没有按钮。
当工作流通过变更请求转到“已审批”时,审批框会改为显示未关闭的请求及其计数,例如CR-4:审批 1/3。应用后,决定会列出每位审批人和该请求:“Approved by Ann Lead, Bob Discipline · <date and time> · CR-4”。
注意:编辑已审批需求的名称或描述会将其设为“评审中”,并附注“审批后文本已更改”。提示消息报告“N 项已审批需求已移到“评审中”。”更改其他属性不会重新打开它。
TBD/TBR 登记册
使用登记册跟踪每个未关闭条目,直到其关闭。打开需要与需求 → TBD/TBR。在文档中,选择检查 ▾ → TBD/TBR 登记册,打开限定于该文档的登记册。
- 页面标题:导出 XLSX(登记册为空时禁用)。
- 范围栏:范围(所有需求或文档:<name>)。
- 卡片:未关闭的 TBD/TBR、已逾期、无所有者,以及可打开各文档的按文档标签(“<document>:<count>”)。
- 未关闭条目随时间变化:未关闭数量的燃尽图。它根据需求的历史记录重建,从最早的需求到现在最多 60 个点。指向某个点可查看其日期和数量。历史记录太少时显示“历史记录尚不足以生成燃尽图。”
- 表格列:
- 编号,以及带描述的名称。
- 文档。
- 类型:TBD、TBR 或 TBS,并标注“属性”、“文本中”或两者。
- 所有者:TBD 所有者,否则为需求的所有者,否则为“—”。
- 截止日期:需求唯一的截止日期,与属性面板工作流组中和条目视图上的截止日期为同一日期。当TBD 截止日期属性含有日期时即为该属性,否则为需求的截止日期。日期已过时,下方显示“已逾期”。已逾期的行带有底色。
- 时长:自条目打开以来的天数。
- 关闭。
右键点击一行,或在行上按 Shift+F10,可打开与数据库中相同的行菜单:建议操作及其原因、✦ More AI ▸、Open、重命名…、Duplicate、添加子条目…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、复制链接、Copy Number和删除…。在其他右键菜单中,有未关闭 TBD 或 TBR 的需求以Resolve TBD…开头,它会打开此登记册并选中该需求。
登记册是只读的。要更改截止日期,请选择该行并在属性面板中设置截止日期。Holarch 会设置需求的截止日期,并且当TBD 截止日期属性含有日期时也设置该属性(保留其时刻),一次撤销即可全部撤回。清除截止日期会同时清除两者。
关闭仅在设置了 TBD/TBR 属性时出现。它会将该属性设为 None:
- 文本中没有剩余内容时,提示消息显示“已关闭”。
- 文本中仍有 TBD、TBR 或 TBS 时,提示消息显示“属性已关闭;文本仍包含 TBD。”
- 仅来自文本的条目没有“关闭”按钮;编辑文本即可将其关闭。
没有未关闭内容时,页面显示“没有未关闭的 TBD/TBR 条目。要在此列出,请设置需求的 TBD/TBR 属性,或在其文本中写入 TBD、TBR 或 TBS。”
导出 XLSX写入 TBD-TBR Register.xlsx,包含编号、名称、文档、类型、来源(属性、文本或两者)、所有者、截止日期、打开日期、时长(天)、已逾期(“是”为红色)和描述。
待审查的关联
使用待审查的关联(在其他工具中也称为可疑链接)查找需求更改后必须重新检查的内容。当关联另一端的条目在该关联上次评审后发生更改时,该关联需要评审:请检查该关联是否仍然成立,然后将其标记为已评审。需要与需求 → 待审查的关联列出它们。在文档中,使用检查 ▾ → 待审查的关联。
什么会将关联标记为待审查
需求上的以下更改会将其关联标记为待审查:
- 名称或描述。
- 优先级、关键性、验证方法或验证级别。
- 任何数值、百分比或时长属性。
随后,Holarch 会标记该需求以下类型的每个关联:decomposed by、derived by、refined by、satisfied by、verified by和traced to。
更改验证方法或验证级别只会标记verified by关联。为需求设置第一个方法或级别不会标记任何内容:这只是规划验证,没有更改任何已评审的内容。
每个关联的另一端是待评审条目:子需求、满足它的功能或资产、验证它的测试用例等。对同一需求的后续更改会添加到同一标记的已更改字段列表中。
待审查的关联显示在哪里
- 待审查的关联页面:每个待审查的关联一行。
- 文档和数据库:条目所在行上的⚠ 评审徽标(“另一端的条目在此关联上次评审后已更改。请检查该关联是否仍然成立,然后将其标记为已评审。单击以评审。”)。
- 属性面板和条目视图:横幅“⚠ 评审:<requirement> 在此关联上次评审后已更改。请检查该关联是否仍然成立,然后将其标记为已评审。”其评审…按钮会打开该条目的待评审的关联 — <item>对话框,含待评审的未关闭关联和关闭。
- 属性面板的追溯部分:每个待审查的关联旁边有 ⚠,其工具提示中显示已更改的字段和日期。
- RVTM:任一端有待审查关联的需求(它已更改,或其上游条目已更改)后面有 ⚠;点击它可评审这些关联。Verified by中测试用例后面的 ⚠ 标记该验证关联。
待审查的关联页面
该页面在顶部说明规则,并显示一个表格:
| 列 | 内容 |
|---|---|
| (复选框) | 选择以用于将所选项标记为已评审…。标题复选框全选。 |
| 变更 | 已更改的需求。 |
| 变更 | 已更改的字段,例如“描述”或“优先级, 验证级别”。 |
| 时间 / 人员 | 更改的日期和时间以及更改人。 |
| 关系 | 关联类型,从已更改需求的角度读取(例如“satisfied by”)。 |
| 待评审条目 | 关联另一端的条目。 |
| (操作) | 差异和标记为已评审…。 |
右键点击一行,或在行上按 Shift+F10,可打开该条目的行菜单,与数据库中相同:建议操作、✦ More AI ▸、Open、重命名…、Duplicate、添加子条目…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、复制链接、Copy Number和删除…。在其他右键菜单中(数据库、文档),有待审查关联的条目以检查链接…开头,它会打开该条目的评审。
差异会打开更改 — <requirement>,显示名称和描述的逐词差异。只有属性更改时,显示“仅属性已更改:<fields>。打开条目历史记录以查看详细信息。”历史记录…会打开需求的历史记录。
要将关联标记为已评审:
- 点击某一行上的标记为已评审…,对勾选的行点击将所选项标记为已评审…,或点击全部标记为已评审(N)…。
随即打开将 N 个关联标记为已评审:“确认更改后关联的条目仍然成立。每个关联的条目都会添加一条评论。”
- 键入可选的评论,例如“子条目仍然有效;无需更改。”
- 点击标记为已评审。
提示消息显示“已将 N 个关联标记为已评审。”
未选择任何内容时,将所选项标记为已评审…会显示“请先选择要标记为已评审的关联。”
将关联标记为已评审会在关联上记录该评审:人员、时间、评论和字段。如果您写了评论,Holarch 还会在每个条目的评论中添加“Link reviewed (<requirement> changed: <fields>): <comment>”。撤销可将其还原。
没有待审查的关联时,页面显示“没有待评审的关联。当关联另一端的条目在该关联上次评审后发生更改时,该关联需要评审。”
基线和版本比较
文档基线
使用文档标题栏中的版本 ▾创建和使用文档基线。它列出:
- 当前版本:实时文档。
- 此文档的每个基线,最新的在前,并附带日期。
- 在项目基线下,列出每个项目基线。
- 保存基线…和比较版本…(在文档有基线之前变暗:“Save a baseline first”)。
保存基线…会打开保存基线:
- 名称 *(必填)。
- 审批:名称、角色和声明的行,带+ 添加审批人。第一行已填入您的姓名。为空时显示“No approvers.”。
- 说明:“The baseline keeps this version of the document (its items, their attributes and relationships) to view, compare and restore later. Approval records are dated now and cannot be edited afterwards.”(基线会保留该文档的此版本——其条目、属性和关系——以便日后查看、比较和恢复。审批记录以现在的日期记录,之后无法编辑。)
在版本 ▾中选择一个基线即可查看。文档变为只读,显示横幅“Baseline “<name>”, read-only, saved <date>”和审批列表。随即出现以下按钮:
| 按钮 | 效果 |
|---|---|
| 返回当前版本 | 返回实时文档。 |
| 编辑 | 编辑基线:重命名基线并添加审批记录。审批(已锁定)列出现有记录,这些记录无法更改;新记录“以现在的日期记录并添加到列表中”。仅限文档基线。 |
| 与当前比较 | 从此基线打开比较版本。仅限文档基线。 |
| 恢复基线 | 文档基线:“用基线“<name>”覆盖此文档的实体、顺序和结构?此后添加的实体会从文档中移除(不会删除)。可以撤销。”项目基线:用基线替换项目,“用项目基线“<name>”替换整个项目?可以撤销。” |
| 删除 | “删除基线“<name>”?” |
在实时文档中,每一行都带有更改条:自基线以来新增、自基线以来已更改或未更改。它与最新的文档基线比较;文档没有基线时,与最新的项目基线比较。
比较版本
使用更改报告准确查看自某次评审以来更改了什么。
- 点击版本 ▾ → 比较版本…,或基线横幅中的与当前比较。
随即打开比较版本。
- 选择从:一个基线。
- 选择到:较晚的基线,或当前版本。
表格列出编号、名称、更改类型、字段和更改(已修改文本的逐词差异)。
更改类型:
| 更改类型 | 含义 |
|---|---|
| 已添加 / 已移除 | 该实体加入或离开了文档。 |
| 已修改 | 某个字段已更改:名称、编号、描述、类、图片或任何属性(会注明字段)。 |
| 已添加标签 / 已移除标签 | 添加或移除了一个标签。 |
| 已添加关系 / 已移除关系 | 添加或移除了一个涉及该文档的关联。 |
| 关系属性 | 某个关系的属性已更改。 |
更改 (Excel)写入“<document> (Changes).xlsx”,包含编号、名称、类、更改类型、字段、旧值和新值。修订标记版 (Word)将相同的比较写为 Word 修订。
文档的交付 ▾ → 更改 (Excel)…(也在所有导出…中)以从和到导出相同的报告。没有基线时,它会失败并显示“This document has no baseline. Save one first.”
文档 (Word)根据文档的基线填写 Word 输出中的修订历史和审批表格。
基线和版本页面
使用控制与评审 → 基线和版本管理项目中的每个基线。项目基线保存每个实体;文档基线保存一个文档,通过文档的版本 ▾ → 保存基线…创建。页面标题中有恢复以前的版本…(可找回整个项目较早的自动保存)和+ 保存基线…。
要创建项目基线:
- 点击页面标题中的+ 保存基线…。
保存项目基线对话框显示当前的实体和关系数量。名称默认为“Baseline <n>”;占位文本为“名称,例如“SRR””。
- 键入名称,然后按 Enter 或点击保存基线。空名称会被拒绝(“请输入名称。”)。
提示消息显示“基线已保存”。
该页面的卡片:
- 基线卡片:当前数量(“当前:<n> 个条目,<n> 个关系”)和一个筛选器:所有基线、项目级基线或文档:<name>。列:
- 名称。
- 文档:查看该文档在该基线时状态的链接,或“项目”。
- 创建时间。
- 审批:“✔”和审批人姓名。指向它们可查看角色、日期和声明。“由 <name>”注明创建者。
- 实体和关系。
- 比较:将此基线设为“从”,将当前工作副本设为“到”。
- ⋯(更多操作):
- 重命名…:重命名基线。
- 导出(JSON):下载“<name>.json”(格式为
holarch-baseline,含快照和审批)。 - 还原基线…(项目基线):“用基线“<name>”替换所有当前实体和关系?可以撤销(⌘Z / Ctrl+Z)。”提示消息:“已还原“<name>””。
- 恢复文档…(文档基线):“将文档“<doc>”恢复到基线“<name>”?只有该文档的实体和结构会更改。可以撤销。”文档已删除时禁用。
- 删除…。在托管服务上,只有项目所有者可以重命名或删除基线;对其他人,这些项会变灰并显示原因。
- 孤立基线(需要时显示):“N 个已删除文档的基线”。每项都有还原文档(根据基线重新创建文档 Artifact 及其实体)和删除。
- 比较卡片:选择自(较旧)和至(较新)。“至”为当前版本或同一范围的另一个基线。
- 卡片:已添加的实体、已移除的实体、已更改的实体、关系更改。
- 表格显示实体、更改、字段和差异(逐词差异)。日期属性以应用的日期格式显示。
- 导出 CSV和导出 XLSX写入“Changes <from> to <to>”。
- 没有可显示的内容时:““<from>”与“<to>”之间没有差异。”
没有基线时:“没有基线。创建一个基线以记录项目的当前状态。”
注意:基线存储在项目中,并随项目导出一起携带。项目基线保存实体和关系。文档基线还保存文档的大纲设置。
导入需求
使用需要与需求 → 导入和导出从文件导入需求。它分四步进行:文件 → 映射 → 检查 → 导入。
- 返回和继续在各步骤之间移动。“检查”步骤中的Import N items执行导入,一次撤销即可全部撤回。
- 一个放置区域接受所有格式。格式根据文件检测(其名称,名称不足以判断时还根据内容),并显示在格式下,您可以在那里更改。
这些格式为Word (.docx)、Holarch 项目文件(.holarch, .json)、Excel / CSV (.xlsx, .csv)、Plain Text (.txt)、UML/SysML (.xmi, .uml, .mdzip)和ReqIF(.reqif)。
本节介绍需求格式。有关项目文件、XMI 以及所有其他导入和导出,请参阅导入和导出。
第 1 步:文件
将文件放到“Drop a file here or click to choose one”上,或将文本粘贴到框中并点击分析文本(带标题行的 CSV、ReqIF XML、XMI、JSON 或文档文本)。
| 选项 | 值 | 效果 |
|---|---|---|
| 格式 | 上述六种格式 | 显示检测到的格式。选择其他格式可按另一种方式读取同一内容。 |
| 文本编码(CSV、文本) | 自动、UTF-8、ISO-8859-1 / Windows-1252、Shift_JIS、Big5、UTF-16 | 如何读取文件的字节。更改它会重新读取文件。 |
| 工作表(工作簿) | “<name> (N rows)” | 要导入的工作表。会预先选中第一个含数据的工作表。 |
- 纯文本:该框中的导入内容保持可编辑。编辑后点击重新运行分析。
- 状态行显示“Analyzed “<file>”: N rows, M columns.”(另加“(sheet “<name>”)”,对于 Word 还有“, N table(s)”)。
第 2 步:映射
每个文件列为一行:文件列(标题和位置)、示例值(前三行)和Holarch 字段。选择跳过可略过某一列。根据列标题匹配的字段标为自动。
| Holarch 字段 | 内容 |
|---|---|
| 名称、编号、描述 | 条目自身的字段。 |
| 类、标签 | 类名;以 ; , 或 | 分隔的标签名。 |
| 父级编号、全局 ID | 父级的编号;用于匹配现有实体的 ID。 |
| 一个属性 | 无类的行所用类的任何属性。 |
| 一个关系 | 多个目标之间用 ; 分隔。 |
| 行 ID、父行 ID、新属性(已添加到架构) | 来自 ReqIF 和 XMI 文件的结构,以及新属性。 |
✦ AI ▾ → Suggest mapping为每一列建议一个字段。建议的映射列出这些更改(已勾选)及 AI 的理由;应用已勾选项会更改映射。此时尚未导入任何内容。
Holarch 根据标题猜测映射:
| 标题 | 映射到 |
|---|---|
| Number、No、Num、#、ID Number、Req Number、Requirement Number | 编号 |
| Name、Title、Short Name、Requirement Name | 姓名 |
| Description、Text、Requirement、Requirement Text、Statement、Desc | 描述 |
| Class、Type、Entity Class | 类别 |
| Labels、Label、Tags | 标签(值之间用 ; , 或 | 分隔) |
| Parent、Parent Number | 父级编号 |
| Global ID、ID、GUID、UUID | 全局 ID |
| 属性名称(例如 Priority、Rationale、Status) | 该属性。“Method”和“Verification”映射到验证方法。 |
| 标签组名称(例如不存在该属性时的 Verification Method) | 标签 |
| 关系名称(例如 satisfied by) | 该关系;多个目标之间用 ; 分隔 |
| Object Identifier、Origin ID | 全局 ID |
| Object Number、ReqIF.ChapterName、ReqIF.ForeignID | 编号 |
| Object Heading、ReqIF.Name、Long Name | 姓名 |
| Object Text、ReqIF.Text、ReqIF.Description | 描述 |
| ReqIF.Category | 类别 |
| ReqIF ID、XMI ID、Row ID / Parent ID | 行 ID / 父行 ID |
新属性会在每个导入的类上创建一个以该列命名的属性。其类型取决于值:
- 每个值都是数字时,为数字。
- 不同的短值较少时,为选项列表。
- 值超过 120 个字符时,为长文本。
- 其他情况为文本。
质量准则、计算属性和文件属性无法映射。
在各列下方:
| 选项 | 值 | 效果 |
|---|---|---|
| 无类的行所用的类 | 任何类;默认为 Requirement | 没有 Class 列值且没有匹配类规则的行所用的类。 |
| 类规则 | 描述包含某个词或短语 → 某个类 | + 规则添加一条,× 删除一条。第一条匹配的规则适用于没有 Class 值的行。 |
| Match existing entities by(按以下方式匹配现有实体) | 全局 ID、名称、编号 | 与现有实体匹配的行会更新该实体,而不是创建副本。按名称和编号匹配还要求类相同。 |
| Match related entities by(按以下方式匹配相关实体) | 全局 ID、名称、编号 | 关系列中的值如何找到其目标。 |
| 日期列的日期格式(CSV) | 自动、yyyy-MM-dd HH:mm:ss、dd/MM/yyyy、MM/dd/yyyy、yyyyMMdd、自定义… | 如何读取日期单元格。自定义…会显示一个字段,供您使用 yyyy、MM、dd、HH、mm 和 ss 输入自己的模式(例如 dd.MM.yyyy HH:mm)。 |
| 编号模式(Word、文本) | 空(自动),或 1. a) (i) 之类的标记,或 1.1、1.1.a 之类的路径编号 | 编号段落如何成为大纲。对于文本,模式会根据编号检测并自动填入。Word 标题样式和列表编号不需要模式。请参阅编号模式。 |
| 在父级下为子级编号 (1 → 1.1)(Word、文本) | 默认开启 | 生成的子级编号变为“3.1”、“3.2”,而不是“1”、“2”。 |
层级。大纲编号会重建层级:“1.2.3”成为“1.2”的子级。父级编号列,或行 ID与父行 ID列对,可明确设置父级。没有父级的条目成为文档的顶层条目。
Word 表格。对于 Word 文件,Word 表格部分列出每个表格。在各章节中以相同标题重复出现的表格共用一个映射。该部分说明:“将需求表格导入为实体,每行一个,并映射其列。其他表格保留为表格,放在其前面条目的描述中。”
- 将每个表格设为Entities (one per row)或描述中的表格。
- 将其列映射到编号、名称、描述、类、标签、属性、新属性或跳过。
- ID、Req ID、Requirement ID、Ref 或 Paragraph 之类的标题映射到编号。
- Shall、Shall Statement、Requirement Statement、Requirement Text、Statement 或 Text 映射到描述。
具有编号或描述列且含“shall”行的表格默认设为实体。
迄今发现的警告显示在各列下方,或显示“No warnings.”。
第 3 步:检查
在任何内容更改之前检查结果。“检查”以“基线和版本”比较版本的方式显示更改(请参阅基线和版本比较):
- 第一行注明文件、格式以及每个类的条目数量。
- 当每个条目都是 Statement 或 Requirement(或其子类)时,会出现Create a requirements document from these N requirements,并已勾选。对于其他文件,它显示为Create a document from these N items,未勾选。勾选后,选择文档类型(默认为Requirements Document)、名称(默认为文件名)以及是否导入后为整个文档重新编号。
- 接下来是警告。
- 卡片统计新条目、已更新的条目、已匹配,未更改的条目和来自文件的关系。
- 更改表格列出每个新条目及其描述,以及已更新条目的每个已更改字段,并以逐词差异显示旧值和新值(前 500 项更改)。
点击Import N items。提示消息显示“Imported N new, M updated”。
- 没有警告时,Holarch 会打开新的需求文档(或数据库)。
- 否则,导入完成卡片会列出警告(没有问题时显示“The import reported no warnings.”)。其按钮为打开文档、打开数据库、Spider 图、Tree Diagram、检查质量和开始另一次导入。
新文档的描述会列出导入警告。
如何读取每种格式
Word (.docx):
- 标题和 Word 列表编号成为大纲,并保留其编号。
- 标题成为 Statement。其下的正文成为其描述。
- 含 shall、must、will 或 should 的段落成为子 Requirement,以情态动词之后的单词命名。编号列表项也是如此;没有情态动词时,它成为 Statement。
- 项目符号条目、图片和表格并入其前面条目的描述,保留粗体、斜体、列表和表格。
- 原始 .docx 在不超过单个文件附件上限时,会附加到新文档。
- PNG、JPEG、GIF、WebP 和 SVG 图片会保留。其他图片格式会被跳过并显示警告。
Excel (.xlsx, .xlsm) 和 CSV:
- 每个实体一行,列不限。第一行为标题。
- 多行单元格保留其换行。
- 不读取 Excel 97-2003 (.xls) 文件。请先将其另存为 .xlsx 或 .csv。
ReqIF (.reqif, .reqifz):
- 每个 SPEC-OBJECT 成为一行,含ReqIF ID、Parent ID(来自规格层级)、Type(其对象类型,映射到类)、Long Name,以及每个属性定义一列。
- 没有匹配的列默认为新建属性。XHTML 属性成为富文本属性,枚举属性成为选项列表。
- SPEC-RELATION 按名称成为关系。当名称与架构允许的关系不匹配时,它们成为traced to。
- .reqifz 归档会自动解压。
纯文本 (.txt) 或粘贴的文本:
- 带编号的行(“3.1 Battery”)或不带句号的短行成为标题 (Statement)。
- 每个含 shall、must、will 或 should 的句子成为当前标题下的 Requirement。
- 其他文本并入前一条目的描述。
- 有编号模式时(根据文本检测或手动键入),由该模式决定层级。
从电子表格更新需求
使用此方法在电子表格中一次更改多条需求。
- 在数据库(或需求页面)中,点击导出…并选择Table (CSV)。
- 勾选要编辑的属性。在Include下勾选ID,然后点击导出。
- 在电子表格中编辑值。不要更改ID列。
- 导入该文件。在映射中,检查ID列是否映射到全局 ID,并将Match existing entities by设为全局 ID。
- 在检查中,取消勾选Create a document…。
匹配的行计为已更新的条目,并列出每个已更改的字段。
- 点击Import N items。
此版本之前导出的文件中的 I_… 值不会匹配;请使用ID列。有关每个步骤和选项,请参阅导入和导出。
更新会写入的内容:
- 只写入已映射的列。缺少描述列时,每条现有描述保持不变。
- 文件中的标签会添加到现有标签中。
- 没有 Class 列时,按全局 ID 匹配的行保留其实体的类。
导入消息
| 留言 | 含义和解决方法 |
|---|---|
| 没有列映射到名称或编号。请映射其中之一。 | 至少将一列映射到名称或编号。 |
| 第 N 行:未知类“X”,改用 <class>。 | Class 值不匹配任何类。请修正该值,或将该列映射为“跳过”。 |
| 第 N 行:已忽略未知标签“X”。 | 请先在架构中创建该标签,或修正该值。 |
| 第 N 行:“<attribute>”不适用于类 <class>。 | 该行的类没有这个属性。 |
| 第 N 行:“<value>”不是“<attribute>”的有效 <type>。 | 该值无法读取为数字、日期、选项等。请检查日期格式选项。 |
| 第 N 行:名称超过 255 个字符,已被缩短。/ 第 N 行:编号超过 255 个字符,已被缩短。 | 名称和编号限制为 255 个字符。 |
| 编号 X 重复(第 A 行和第 B 行)。 | 两行共用一个编号;层级可能会将子条目挂到第一行下。 |
| 第 N 行:X 缺少父级编号 P;已挂到 Q 下。/ …;已在顶层导入。 | 直接父级编号不在文件中。 |
| 第 N 行:未找到父级编号 P。/ 第 N 行:未找到父级 P。 | Parent Number 或 Parent Row ID 引用了文件中不存在的行。 |
| 第 N 行:未找到“<relationship>”的目标“X”。 | 关系列指向一个不存在的实体。请检查Match related entities by。 |
| 第 N 行:架构不允许从 A 到 B 的“<relationship>”(仍已创建)。 | 尽管架构没有列出该关联,它仍被创建了。 |
| 架构不允许 A 与 B 之间的关系“X”;已跳过。 | 某个 ReqIF 或 XMI 关系无法创建,即使作为 traced to 也不行。 |
| 图片 X:不支持 .ext 图片,已跳过。要保留它,请在 Word 中将图片另存为 PNG 或 JPEG。 | Word 图片的格式不受支持。 |
| 图片 X(大小)超过 <limit> 的附件上限,已跳过。 | 图片大于单个文件上限。 |
| 未找到数据行。 | 文件或工作表只有标题,或为空。 |
| 无法读取文件:不支持 Excel 97-2003 (.xls) 文件。请在 Excel 中将文件另存为 .xlsx 或 .csv,然后重新导入 | 转换该文件。 |
| 无法读取文件:不接受带 DOCTYPE 或 ENTITY 声明的 XML。请去掉该声明后保存文件,然后重新导入 | 从 ReqIF 或 XML 文件中删除该声明。 |
| 无法读取文件:XML 无效 | 该 ReqIF 文件不是格式正确的 XML。 |
| 导入失败:<reason> | 导入已停止;未做任何更改。 |
需求快捷键
| 按键 | 位置 | Action |
|---|---|---|
| Enter | 文档快速输入 | 添加键入的需求。 |
| ⌘ / Ctrl+Enter / ⌥ / Alt+⌘ / Ctrl+Enter | 文档,已选中条目 | 添加同级条目 / 子条目。 |
| Enter 或 Space | 质量、TBD/TBR 和待审查的关联的行 | 在属性面板中显示该行的需求或待评审条目。 |
| ↑ / ↓ | 相同的行,行获得焦点 | 移到上一行或下一行。 |
| ⌘ / Ctrl-点击、⇧ / Shift-点击、⌘ / Ctrl+⇧ / Shift-点击 | 质量、TBD/TBR 和待审查的关联的行;数据库行;文档条目 | 切换一行,选择从上次点击的行起的范围,添加该范围。 |
| ⌘A / Ctrl+A, ⇧ / Shift+↑ / ⇧ / Shift+↓ | 相同的行,行获得焦点 | 选择显示的每一行;从获得焦点的行扩展选择。 |
| 右键点击、Shift+F10 或菜单键 | 需求、质量、TBD/TBR 和待审查的关联的行;文档条目和大纲条目 | 打开该行的菜单:先是建议操作及其原因和 ✦ More AI ▸,然后是条目的命令。 |
| Esc | 质量、TBD/TBR、待审查的关联、RVTM | 取消选择该行。 |
| Enter | 基线和版本的名称字段 | 创建项目基线。 |
| ⌘Z / Ctrl+Z | 任何位置 | 撤销上一次更改,包括整个导入、将关联标记为已评审或状态更改。 |
有关应用中的所有快捷键,请参阅键盘快捷键。
设置
| 设置 | 位置 | 默认 | 范围 |
|---|---|---|---|
| 文本更改时自动重新检查 | 质量页面范围栏 | 关闭 | 此浏览器 |
| 属性面板各组折叠或展开(质量及其他组) | 点击属性面板中某个组的标题,或其链接末尾的全部折叠 / 全部展开 | 质量折叠,其余展开 | 此浏览器,按类 |
| 审批、决定和评论上的您的姓名 | 您的账户名称 | — | 账户 |
| 追溯状态(需求上的圆点) | 文档视图 ▾ | 作用对象 | 文档 |
消息
| 留言 | 位置 | 含义 |
|---|---|---|
| 已检查 N 条需求 | 质量 | 检查已在该范围上运行。 |
| 此范围内没有需求。 | 质量 | 该范围没有需求。 |
| 此文档中没有要检查的 Requirement。Statement 不评分。 | 文档检查质量 | 将条目更改为 Requirement,或检查另一个文档。 |
| 已过期 — 重新运行 / 已过时 / 质量:已过期 — 重新运行 | 质量、文档、属性面板 | 上次检查之后文本已更改。 |
| Needs a reviewer’s judgment(需要评审人判断) | 质量(Correct、Feasible) | 必须由人来判定;点击 ✘ 标记为“是”。 |
| 已手动标记为“否”。 | 质量 | 评审人已将该准则设为“否”。 |
| N 项已审批需求已移到“评审中”;N 个关联已标记为待评审。 | 编辑之后 | 该编辑重新打开了审批,并将关联标记为待评审。 |
| 已审批 / 已拒绝 / 已移到“评审中” | 审批框 | 该决定已记录。 |
| 已将 N 个关联标记为已评审。 | 待审查的关联 | 评审已记录。 |
| 请先选择要标记为已评审的关联。 | 待审查的关联 | 在使用将所选项标记为已评审…之前勾选行。 |
| 已关闭 / 属性已关闭;文本仍包含 TBD。 | TBD/TBR | 该属性已设为 None。 |
| 文本仍包含 TBD。编辑文本以关闭。 | TBD/TBR | 关闭仅来自文本的条目时显示。 |
| 基线已保存 | 文档、基线和版本 | 快照已保存。 |
| 此文档没有基线。请先保存一个。 | 与当前比较、更改报告 | 该文档没有基线。 |
| 已恢复为“<name>”/ 已还原“<name>” | 基线 | 文档或项目已回滚;可以撤销。 |
| 没有要评审的需求。请先选择或打开需求。 | AI 需求检查 | 范围内没有需求。 |
限制
- 检查质量:范围内的每条需求都会与其他需求比较以查找重复项(75% 相似度阈值)。
- AI 需求检查:每次 AI 请求 20 条需求,并以最多 300 条其他需求作为上下文。
- 关联评审的差异保留旧名称的前 500 个字符和旧描述的前 4,000 个字符。
- TBD/TBR 燃尽图:最多 60 个点。
- 导入:
- 名称和编号最多 255 个字符。
- 预览显示前 500 行。列出前 50 条警告(“…and N more”)。
- 编号模式最多 6 级(“The numbering pattern has more than 6 levels. Use at most 6 markers.”)。
- ReqIF/XML 文件最多 1 亿个字符和 3,000,000 个元素。
- .reqifz 和 .docx 归档最多 10,000 个条目,每个条目 300 MB,总计 600 MB。
- 图片和原始 Word 文件只在单个文件附件上限内保留(Free 方案为 10 MB,Individual 为 25 MB,Team 为 100 MB)。