Holarch

需求

文档

编写、组织、编号、建立基线和发布规格说明,它们是模型的实时视图,支持模板、富文本、报告和 Word 输出。

使用方法 →

本页内容
  1. 概述
  2. 概念
    1. 什么构成一个文档
    2. 文档类型
    3. 数字
    4. 基线
  3. 如何使用
    1. 何时使用及原因
    2. 从模板创建需求规格说明
    3. 编写需求
    4. 快速添加大量需求
    5. 调整结构
    6. 评审、建立基线和发布
    7. 实例:CubeSat EO-1 演示
    8. 提示和良好做法
    9. 常见错误
    10. 与其他功能的关联方式
  4. 文档列表
  5. 文档页面
    1. 页面标题区
    2. 工具栏
    3. 大纲窗格
    4. 文档正文
    5. 右键菜单
    6. 快速添加
    7. 属性面板
  6. 添加条目
    1. 新条目
    2. 其他类
    3. 使用 Heading 的结构化文档
    4. 现有实体
  7. 调整结构
    1. 缩进、减少缩进和移动
    2. 拖放
    3. 移到下级
  8. 编号
    1. 自动重新编号
    2. 下一个编号的规则
    3. 重新编号
    4. 文档编号(元编号)
  9. 模板
    1. 内置模板
    2. 将文档另存为模板
    3. 管理模板
    4. 保存在此浏览器中的模板
    5. 将模板应用到现有文档
  10. 富文本编辑器
    1. 工具栏
    2. 表格
    3. 图像和文件
    4. 替代文本
    5. 链接和嵌入链接
    6. 动态内容
    7. AI 文本工具
    8. 粘贴
    9. 富文本快捷键
  11. 在文档中查找
  12. 查找和替换
  13. 编写菜单
    1. 为此分支设置属性
    2. 拆分为多个条目
  14. 检查菜单
    1. 追溯状态
    2. 查找缩略语
  15. 交付菜单
    1. Word 模板
    2. 公司 Word 文件
  16. 视图菜单
  17. 基线
    1. 创建基线
    2. 查看基线
    3. 比较版本
  18. 报告
  19. Word 输出
    1. 题注、目录和交叉引用
    2. 交付物设置
    3. 页面格式
    4. 富文本转换
    5. 修订标记
    6. 打印 / PDF
  20. 评论
  21. 汇编
    1. 生成的章节
    2. Word 中的汇编
  22. AI 工具
  23. 键盘快捷键
  24. 此浏览器中记住的设置
  25. 消息
  26. 限制
  27. 相关内容

概述

文档是规格说明、计划或规程,其章节和需求都是模型中的实体。使用文档页面编写和调整它们的结构、为它们编号、建立基线,并将它们发布为 Word、Excel、ReqIF、Markdown 和其他格式。

文档中的每个条目都是一个实体。因此,同一条需求也会出现在数据库、图、可追溯性矩阵和质量检查器中。在其中任何一处所做的编辑都会显示在文档中。

概念

什么构成一个文档

  • 文档是满足以下两个条件之一的 Artifact 实体:
    • 它带有文档类型标签:名称以“Document”结尾的任何标签。
    • 它是至少一个 Statement 或 Heading 的 source of。
  • 其顶层条目是该文档作为 source of 的实体。更深层的条目通过 decomposed by 关系挂在它们下面。您看到的大纲就是这棵分解树。
  • 条目通常是 Statement(章节、标题、注释、假设)和 Requirement(及其子类)。使用其他类…可添加任何其他类。
  • Heading(LML 2.0 结构化文档)是可容纳任何类条目的章节。子章节是位于 Heading 下的 Heading(decomposed by)。Heading 下的任何其他条目都是该章节的内容:Heading contains 它,它保留自己的编号,并列在子章节之前。请参阅使用 Heading 的结构化文档。
  • 从文档中移除条目不会删除该实体。从数据库中删除才会删除。

文档类型

类型是文档的文档类型标签。它决定首先提供哪些模板,以及文档是否以纸张模式打开。

类型内置模板
Requirements DocumentRequirements Specification;Stakeholder Requirements Specification (StRS);System Requirements Specification (SyRS);Software Requirements Specification (SRS);Interface Requirements Specification (IRS)
Interface Control DocumentInterface Control Document (ICD)
Concept of Operations DocumentConcept of Operations
Needs Analysis DocumentNeeds Analysis
Concept Exploration DocumentConcept Exploration;Trade Study Report
Concept Definition DocumentConcept Definition;Architecture Description
Systems Engineering Management Plan DocumentSystems Engineering Management Plan
Test Plan DocumentTest Plan;Verification and Validation Plan;Test Procedure;Test Report
Independent Verification & Validation Plan DocumentIV&V Plan
Project Management Plan DocumentProject Management Plan;Risk Management Plan;Configuration Management Plan
Integrated Logistics Support Plan DocumentIntegrated Logistics Support Plan
Standard Operating Procedure DocumentStandard Operating Procedure

其他类型的模板列在其他模板下,因此任何模板都可以用于创建任何文档。

要添加文档类型,请为 Artifact 类添加一个名称以“Document”结尾的标签(请参阅架构扩展)。标为评审包的文档会汇编其他文档;请参阅汇编。

数字

每个条目都有一个编号,例如 3.2,显示在其名称之前。编号存储在实体上,因此同一条需求在各处显示相同的编号。例外是文档编号,它为每个文档保留单独的编号。

在添加或移动条目后自动重新编号开启时(默认开启;该复选框位于编写 ▾ → 重新编号…中),Holarch 会为您保持编号有序。

基线

基线是文档的只读快照。它保存:

  • 文档的条目、其属性及其关系,包括指向文档外一步之遥的实体的关联。
  • 文档的设置。
  • 带日期的审批记录,之后无法编辑。

基线为更改报告以及 Word 输出中的修订历史和审批表格提供数据。

在托管服务上:

  • 每条审批记录使用服务器的时间和保存它的账户,而不是浏览器的时钟。记录显示“(server time) · recorded by {name}”,保存操作会写入审计日志。
  • 只有项目所有者可以重命名或删除基线。对其他人,删除和名称字段会变灰,并显示“Only a project owner can rename or delete a baseline.”还原和恢复照常可用。

在桌面应用中,记录带有您的计算机保存它们时的日期。

如何使用

何时使用及原因

当交付物是有人要阅读、评审和签署的规格说明时,请使用文档。例如:

  • 用于 SRR 的系统需求规格说明。
  • 概念开发早期的运行概念。
  • 验证开始前的测试计划。
  • 用于运行的规程。

在这里编写需求,然后在模型的其他地方将它们追溯到功能、资产和测试。文档回答的问题是:“此规格说明讲了什么、按什么顺序,以及自审批以来发生了哪些变化?”

在系统工程流程中,文档最先出现:利益相关方需要和系统需求。它们为功能分析和分配提供输入。在评审时,它们作为已建立基线、已审批并附带可追溯性报告的输出再次出现。

从模板创建需求规格说明

  1. 在导航栏中,打开需要与需求 → 文档。
  2. 点击页面标题中的+ 新建文档。

    随即打开新建文档。

  3. 输入名称(必填)。编号和描述可以稍后在属性面板中添加。
  4. 在模板下,模板适用于显示一种文档类型的模板,例如Requirements Document。每张卡片以预览形式显示前几个章节。选择以下之一:
    • 空白:所示类型的空文档。
    • 组织模板中的一项(Holarch 服务器,托管或自托管),由您组织的管理员发布。会预先选中组织为该类型设定的默认模板。
    • 项目模板中的一项,保存在此项目中。
    • 内置模板中的一项。
    • 其他模板下另一种文档类型的模板。

      文档采用所选模板的类型。

  5. 选择包括编写指南,可为内置模板的每个章节添加简短的编写指南。
  6. 点击创建。

    文档打开时带有模板的编号章节,例如 1 Document Control、1.1 Revision History、1.2 Approvals、2 Introduction … 如果包括了编写指南,请在编写每个章节时将其删除。

编写需求

  1. 点击章节行将其选中。
  2. 点击+ 子条目,或按 ⌥⌘↵ / Ctrl+Alt↵。

    出现一个名为“New Requirement”的新行及其编号,其名称可直接键入。

  3. 键入名称并按 Enter。
  4. 点击描述并编写“shall”陈述。
  5. 按 ⌘↵ / Ctrl↵ 或点击其他位置以保存描述。
  6. 要在同一级别添加下一条需求,请再次按 ⌘↵ / Ctrl↵。

+ 新建 …(页面标题)将条目添加到文档末尾;+ 之后和+ 子条目将其添加到所选条目旁边(+ 新建 …的工具提示会说明这一点)。三者都会添加您上次从其 ▾ 菜单中选取的类(默认为 Requirement)。此浏览器会记住该选择。

快速添加大量需求

使用文档底部的快速添加逐条键入需求。

  1. 在快速添加栏中,选择章节,例如Under 4 Command and Data Handling。
  2. 键入需求文本。
  3. 按 Enter。

    Holarch 会添加该需求,并以“shall”之后的单词为其命名。光标留在字段中,以便输入下一条。

调整结构

可以用按键、拖动或右键菜单更改大纲。自动重新编号开启时,每次移动后编号都会更新。

  • 使用按键:选择一行,然后按:
    • ⌥⇧→ / Alt+Shift+→ 将其缩进到上方条目之下。
    • ⌥⇧← / Alt+Shift+← 减少其缩进。
    • ⌥ / Alt+↑ 或 ⌥ / Alt+↓ 在同级条目之间移动它。
    • Tab 不用于缩进,因此它始终移到下一个字段。
  • 通过拖动:在大纲窗格中拖动行。放在某一行的上边缘或下边缘,可将条目放在该行之前或之后。放在中间可使其成为子条目。
  • 通过菜单:右键点击该行并选择Move Under ▸,然后从列表中选取新的父级(键入可筛选)。子条目随之移动。

评审、建立基线和发布

  1. 选择检查 ▾ → 检查质量,修正较弱的需求(请参阅需求)。
  2. 选择检查 ▾ → 追溯状态…,关联尚未分配或验证的需求。
  3. 在检查 ▾ → TBD/TBR 登记册中清理未关闭条目。
  4. 评审检查 ▾ → 待审查的关联。
  5. 在标题栏中,点击版本 ▾并选择保存基线…。
  6. 输入名称,例如“SRR Baseline”。
  7. 为每位审批人添加一行审批,包含姓名、角色和声明。
  8. 点击创建。

    基线显示在版本 ▾中,按钮会将其显示为最新基线。

  9. 点击交付 ▾ → 规范 (Word)。

    Word 文件会按 Specification 模板的选项下载,包括根据基线填写的修订历史和审批表格。

  10. 在 Word 中打开该文件,并接受更新域的提示。

    目录随即填好。

要在建立基线之前让文档接受评审,请点击文档类型旁边的请求评审。项目的评审人会在我的工作的待评审的文档下找到它,并在那里或在标题下方的评审条中审批或拒绝。

之后再编辑时,查看更改了什么:

  1. 点击版本 ▾ → 比较版本…。
  2. 在从下选择该基线,在到下选择当前版本。

    报告列出每项添加、移除和编辑。点击更改 (Excel)下载报告,或点击修订标记版 (Word)获取带修订的 Word 文件。

实例:CubeSat EO-1 演示

从管理项目 → 项目文件 ▾ → 新建演示项目创建演示项目。然后打开需要与需求 → 文档 → EO-1 System Requirements Specification(编号 SRS-001)。

阅读结构。六个章节容纳这些需求:

  • 1 Mission Imaging
  • 2 Attitude Determination and Control
  • 3 Electrical Power
  • 4 Command and Data Handling
  • 5 Communications
  • 6 Ground Segment and Operations

需求 1.6 Revisit Time 有两个子条目:1.6.1 Ground Track Repeat 和 1.6.2 Off-Nadir Imaging。质量评分列显示进度条。2.5 Safe Mode Recovery 和 6.4 Operator Interface 得分较低。

修正较弱的措辞:

  1. 按 ⌘F / Ctrl+F 并键入 should。

    计数器显示匹配项。

  2. 按 Enter,直到 2.5 被标记。

    其文本为“The spacecraft should recover from safe mode quickly and resume imaging as appropriate”。

  3. 改写它,例如“The spacecraft shall resume imaging within 24 hours of a safe mode entry.”

    在再次运行检查之前,得分列会显示已过时标签。

拆分复合需求:

  1. 选择 6.4 Operator Interface(“…shall be user friendly and/or easy to use.”)。
  2. 右键点击它并选择拆分为多个条目…。
  3. 点击✦ 建议拆分。

    每行得到一条可测量的需求。

  4. 取消勾选您不需要的行,或点击Join将某行与下一行合并,然后点击应用。

快速添加需求:

  1. 在快速添加中,选择Under 3 Electrical Power。
  2. 键入“The EPS shall provide a 5 V regulated bus within 3%.”并按 Enter。

    它被添加为 3.7,名为“Provide A 5 V Regulated”。

查看自 SRR 以来更改了什么:

  1. 点击标题栏中的版本 ▾并选择SRR Baseline。

    横幅显示“Baseline “SRR Baseline”, read-only, saved {date}”。审批人为 J. Rivera(Systems Lead)、R. Okafor(Mission Principal Investigator)和 L. Brandt(Program Manager)。

  2. 点击与当前比较。

报告列出:

  • 3.1 Orbit Average Power:描述从 28 W 改为 30 W,并有新的理由。
  • 2.4 Target Slew:状态 草稿 → 评审中。
  • 新增的 4.4 Downlink Encryption,及其两个新的 satisfies 关联。
  • 您在本次会话中所做的编辑。

发布:

  1. 点击返回当前。
  2. 点击交付 ▾ → 规范 (Word)。

    Word 文件以标题和“Requirements Document · No. SRS-001”开头。随后是 SRR Baseline 的一行修订历史(“Initial baseline”)和三项审批,然后是编号的需求。

提示和良好做法

  • 每行写一条需求,只含一个“shall”。拆分为多个条目…和质量检查有助于保持需求的单一性。
  • 章节保持为 Statement,需求保持为 Requirement。质量检查只为 Requirement 评分。仅含需求的报告(RVTM、VCRM、RTM)会跳过 Statement。
  • 在每次评审之前和大规模改写之前建立基线。恢复和更改报告都依赖于它。
  • 点击一行会将其选中。要编辑,请点击字段本身,或在所选行上按 Enter 或 F2。
  • 使用视图 ▾ → 纸张像阅读页面一样阅读文档,不显示属性列。将其关闭可在列中编辑属性。
  • 留意追溯状态圆点:需求的圆点为绿色时,即可进行评审。

常见错误

  • 添加功能变灰。筛选或排序处于活动状态(工具栏中显示已筛选视图:无法编辑。清除筛选),或您正在查看基线。点击该警告,或点击返回当前。
  • 移动后编号跳变。自动重新编号会重写同级组的编号。要保留手动设置的编号,请在编写 ▾ → 重新编号…中清除添加或移动条目后自动重新编号,或锁定编号不得更改的条目。
  • 移除了条目,但它仍在数据库中。移除只会将其从文档中取出。要删除它,请在随后出现的消息中选择删除条目…,或按住 ⇧ / Shift 点击移除,或按 ⇧Delete / Shift+Delete。
  • 字母或罗马数字编号变成了十进制。自动重新编号和重新编号…会生成十进制编号(1、1.1、1.1.1)。要保留以字母编号的附录,请关闭自动重新编号并手动编号。

与其他功能的关联方式

  • 输入:
    • 导入可从 Word、Excel、CSV、ReqIF、XMI 和文本创建文档。
    • 模板创建骨架。
    • AI 生成器添加需求。
  • 输出:
  • 其他所有地方:每个条目都是一个实体。它出现在数据库、条目视图以及 Spider 图和树图等图中。

文档列表

文档列表以卡片形式显示项目中的每个文档,与图页面使用相同的图库。使用需要与需求 → 文档打开它。

每张卡片显示:

  • 文档大纲的缩略图。
  • 名称、类型以及上次编辑的时间(对文档或任何条目的最新更改)。
  • “N 个条目 · N 条需求”。
  • 需求有得分时,显示平均质量 N%。
  • N 个 TBD/TBR:未关闭条目。
控件功能
搜索文档…显示名称、编号或描述包含该文本的卡片。
排序最近编辑(默认)、编号(大纲顺序)、名称、类。
类型标签全部,以及每种文档类型一个标签及其数量。
显示更多 (N)显示更多卡片。
导入(页面标题)打开导入页面(导入和导出)。
+ 新建文档(页面标题)打开新建文档。
卡片上的⋯Open、Open in ▸ 条目视图、创建副本…和删除…。

删除…会打开删除文档:“删除“…”。其 N 个章节作为条目保留在项目中。”当某些章节不在任何其他文档中时,Also delete the N sections that no other document uses也会删除它们。撤销可恢复全部内容。

点击卡片即可打开文档。

地址 documents/<id> 会直接打开文档。添加 ?baseline=<id> 或 ?baseline=latest 可打开基线,添加 ?find=<text> 可开始搜索,添加 ?comments=1 可在属性面板中显示文档的评论。

文档页面

文档页面以大纲和表格显示一个文档,所选条目显示在属性面板中。

  • + 新建 {Class}在文档末尾添加一个当前类的条目。其▾会打开类菜单:
    • 添加现有条目…。
    • 插入文档…和插入生成的章节…(仅限汇编)。
    • 在标题添加到末尾下:每个 Statement 类和标题(当前类带 ✔),以及其他类…。
  • ✦ AI ▾(位于顶栏)包含文档的 AI 工具(请参阅AI 工具)。

工具栏

控件功能
+ 之后在所选条目之后的同一级别添加一个条目(⌘↵ / Ctrl↵)。其 ▾ 提供添加现有条目…、Add Child (⌥⌘ / Ctrl+Alt↵),以及在所选条目之后添加下的类列表。
+ 子条目为所选条目添加一个子条目(⌥⌘↵ / Ctrl+Alt↵)。其 ▾ 提供添加现有条目…以及添加子条目下的类列表。
⇤ / ⇥减少所选条目的缩进(⌥⇧← / Alt+Shift+←)/ 缩进所选条目(⌥⇧→ / Alt+Shift+→)。
↑ / ↓在同级条目之间上移或下移所选条目(⌥ / Alt+↑ / ⌥ / Alt+↓)。
移除将所选条目及其子树一次性从文档中取出(Delete 的作用相同)。已从文档中移除。提供撤销和删除条目…。按住 ⇧ / Shift 点击或按 ⇧Delete / Shift+Delete,会在确认(列出要删除的内容)之后删除这些条目及其子条目。Esc 或属性面板的×会清除选择。
编写 ▾添加、插入、生成和编辑内容(请参阅编写菜单)。
检查 ▾此文档的质量、模型检查、追溯状态、待审查的关联、TBD/TBR 和评论,附带计数(请参阅检查菜单)。
交付 ▾交付物和页面设置、Word 模板、版本以及按输出分组的导出(请参阅交付菜单)。
视图 ▾此文档的直接开关:纸张、大纲窗格、追溯状态和列(请参阅视图菜单)。
已筛选视图:无法编辑。清除筛选在类或标签筛选或列排序开启时出现。点击可清除它们。
查找打开搜索框(⌘F / Ctrl+F)。

以下情况下结构按钮会被禁用:

  • 未选择任何内容。
  • 所选条目已锁定。
  • 筛选或排序处于活动状态。
  • 您正在查看基线。

大纲窗格

左侧的大纲窗格显示文档的层级,顶部有一个筛选器。没有标签页:基线位于标题栏的版本 ▾中,评论在属性面板中打开。

  • ‹隐藏该窗格,左边缘的›再次显示它(也可使用视图 ▾ → 大纲窗格)。
  • 拖动其右边缘可调整大小(180 至 500 px)。
  • 选择条目会在窗格旁打开属性面板;窗格保持打开。
  • 当窗格和文档的总宽度小于 900 px 时(按属性面板打开计算,因此选择条目不会改变它),窗格会折叠起来。之后可从›以浮层形式打开它。点击外部即可关闭。

窗格顶部的筛选:

  • 筛选大纲将大纲缩小到编号或名称包含该文本的条目,包括已折叠的条目。它们的父级以变暗方式保留在大纲中,作为上下文。它不会筛选文档。
  • 类标签,文档中每个类一个,附带数量(文档含多个类时显示)。点击某个标签可在文档中只显示该类及其子类;再次点击可显示所有类。右键点击标签可选择{Class} 及其子类、仅 {Class}和清除类筛选。
  • 标签筛选项,文档中使用的每个标签一个,附带数量。点击这些筛选项可只显示带有所有所选标签的条目。要显示带有多个标签中任一标签的条目,请使用数据库查询。
  • 超过六个筛选项时,它们会折叠到Filter by Class or Label (n)后面;折叠时只有正在生效的筛选项保持可见。减少筛选会再次折叠它们。此浏览器会记住该选择。
  • 筛选或排序开启时会出现清除筛选。筛选后的行保留其缩进。筛选或排序开启时无法编辑。

大纲:

  • 每个条目都有其色块、编号和名称,锁定时显示 🔒,以及 ▾/▸ 开关。
  • 点击某一项可选中该条目并滚动到它。
  • 拖动可重新排序(请参阅拖放)。无效的放置目标会被标记并拒绝:条目不能放到其自身的子条目下、已锁定的条目下,或无法被它 decomposed by 的类下。
  • 视图中文档部分对应的行会突出显示,大纲随文档一起滚动。当您指向它、在其中操作或在最近两秒内滚动过它时,它会停在原处。
  • 无法容纳的深层级会显示 L{n} 级别标记,而不是更多缩进。

文档正文

正文以标题栏开头:文档的类型和标签、条目数量、开启文档编号时的“按文档编号”、💬 n 条未解决评论(有评论时;请参阅评论)以及版本 ▾(请参阅基线)。版本 ▾显示当前版本、当前 · 最新基线 {name}或基线:{name}。其下方为:

  • 编号和标题:点击可编辑文档编号和名称,或按 Tab 移到它们并按 Enter 或 F2。
  • 文档描述:点击可在富文本编辑器中编辑,或按 Tab 移到它并按 Enter 或 F2。
  • 表格。Entity 列包含每个条目:开关、编号、名称、徽标和描述。其他列是在视图 ▾ → 列 ▸中选择的属性列:在您更改之前为状态、验证方法和质量评分。纸张视图没有属性列。

每一行显示:

  • ▾/▸,用于折叠或展开其子条目。
  • 编号和名称。点击可编辑,或按 Tab 移到其中之一并按 Enter 或 F2。Enter 保存,Esc 取消;焦点保留在字段上。粘贴的换行会变为空格。
  • 徽标:
    • 🔒:条目已锁定。
    • ⚡:条目带有指南。指向它即可阅读。
    • 💬 n:未解决的评论。点击可在属性面板中打开。
    • ⚠ 评审:上游需求已更改。
    • 类徽标。
    • 追溯状态圆点(仅限需求;请参阅追溯状态)。
  • 描述,在富文本编辑器中编辑。
  • 左边缘的彩色条:自最新基线以来未更改时为蓝色,新增或已更改时为琥珀色。
  • 属性单元格:
    • 标签显示为标签块,×用于移除,+用于添加。菜单列出该类允许的标签,或显示“No more labels”。
    • 文本属性就地编辑。其他属性使用其类型的编辑器。
    • 质量评分显示彩色条:67% 及以上为绿色,34% 至 66% 为琥珀色,以下为红色。上次检查后文本已更改时,它会显示带时钟图标的已过时标签;指向它可查看原因。
    • “—”表示该类没有此属性。

排序和列宽:

  • 点击列标题按升序排序,再次点击按降序排序,第三次点击关闭排序。
  • 排序会平铺列出条目,不显示层级,并暂停编写。
  • 拖动标题的右边缘可调整列宽。Entity 列至少 300 px 宽,其他列至少 80 px。列宽按文档保存在此浏览器中。
  • 顶层章节之间以空白间隔行分隔。

选择行:

  • 点击一行将其选中。点击只会选择;要编辑,请点击字段,或在行上按 Enter 或 F2。
  • 要取消选择,请点击表格下方的空白处、按 Esc 或点击✕。
  • ↑ 和 ↓ 在行之间移动选择。
  • ⌘ / Ctrl-点击(在 Windows 和 Linux 上为 Ctrl-点击)将条目添加到选择中或从中移除。
  • ⇧ / Shift-点击按显示顺序(含任何排序或筛选)选择从上次点击的条目到此条目的范围。⌘ / Ctrl+⇧ / Shift-点击将该范围添加到选择中。
  • 在获得焦点的条目上(非编辑状态)按 ⌘A / Ctrl+A 会选择显示的每个条目。⇧ / Shift+↑ 和 ⇧ / Shift+↓ 从获得焦点的条目扩展选择。
  • 相同的手势在大纲中也有效。工具栏显示数量(“已选择 21 个”)。普通点击或 Esc 会恢复为单个条目。
  • 在您正在编辑的字段中点击时保持文本行为:在那里按住 ⇧ / Shift 点击会扩展文本选择。

右键菜单

右键点击文档中的条目(其编号、名称、徽标或它们周围的空白)或大纲中的某一项,可在指针处打开其菜单。使用键盘时,将焦点移到该行或大纲项,然后按 Shift+F10 或菜单键;菜单在条目处打开,Esc 将焦点返回该处。在触摸屏上,按住该条目。该条目成为所选内容。

菜单开头最多有三个根据条目状态挑选的建议操作,每个操作的原因显示在右侧:例如✦ Add Measurable Criteria…(未通过:Unambiguous)、✦ 生成测试用例…(未验证)、检查链接…(上游已更改)或Resolve TBD…(未关闭的 TBD)。没有需要修正的内容时,它会建议✦ Check with AI…和✦ Ask AI About This…。✦ More AI ▸列出该条目的所有 AI 操作。规则和完整列表见模型和数据库。每个 AI 操作都会先显示结果供评审,然后才做任何更改。AI 关闭时,AI 部分是一个变暗的行,并说明原因。

分隔线之后的命令。命令右侧显示的按键可从键盘执行相同操作(请参阅键盘快捷键):

命令功能
转到仅限大纲。将文档滚动到该条目并将焦点移到它(在大纲项上按 Enter)。
打开打开条目视图。
重命名…更改名称。在文档中获得焦点的条目上按 F2 可就地编辑名称。
Add {class} After在此条目之后添加一个当前类的条目,与+ 之后相同(⌘↵ / Ctrl↵)。
Add Child {class}在此条目下添加一个当前类的条目,与+ 子条目相同(⌥⌘↵ / Ctrl+Alt↵)。
缩进、减少缩进与工具栏中的⇥和⇤相同(⌥⇧→ / Alt+Shift+→ 和 ⌥⇧← / Alt+Shift+←)。
上移、下移与工具栏中的↑和↓相同(⌥ / Alt+↑ 和 ⌥ / Alt+↓)。
状态 ▸、优先级 ▸设置该属性;当前值带勾选标记。
关联到 ▸先列出该类最常用的关系,然后是All Relationships ▸,包含该类允许的所有关系。选择其中一个会打开目标实体选择器。
在图中显示 ▸列出可以显示该条目的图类型;选择其中一个即可打开。
复制链接复制指向该条目的条目视图的链接。
复制编号复制该条目的编号。
Open In ▸条目视图、History…、可以显示该条目的图(Hierarchy、Tree、Spider、Action、Asset、Risk、Timeline)、可追溯性矩阵、需求质量和功能分析。
Move Under ▸可容纳此条目的条目列表(可键入筛选),按文档顺序缩进;条目有父级时还有文档顶层。子条目随之移动。
拆分为多个条目…请参阅拆分为多个条目。
更改类…打开更改类(与数据库中的对话框相同;请参阅模型和数据库)。
从此处重新编号…为此条目、其后的同级条目及其子条目打开重新编号。
为此分支设置属性…请参阅为此分支设置属性。
锁定 / 解锁锁定条目以防编辑,或将其解锁。
Remove from This Document将条目及其子条目从文档中取出(Delete)。实体保留在项目中;消息提供撤销和删除条目…。
删除条目…确认后删除条目及其子条目(⇧Delete / Shift+Delete)。

每个命令都可通过一次撤销撤回。无法应用的命令会变暗,其工具提示会说明原因:

  • 在基线中,或只有查看权限时,只有转到、Open、Show in Diagram ▸、复制链接和Copy Number可用。在基线中,建议和 ✦ AI 操作也会变暗。
  • 在已锁定的条目上,重命名…、Status ▸、Priority ▸、Relate To ▸、移动操作和删除条目…会变暗。
  • 筛选或排序处于活动状态时,添加和移动会变暗(“Clear the filter or sort first”)。
  • 会将条目移过其所在级别开头或末尾的命令会变暗(例如第一个条目上的上移)。

选择了多个条目。右键点击所选内容中的条目会作用于所有所选条目。菜单显示已选择 N 个,并提供 ✦ 批量操作(✦ Check with AI (n requirements)…、✦ Rewrite (n) ▸、✦ Generate Test Cases (n)…、✦ Ask AI About These (n)…、✦ Suggest Traces (n)…;请参阅对多个所选条目使用 AI)、Set Status ▸、Set Priority ▸、Add to Document ▸、Remove n from This Document和Delete n Items…(需确认;所选条目的子条目随之一起删除)。针对单个条目的命令(转到、Open、重命名…、添加、缩进和移动)仍会列出但变暗,原因为“Acts on one entity”。每个命令都是一个撤销步骤。右键点击所选内容之外的条目会使其成为唯一的所选条目。

描述以及您正在编辑的任何字段保留浏览器自身的菜单,因此您可以在那里复制、粘贴和检查拼写。按住 ⌥ / Alt 右键点击可在任何位置显示浏览器的菜单。

快速添加

快速添加让您无需使用工具栏即可连续键入需求。文档下方的栏包含快速添加、章节列表、文本字段和添加。章节列表提供文档末尾,以及每个顶层章节的Under {number name}。

键入一条需求,然后按 Enter 或点击添加。新条目获得:

  • 当前类。
  • 该文本作为其描述。
  • 由“shall”、“must”、“will”或“should”之后的前几个单词构成的名称:最多五个单词,首字母大写。

该字段最多接受 2,000 个字符。筛选或排序开启时,该字段显示“Clear the filter or sort to add entities”。

属性面板

所选条目在右侧的属性面板中打开,带有完整的实体面板(请参阅模型和数据库)。

  • 在文档中,decomposed by 和 decomposes 关系在那里是只读的,因为它们由大纲控制。
  • 标题中的×(Esc)清除选择。视图 ▾ → 折叠子条目会折叠所选条目下的章节。
  • 已锁定的条目以只读方式打开。

添加条目

新条目

  • + 新建 {Class}添加到末尾。
  • + 之后添加到所选条目之后。
  • + 子条目添加为所选条目的最后一个子条目,父级随之展开。
  • 没有选择时,+ 之后和+ 子条目添加到末尾。

新条目名为“New {Class}”。它会被选中,其名称打开供编辑。

其他类

其他类…会打开将条目添加到文档,含类(任何类)和名称。用于非 Statement 条目,例如测试计划中的 Asset 描述或 Test Case。

使用 Heading 的结构化文档

Heading是文档的一个章节(LML 2.0 的结构化 Artifact 方法)。当一个章节混合多个类(例如需求、动作和风险),或同一条需求出现在多个文档中时,请使用 Heading。

  1. 在类菜单(+ 新建 ▾、+ 之后 ▾或+ 子条目 ▾)中选择标题。位于顶层的 Heading,文档是它的 source of;位于另一个 Heading 下时,它是一个编号的子章节。
  2. 选择该 Heading 并使用+ 子条目 ▾添加其内容:任何类的新条目,或添加现有条目…。Heading contains 该条目。
  3. 内容保留自己的编号:添加、移动和重新编号…会为 Heading 编号,而内容的编号保持不变,因此像 RQ.CLN.1 这样的需求在每个文档中显示相同。章节内容列在子章节之前。

将内容移到另一个 Heading(拖动、Move under ▸)会移动其 contains 关联。模型检查会将 Heading 所包含的需求计为已放入文档。

要记录需求的来源,请使用 originated by 将其关联到来源 Artifact(属性面板 → 关系;该 Artifact 会在 originates 下列出它)。在引入 Heading 之前创建的项目保留其架构;架构 → Add New Built-ins…会添加 Heading、contains 和 originates。

CubeSat EO-1 演示中的示例:EO-1 System Requirements Specification的章节7 Applicable Documents是一个 Heading。其内容是两项项目标准,它们保留编号STD-1和STD-2。STD-1是需求3.4 Bus Regulation的来源(originates),STD-2是5.2 UHF Command Uplink的来源。

现有实体

添加现有条目…会打开实体选择器。选择器不包括该文档及其当前条目。实体会连同其整个分解结构一起添加。带有子条目时,提示消息显示“Added {entity} with N child entities”。

调整结构

缩进、减少缩进和移动

  • 缩进使条目成为其上方同级条目的最后一个子条目。组中的第一个条目无法缩进。
  • 减少缩进使条目成为其父级的下一个同级条目。
  • 上移/下移将条目与其相邻条目交换。已锁定的条目和已锁定的相邻条目不会移动。
  • 无法移动时,提示消息显示“The selected entity cannot move further that way.”

拖放

在大纲窗格中拖动。拖到其顶部或底部边缘附近时列表会滚动。放置位置决定结果:

  • 行的上部 28%:条目放在该行之前。
  • 行的下部 28%:条目放在该行之后。
  • 行的中间:条目成为其子条目。
  • 顶部的文档名称:条目成为末尾的顶层条目。

移到下级

右键点击一个条目并选择Move Under ▸。列表包含可将其作为子条目的条目,按文档顺序缩进;条目有父级时还有文档顶层。键入以筛选列表,然后选择新的父级。子条目随之移动;提示消息显示“Moved {item}”。

该列表不包括条目自身的子树、其当前父级、已锁定的条目以及架构不允许的父级。移动失败时,消息显示“The item cannot move there: the new parent is inside it, or the item is locked. Choose another parent or unlock it.”

编号

自动重新编号

添加或移动条目后自动重新编号默认开启;可在编写 ▾ → 重新编号…中更改。开启时,以下操作会为受影响的同级组及所有后代重新编号:添加、移动、缩进、减少缩进、移除和拆分。

  • 顶层条目使用文档的编号模式加上连续编号。它从文档的起始编号开始:除非在重新编号…中更改,否则为 1。
  • 子条目使用其父级的编号、一个句点和连续编号(3、3.1、3.1.1)。
  • 已锁定的条目和术语表条目(标为 Acronym 的条目,其编号即术语)保留其编号,但仍占据一个位置。

关闭时:

  • 新条目获得其前一条目之后的下一个编号。第一个子条目获得父级的编号加 .1。
  • 现有编号不变。
  • 移动条目只会为移动的子树重新编号。
  • 上移/下移会交换两个编号。

下一个编号的规则

为了延续序列,Holarch 会递增前一个编号的最后一部分。它保留分隔符以及末尾的句点、冒号或括号。

  • 数字:1.9 → 1.10,2. → 3.
  • 字母:a → b,z → aa,Z → AA,Appendix A → Appendix B
  • 两个或更多字母的罗马数字:IV → V,IX → X。单个字母按字母处理(I → J)。
  • 其他情况会追加 .1。

重新编号

编写 ▾ → 重新编号…一步为整个文档重新编号。条目右键菜单中的从此处重新编号…会为该条目、其后的同级条目及其所有子条目重新编号。

该对话框包含:

  • 模式:{n} 是位置,{n:3} 将其补齐为三位数。SYS-{n:3} 生成 SYS-001、SYS-002;其子条目在其下编号为 SYS-001.1、SYS-001.2。不含 {n} 的模式会在末尾加上编号。从条目打开时,模式和起始编号会根据其编号预先填入。
  • 起始编号(仅限数字)。其他输入会显示“Enter the first number as digits, for example 1.”
  • 一个预览表格,含条目、当前和New(已更改的编号会突出显示;最多 400 行),以及诸如“12 of 40 numbers change.”的计数。
  • 添加或移动条目后自动重新编号(仅限整个文档)。
  • 说明“Locked items keep their numbers. A single Undo takes back the whole renumbering.”术语表条目也保留其编号。
  • 重新编号。提示消息显示“Document numbers updated”。

对整个文档运行时会将模式和起始编号随文档保存。之后的自动重新编号会使用它们。

文档编号(元编号)

文档编号为每个文档保留单独的编号。当同一条需求以不同编号出现在两个文档中时,请使用它。

使用交付 ▾ → 交付物设置… → 编号 → Document numbers (kept in this document only)开启它。模型编号(条目自身的编号)会将其关闭。

  • 开启时,每个条目的当前编号会复制到文档中。
  • 从此以后,编号编辑只会更改此文档。
  • 开启期间,标题栏显示“· 按文档编号”。
  • 导出和报告使用文档编号。

模板

模板来自四个地方。新建文档和使用模板按以下顺序列出它们,此文档类型的模板排在前面:

组保存位置谁可以添加或更改
组织模板:{name}在 Holarch 服务器上(托管或自托管),供组织使用组织管理员
项目模板在项目文件中;项目的每位成员都能看到项目所有者(在桌面应用中:任何打开该项目的人)
内置模板在 Holarch 中无人
已保存在此浏览器中仅在此浏览器中(版本 1.8.0 之前保存的模板)将其导入项目

内置模板

每个内置模板都有编号的章节和起始表格(例如修订历史和审批表格)。选择包括编写指南后,每个章节还会以简短的编写指南开头。

新建文档会显示每个模板的章节数量,例如 Requirements Specification 为“39 sections”。

这些模板遵循每类文档常见的系统工程实践:利益相关方、系统、软件和接口需求规格说明,接口控制文档,架构描述,验证和确认、测试和风险计划,测试规程和报告,权衡研究以及配置管理。

许多章节包含动态块,每当显示或导出文档时都会根据模型更新:

块包含于
文档自身需求的 VCRM、按级别的 VCRM、RVTM 和 RTM需求规格说明(Verification 和 Traceability 章节)
整个项目的 VCRM 和 RVTMTest Plan、Verification and Validation Plan、Test Procedure、Test Report
接口矩阵和管道列表Interface Control Document、Architecture Description
分配矩阵(功能到组件)Concept Definition、Architecture Description
标为 Acronym 的陈述每个 Acronyms 章节
标为 Reference 的 Artifact每个 References 章节
风险;Trade Study ArtifactRisk Management Plan;Trade Study Report

覆盖“this document”的矩阵会指向新文档。对于 Test Report,请使用Insert ▸ 矩阵… ▸ Test Report添加某个测试周期的结果,并选择测试套件和周期。

将文档另存为模板

将文档的结构另存为模板,以便从它开始创建新文档。

  1. 选择编写 ▾ → Templates ▸ 另存为模板…。

    随即打开Save {Type} as Template。

  2. 输入模板名称。
  3. 在保存到中,选择:
    • 此项目:项目的每位成员都可以使用。只有项目所有者能看到此选项。
    • Organization: {name}(Holarch 服务器,组织管理员):组织的每位成员都可以使用。勾选Make it the organization's default for {Type}可在新建文档中预先选中它。
  4. 如果模板应保留文件和图像,请勾选包括文件和图像。
  5. 点击保存。

模板存储每个条目的类、名称、编号、描述、级别、标签和普通属性值。不包括质量结果。应用模板时,覆盖已保存文档的矩阵会覆盖新文档。

如果两种都无法保存,对话框会说明这一点:请联系项目所有者或组织管理员。

管理模板

编写 ▾ → Templates ▸ 管理模板…列出项目的模板。所有者可以重命名和移除它们;撤销可恢复已移除的模板。由模板创建的文档不会更改。

组织管理员在组织设置 → 文档模板中管理组织模板:打开组织并使用文档模板重命名模板、开启或关闭默认(每种文档类型一个默认模板)或将其移除。

保存在此浏览器中的模板

在版本 1.8.0 之前,自定义模板保存在浏览器中。项目所有者第一次打开模板列表时,Holarch 会提议将它们复制到项目中:导入到项目或暂不。在此之前,它们仍列在已保存在此浏览器中下。管理模板…为它们提供导入到项目和从浏览器移除。

将模板应用到现有文档

编写 ▾ → Templates ▸ 应用模板…会打开使用模板,含文档类型、模板、将此文档另存为模板…和管理模板…。

应用将模板的章节连同其编号和嵌套添加到文档末尾。提示消息显示“Added N sections.”撤销可将其移除。

富文本编辑器

富文本编辑器用于编辑带格式、表格、图像和动态内容的描述。点击描述(或文档描述)即可编辑。使用键盘时,按 Tab 移到描述并按 Enter 或 F2;屏幕阅读器会将其读作以其条目命名的文本字段(“Description of 1.2 Power Budget”)。

编辑器就地打开,带有工具栏、字数和字符计数器(“words: N · chars: N”)以及提示“⌘↩ / Ctrl+Enter save · Esc cancel · Tab leave”。

  • 要保存,请按 ⌘↵ / Ctrl↵、点击✓、点击编辑器外部,或按 Tab 离开编辑器。
  • 要取消,请按 Esc。焦点返回到描述。
  • 每次保存都可通过一次撤销撤回。
  • Tab 从不用于缩进,因此不会把您困在编辑器中。使用 ⌘ / Ctrl+] / ⌘ / Ctrl+[ 或⇤ / ⇥缩进列表。

工具栏

按钮功能
+插入菜单:✦ 使用 AI 写作…、图像…、替代文本…(文本含图像时)、Table…、代码块、Line、链接…、链接到文档…、文件…、图…、Live Value…、计数或合计…、Live Table…、矩阵…、交叉引用…、符号…,以及文本含图的图片时的更新图插图
✦AI 文本工具(见下文)
¶ ▾段落样式:文本、标题 1至标题 4、引用、代码块
B / I / U粗体(⌘B / Ctrl+B)、斜体(⌘I / Ctrl+I)、下划线(⌘U / Ctrl+U)
⋯Underline (⌘U / Ctrl+U)、删除线、上标、下标、行内代码、突出显示、Clear formatting (⌘⇧M / Ctrl+Shift+M)
• / 1.项目符号列表(⌘⇧8 / Ctrl+Shift+8)/ 编号列表(⌘⇧7 / Ctrl+Shift+7)
⇤ / ⇥减少缩进(⌘[)/ 缩进(⌘])
≡ ▾对齐:Left、居中、Right、两端对齐
▦插入表格…,以及在表格内的表格操作
🔗链接(⌘K / Ctrl+K)
A文本颜色和背景色板(各十种颜色)以及移除颜色
Aa所选内容的字体(Arial、Brush Script MT、Comic Sans MS、Garamond、Georgia、Helvetica、Impact、monospace、Times New Roman)和大小(10 至 60 px)
↶ / ↷编辑器内的撤销(⌘Z / Ctrl+Z)/ 重做(⇧⌘Z / Ctrl+Shift+Z)
</>HTML 源代码(⌘/ / Ctrl+/);切换回来时会对源代码进行净化
⤢全屏;Esc 会先退出全屏
✓保存(⌘↵ / Ctrl↵)

应用于所选内容的字体、大小和样式需要先选择内容。未选择时,提示消息显示“Select some text first.”

表格

插入表格会询问行(默认 2)、列(默认 3)和标题行(开启)。Tab 和 Shift+Tab 在单元格之间移动。在最后一个单元格中按 Tab(或在第一个单元格中按 Shift+Tab)会离开编辑器。

在表格内,点击▦或右键点击单元格可使用表格操作:

  • 在上方添加行、在下方添加行、在左侧添加列、在右侧添加列。
  • 添加标题行、添加题注、与右侧单元格合并。
  • 删除行、删除列、移除标题行、移除题注、删除表格。

图像和文件

  • 图像…将图片文件作为插图插入。插入图像对话框会询问替代文本(图像显示的内容),对于不提供信息的图片可选择装饰性(无需替代文本)。
  • 您也可以粘贴图像,或将图像文件拖放到编辑器中。这些图像起初没有替代文本;提示消息显示“Image added without alt text. Add it with the + menu (Alt Text…).”
  • 粘贴图像地址(以 .png、.jpg、.jpeg、.gif 或 .webp 结尾)会插入该图片。
  • 最长边超过 4,000 px 的图像会缩小以适应。通知显示“Image reduced to W × H px (the limit is 4000 px on the longest side).”
  • 超过单个文件上限的图像文件会按 1,600 px 宽度重绘为 JPEG。如果仍然太大,提示消息显示“Image exceeds the N MB limit.”
  • 文件…将任何文件附加为下载链接,并带有表示其类型的图标。超过上限的文件会显示“File exceeds the N MB limit.”

替代文本

替代文本为屏幕阅读器以及 Word 的辅助功能检查描述图像。

  • + → 替代文本…列出文本中的每张图像及其替代文本和一个Decorative复选框。当图像没有替代文本或替代文本是文件名时,它会发出警告。
  • 双击图像,或右键点击它并选择编辑替代文本…,即可只编辑这一张。
  • 图的图片(图…)从题注获取替代文本:图类型和实体名称。
  • Word 输出会将替代文本写入每张图片的说明中。装饰性图片会被标记为装饰性。
  • 链接…(插入链接)需要URL和文本。不带 http:、https:、mailto: 或 # 的地址会加上 https://。链接在新标签页中打开。
  • 链接到文档…(插入文档链接)链接到另一个文档。它需要文档、版本(当前或基线:{name})和文本。
    • 在 Word 输出中,以这种方式链接的文档可以作为附录附加。
    • 没有其他文档时,提示消息显示“This project has no other documents. Create one first.”

动态内容

无论文本显示在何处,动态内容都与模型保持同步:在文档中、属性面板中、导出中和搜索中。

  • 图…(插入图):选择图类型和实体(或白板或框架)。它会插入一张带题注、链接到该图的图片。
    • 该图片是动态的。模型更改后,文档会在片刻后显示新图片,Word 和其他导出会重新绘制它。
    • 要保留当前图片,请在编辑器中双击该插图(图插图)并关闭模型更改时更新图片。该插图随即成为快照。
    • 更新图插图(位于+中)会立即重绘文本中的每个动态插图。
    • 图的实体被删除后,插图保留其最后一张图片。
  • Live Value…:选取一个实体和一个属性。编辑器显示其“Live value”。要更改该属性,请双击该动态值(编辑动态值)。
  • 计数或合计…插入一个根据模型重新计算的数字,用于执行摘要或诸如“12 of 40 requirements are verified”(两个计数)的状态行。其字段:
    • 查询:要计数的实体,例如 class:Requirement AND Requirement:"Status=Approved"。请参阅搜索语法。
    • 范围:整个项目、此文档或另一个文档。以汇编作为范围会涵盖其所有部分。
    • Function:计数、求和、平均值、最小值或最大值。除“计数”外,其余都需要一个数字属性,例如 Cost 的 Amount。没有可合计的数字时,值为 N/A。
    • 当前值。要以后更改计数,请双击它。
  • 矩阵…插入动态的 RTM、RVTM、VCRM、分配矩阵或其他矩阵。请参阅文档生成。
  • Live Table…插入一个来自查询的实体表格。每当显示或导出文本时,行都会重新计算。其字段:
    • 查询,例如 class:Requirement AND label:"Functional Requirement"。默认为 order:modified-。请参阅搜索语法。
    • 范围:整个项目、此文档,或另一个文档或汇编。
    • 列(按顺序):默认为编号、名称。+ 添加属性…添加一个属性列。+ 添加关系列…添加一个列出相关实体的列,例如Verified by。
    • Limit:默认 10。所有行列出每个匹配项。
    • 最多 50 行的预览。
    • 要以后更改动态表格,请双击它。
  • 电子表格区域…将电子表格的单元格作为表格插入,或作为您选择类型的图表(或工作表自带的某个图表)插入,并带题注。选取电子表格、工作表和区域,还可选择要跟随的共享视图。表格和图表显示当前值,并在单元格更改时更新;Word 和其他导出使用导出时的值。区域被删除后,表格保留其最后的行并被标记为缺失。
  • 交叉引用…(插入交叉引用)按当前编号引用打开的文档的某个部分:
    • 章节或条目显示条目的编号和名称,例如“3.2 Frost Warning”。Other entity…选取文档之外的实体。
    • 插图和表格列出文档中带题注的插图和表格,显示为“Figure 2”或“Table 1”。选择尚无引用键的项会为其添加一个键。
    • 文本会随重新编号而变化。在 Word 输出中,交叉引用成为 Word 用题注编号更新的域。目标已被删除的交叉引用保留其文本并被标记。
  • 符号…插入以下之一:± ° µ Ω ≈ ≠ ≤ ≥ × ÷ √ ∞ ∑ π Δ、箭头、• … — –、© ® ™ § ¶、€ £ ¥ ¢、½ ¼ ¾ ² ³、✓ ✗。

AI 文本工具

✦改写所选内容,未选择时改写当前段落。没有可处理的内容时,提示消息显示“There is no text to rewrite.”

这些工具:

  • 改进措辞、简化、修正拼写和语法、缩短、添加详细信息、补全句子。
  • 以某种语气改写…:学术、果断、随意、自信、建设性、共情、激昂、流畅、正式、友好、鼓舞人心、专业。
  • 翻译…和翻译全文…:阿拉伯语、中文、英语、法语、德语、希腊语、意大利语、日语、韩语、葡萄牙语、俄语、西班牙语、瑞典语、乌克兰语。
  • 使用 AI 写作…。

预览显示当前、建议和更改。选择替换、重试或放弃。

粘贴

粘贴的带格式文本保留其结构:标题、列表、表格和链接。它会丢失类、内联样式(表格单元格上的除外)和 Office 标记。所有富文本中的脚本、框架和不安全链接都会被移除。

富文本快捷键

按键Action
⌘↵ / Ctrl↵保存并关闭
Esc取消(或退出全屏)
⌘B / Ctrl+B / ⌘I / Ctrl+I / ⌘U / Ctrl+U粗体 / 斜体 / 下划线
⌘K / Ctrl+K链路
⌘⇧7 / Ctrl+Shift+7 / ⌘⇧8 / Ctrl+Shift+8编号列表 / 项目符号列表
⌘] / ⌘[缩进 / 减少缩进
Tab / Shift+Tab下一个 / 上一个表格单元格;在其他位置则离开编辑器(会保存)
⌘⇧M / Ctrl+Shift+M清除格式
⌥⌘0 / Ctrl+Alt+0文本段落
⌥⌘1 / Ctrl+Alt+1 至 ⌥⌘4 / Ctrl+Alt+4标题 1 至标题 4
⌘/ / Ctrl+/HTML 源代码
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+Z编辑器中的撤销 / 重做

在文档中查找

点击查找或按 ⌘F / Ctrl+F 搜索文档。搜索框显示“n/m”。

搜索涵盖每个条目的编号、名称和描述、所显示列中的值以及质量检查消息。它会跳过被筛选隐藏的条目。

  • Enter 或▼转到下一个匹配项。
  • Shift+Enter 或▲转到上一个匹配项。
  • Esc 清除文本,×关闭搜索框。

已折叠的章节会展开以显示匹配项。匹配的行会突出显示,当前匹配项会被标记。

查找和替换

编写 ▾ → Find and Replace…会打开查找和替换。它包含:

  • 查找和替换。
  • 要搜索的字段:名称、编号和描述。编号默认关闭。
  • 区分大小写和全字匹配。

字段下方的一行显示“N entities match (locked entities are skipped).”全部替换会更改文档条目中的每个匹配项,一次撤销即可全部撤回。提示消息显示“Updated N entities”或“No matches”。在富文本中只有文本会更改:格式、链接和标记保持不变。

编写菜单

编写 ▾包含添加和更改内容的命令。在基线中、只有查看权限时以及筛选或排序开启时,添加条目的命令会变暗;工具提示会说明原因。

项功能
Add Item ▸Statement 类和其他类…。在所选条目之后添加条目,未选择时添加到末尾。所选的类成为当前类。
添加现有条目…请参阅现有实体。
Insert ▸将动态内容插入所选条目的描述中:Live Value…、计数或合计…、Live Table…、矩阵…、图的图片…、电子表格区域…和交叉引用…。描述编辑器会在文本末尾打开,并显示所选对话框(请参阅动态内容)。在选择未锁定的条目之前变暗(“Select an unlocked item first”)。在汇编中,它还提供文档…和生成的章节…(请参阅汇编)。
✦ Generate Requirements…AI 生成器,作用于所选条目之下或整个文档。每个结果在添加之前都会先预览。
✦ 生成子需求…选中 Statement 或需求时:生成其新的子条目。
✦ Generate Risks…选中某个条目时:生成其风险。
✦ 生成测试用例…选中某条需求时:生成一个验证它的测试用例。
✦ Summarize…写入一个摘要条目,始终位于文档最前面,不带编号。
✦ Translate…翻译文档的文本,带预览。
Find and Replace…请参阅查找和替换。
重新编号…请参阅重新编号。
Templates ▸应用模板…(应用模板)、另存为模板…(将文档另存为模板)和管理模板…(管理模板)。

为此分支设置属性

右键点击一个条目并选择为此分支设置属性…,可为该条目及其所有后代设置同一个值。选择添加标签、移除标签或某个属性,然后选择值。对话框注明“Applies to {item} and its N descendants. Locked entities are skipped.”提示消息显示“Updated N entities (k locked skipped)”。

拆分为多个条目

右键点击一个条目并选择拆分为多个条目…,可将复合需求拆分为单一需求。对话框标题为拆分为多个条目:{item}。

  1. 选择按句子拆分或按段落拆分,以及新条目作为其子条目或在其后添加新条目。

    表格中每个部分显示一个建议的条目,带有其编号、可编辑的名称和文本。

  2. 或点击✦ 建议拆分,让 AI 建议单一需求(最多 20 条)。
    • 文本中含网址的行默认不勾选。
    • 原条目已审批、已纳入基线或已锁定时,替换其文本是一个默认不勾选的可选项。
    • 差异显示第 1 行与原文的对比。
  3. 编辑名称和文本。Join将某个部分与下一个部分合并。
  4. 取消勾选您不需要的部分,然后点击应用。

第 1 部分(“keeps”)留在原条目中。每个勾选的部分成为一个同类、同标签的新条目。编号会自动建议;自动重新编号开启时,拆分后会重新分配编号。一次撤销即可撤回整个拆分;提示消息显示“Split into N items”。

检查菜单

检查 ▾列出此文档中需要处理的内容,右侧显示计数:

项功能
检查质量检查文档中通过当前筛选的每条需求,并打开结果。选中某条需求时,该项为检查此需求的质量。没有需求时:“此文档中没有要检查的 Requirement。Statement 不评分。”
Model Checks for This Document…打开此文档的模型检查:该文档及其条目的模型检查发现项(规则、条目、发现项),以及指向缺失内容的动态内容。点击一个条目即可选中。没有发现项时:“No findings for this document.”打开模型检查会打开整个项目的页面。
追溯状态…显示“N of M complete”并打开追溯状态:尚未分配或验证的需求,每条带有其圆点和缺失的内容(satisfied by、verified by)。点击一条即可选中。打开 RVTM会打开 RVTM 页面。文档含需求时显示。
待审查的关联打开此文档的待审查的关联。
TBD/TBR 登记册打开此文档的 TBD/TBR 登记册。
Find Acronyms…请参阅查找缩略语。
评论显示未解决评论的数量,并在属性面板中打开它们(请参阅评论)。

追溯状态

每条需求的徽标后面有一个圆点,表示其追溯状态:

  • 绿色:该需求 satisfied by 某个条目(已分配),并且 verified by 某个条目。
  • 琥珀色:两者之一缺失。
  • 红色:两种关联都不存在。

指向圆点可查看状态和缺失的内容,例如“Trace status: Partly traced. Missing: no verified by link (not verified).”点击它会打开一个菜单,包含满足者(分配)和Verified by下的条目(点击可打开)、在 RVTM 中打开和Relate To ▸。Statement 和其他类没有圆点。在基线中,圆点显示基线的关联。使用视图 ▾ → 追溯状态关闭圆点。

查找缩略语

检查 ▾ → Find Acronyms…会在文档的编号、名称和描述中查找缩略语,并在一个评审列表中将它们添加到文档的 Glossary 章节。

  • 缩略语是两个或更多大写字母,最多八个字符,且不全是数字。
  • 全称来自项目中现有的条目,或来自术语旁边首字母拼成该术语的单词(“Concept of Operations”→ CONOPS)。
  • 每一行有保留、术语、全称及其使用次数(点击“N uses”可查看它出现的每个位置)。附注会标出已“in the Glossary”、“entry exists in the project”或“no expansion found”的术语。
  • 有全称且尚未加入 Glossary 的术语默认勾选。标题中的复选框可全部勾选或取消勾选。
  • 将文本中的每次使用链接到其术语表条目(实时值)(开启)会将描述中的每次使用转换为该条目编号的动态值,并链接到该条目。

点击添加到术语表。每个勾选的术语成为一个标为 Acronym 的 Statement,编号 = 术语,名称 = 全称,位于文档顶层的Glossary章节下(使用现有名为 Glossary 或 Acronyms 的章节;否则在末尾添加一个)。项目中已有的条目会被重用,而不会再创建一个。一次撤销即可全部撤回。什么都没找到时,您会看到“No acronyms in this document. Acronyms are words with two or more capital letters, such as CONOPS.”;未勾选任何项时显示“Tick at least one term.”重新编号不会改动术语表条目。

交付菜单

交付 ▾设置交付物并将其导出,按输出分组:

项功能
交付物设置…编号、标题页、页眉和签名栏(请参阅交付物设置)。
页面设置…密级标识、封面和页码(请参阅页面格式)。
Word Template ▸Word 模板,此文档所用的模板带 ✔,还有编辑 Word 模板…。选择其中一个会使其成为此文档的模板。
Version ▸保存基线…和比较版本…(请参阅基线)。
Word:每个 Word 模板一个{template} (Word)立即按该模板的选项以 Word 格式下载文档;文档自身的模板显示“this document”。从基线下载时,输出的是该基线。
Outline (Word)…以标题形式输出的大纲,可选附带目录。
Redline (Word)…请参阅修订标记。需要基线。
Excel: Traceability Matrix…以 Excel、Word、CSV 或网页形式输出的标准矩阵(请参阅文档生成)。
Changes (Excel)…从某个基线到较晚基线或当前版本的更改。需要基线。
Exchange: Requirements (ReqIF)…、文档数据 (JSON)…交换格式(请参阅报告)。
Print or PDF…请参阅打印 / PDF。
所有导出…每种导出及其选项(请参阅报告)。

Word 模板

Word 模板是一组命名的 Word 导出选项和页面设置。它决定 Word 文件的形式,而不是内容(文档模板填充内容;请参阅模板)。每个文档使用一个;默认为规范。在交付 ▾ → Word Template ▸中选择。

内置模板:

模板选项
规格说明目录到第 3 级、编号题注、图目录和表目录、来自基线的修订历史和审批、作为附录的关联文档。文档显示属性列时包括属性列。
Deliverable by Chapter与 Specification 类似,但题注按章节编号(Figure 3-1),描述中的标题会列入目录。
Review Copy横向页面,每个条目下方显示文档的属性列;目录到第 2 级,没有前置表格。
Plain标题、各级标题和文本:没有目录、题注编号或前置表格。

所有内置模板都使用 Letter 页面。

编辑 Word 模板…会打开Word 模板。内置模板有复制;副本成为项目模板,保存在项目中供每位成员使用。选择一个项目模板可更改:

  • 名称、页面大小(Letter (8.5 × 11 in)或A4 (210 × 297 mm))和方向(纵向或横向)。
  • Contents(无、第 1 级、第 1–2 级、第 1–3 级、第 1–4 级、所有层级)和题注编号(图 1、表 1、按章节:图 3-1或Off)。
  • 图目录和表目录(有题注时)、说明中的标题会出现在目录中、文档中显示的属性列,位于每个条目下方、作为附录的关联文档和来自基线的修订历史和审批。
  • 删除模板。

点击保存(一次撤销即可撤回;提示消息显示“Word templates saved.”)。模板被删除的文档会恢复为 Specification。

公司 Word 文件

项目模板可以带有您组织自己的 Word 文件(.docx 或 .dotx,最大 5 MB)。导出随后会使用该文件的:

  • 样式:字体、颜色、标题和正文样式。文件缺少的样式(题注、目录条目)会被添加;文件中的标题编号会被丢弃,因为由 Holarch 为标题编号。
  • 页面:大小、方向和页边距。选择该文件会将模板的页面大小和方向设为与之一致。
  • 页眉和页脚,包括其中的徽标和页码。每个页眉和页脚都会加上项目或文档的密级标识。
  • 标题页:文件中第一个分节符之前的内容,或在没有分节符时为整个文件。它会替换 Holarch 的标题页。

在标题页以及页眉和页脚中,会填入以下占位符:{{Title}}、{{Type}}、{{Number}}、{{Version}}、{{Date}}、{{Project}}、{{Organization}}、{{Contract}}、{{CDRL}}、{{Prepared For}}、{{Prepared By}}和{{Baseline}}。大小写和空格无关紧要。花括号中的其他文本保持原样。

要添加一个:

  1. 选择交付 ▾ → Word Template ▸ → 编辑 Word 模板…。
  2. 点击公司 Word 文件行中的选择…,或选择一个项目模板并点击公司 Word 文件下的选择…。
  3. 选择该文件。点击保存。

替换…更换文件,移除恢复为 Holarch 的样式和标题页。不是 Word 文档的文件会被拒绝,并显示“The file is not a Word document (.docx or .dotx).”引用文档外部的内容会被略去:链接的图片、嵌入的对象和控件,以及 INCLUDETEXT、INCLUDEPICTURE、DDE、LINK 和 IMPORT 域。宏从不读取。

模板的页面还决定纸张视图的宽度:Letter 页面宽 816 px,A4 为 794 px,横向时更宽。在所有导出… → 文档 (Word)中,选项从文档的模板开始;那里的Word 模板会用另一个模板填充它们,您还可以为单次导出更改它们。

视图菜单

视图 ▾包含此文档的直接开关:

  • 纸张(开启时带 ✔):以页面形式显示文档,宽度与 Word 模板的页面相同,不显示属性列。Requirements Document 起初关闭此项;其他类型起初开启。
  • 大纲窗格:显示或隐藏大纲窗格。
  • 追溯状态:显示或隐藏追溯状态圆点。默认开启。
  • Columns ▸(在纸张视图中变暗):文档中各类的每个属性以及条目字段(类、编号、创建时间、修改时间、标签),所显示的列带 ✔。选择一项可显示或隐藏它;新列添加在末尾。默认列恢复状态、验证方法和质量评分。
  • 全部折叠,以及有内容折叠时的全部展开。
  • 折叠子条目:折叠所选条目下的章节(在选中带子章节的条目之前变暗)。
  • 重置视图:清除折叠、筛选、排序和搜索。它还会以默认宽度显示大纲窗格、重置列宽并恢复默认列。
  • Open In ▸:在另一个视图中打开所选条目,未选择时打开文档:条目视图、History…(每项已记录的更改,每个字段带逐词差异)、可以显示它的图、可追溯性矩阵(以文档作为行轴)、需求质量(限定于该文档)和功能分析。
  • 帮助。

右键点击列标题可使用左移、右移和隐藏列。

列按文档记忆在此浏览器中。最后一次的选择是您尚未设置的文档的起点。纸张和追溯状态随文档保存。选择行时,水平滚动位置保持不变。

基线

标题栏中的版本 ▾列出当前版本、此文档的基线,以及项目基线下项目的基线(各带日期;✔ 标记所显示的那一个)。它以保存基线…和比较版本…结尾。交付 ▾ → Version ▸有相同的两个命令。

创建基线

  1. 点击版本 ▾ → 保存基线…(显示基线时变暗:“Go back to the current version first”)。

    保存基线打开时带有说明“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.”(基线会保留该文档的此版本——其条目、属性和关系——以便日后查看、比较和恢复。审批记录以现在的日期记录,之后无法编辑。)

  2. 输入名称(必填)。默认值为“{document} Baseline N”。
  3. 在审批下,为每位审批人填写一行:名称、角色和声明。第一行已预先填入您的姓名。默认声明为“Approved for release.”
  4. 点击+ 添加审批人添加更多行,或点击×删除一行。没有姓名的行会被忽略。
  5. 点击创建。

    提示消息显示“基线已保存”。

查看基线

在版本 ▾中选择一个基线。横幅显示“Baseline “{name}”, read-only, saved {date}”(项目基线另加“· project baseline”)以及审批人。它提供:

  • 返回当前:返回工作副本。
  • 编辑(文档基线):打开编辑基线。重命名基线,或在添加审批下添加审批记录。“新记录以现在的日期记录并添加到列表中。现有记录无法更改。”
  • 与当前比较(文档基线):从此基线打开比较版本。
  • 恢复基线:询问“用基线“{name}”覆盖此文档的实体、顺序和结构?此后添加的实体会从文档中移除(不会删除)。可以撤销。”
    • 对于项目基线,它会打开用基线替换项目:“用项目基线“{name}”替换整个项目?可以撤销。”
  • 删除:询问“删除基线“{name}”?”

在基线中,编辑、快速添加和结构工具都处于关闭状态,大纲显示 🔒。交付 ▾从基线生成输出(“Export (baseline “{name}”)”)。

基线中的动态内容在屏幕上和输出中都显示基线的模型:动态值、计数和合计、动态表格、矩阵和交叉引用都基于快照解析,图插图保留随基线存储的图片。文档基线保存文档、其条目以及相隔一个关系的实体,因此其中的计数或表格涵盖这些实体;基线外实体的动态值显示其当前值。

比较版本

版本 ▾ → 比较版本…会打开比较版本。它将从(一个基线)与到(较晚的基线或当前版本)进行比较。没有基线时,它显示“This document has no baseline. Save one first.”

它列出“N changes”,含编号、名称、更改类型、字段和更改。对于已修改的文本,更改显示逐词差异。

更改类型:

  • 已添加和已移除。
  • 已修改:字段为名称、编号、描述、类、图片或任何属性。
  • 已添加标签和已移除标签。
  • 已添加关系、已移除关系和关系属性。

更改 (Excel)下载该比较,含编号、名称、类、更改类型、字段、旧值和新值。修订标记版 (Word)将相同的比较下载为 Word 修订标记文件(请参阅修订标记)。

报告

交付 ▾将文档导出为 Word、PDF、电子表格和其他格式。{template} (Word)项会立即下载(请参阅Word 模板);每个 Word 项的名称下方都有一行说明。菜单末尾的删除文档…会删除文档,还可选择同时删除没有其他文档使用的章节(请参阅文档列表),然后返回列表。大纲 (Word)…、修订标记版 (Word)…、更改 (Excel)…、需求 (ReqIF)…、文档数据 (JSON)…和打印或 PDF…会以该选项打开导出对话框;所有导出…以您上次的选择打开它。

  1. 点击交付 ▾ → 所有导出…。

    导出随即打开。

  2. 在导出为中选择要导出的内容。选项命名为“<content> (<format>)”,并按输出分组:Word、Excel、CSV、网页、文本、交换和打印。
  3. 设置其选项。
  4. 编辑文件名(最多 99 个字符)。
  5. 点击导出。

预览显示电子表格报告的前 60 行。对于其他导出,它显示“Preview shows spreadsheet exports only. Choose an Excel export.”报告使用文档编号,在基线中则使用基线的内容。

报告输出选项
Document (Word)Word 格式的文档(请参阅Word 输出)Word 模板(文档的模板;选择另一个会用它填充下列选项)、添加目录、目录深度 1 至 6、题注编号(图 1、表 1、按章节:图 3-1、表 3-1或Off)、图目录和表目录(文档有题注时)、说明中的标题会出现在目录中、包括文档中显示的属性列、将关联文档添加为附录、根据基线填充修订历史和审批表。默认值来自模板;使用 Specification 时:目录到第 3 级、简单题注编号、目录列表、显示时包括列、附录和基线表格开启,标题关闭。页面大小和方向采用模板的设置。
Changes (Excel)两个版本之间每个添加、移除和更改的条目、属性和关系从(一个基线,默认选中最早的)、到(当前版本或一个基线);没有基线时显示“This document has no baseline. Save one first.”
表格 (CSV)每个条目一行属性(按列顺序)(默认为编号、名称、描述和所显示的列;还可包括任何Relationship: {name},列出相关条目)、排序依据 分层、编号或名称
评论 (Excel)文档及其条目上的每条评论一行,附带评论作者包括类、名称、编号和说明、日期、已解决(均开启)
Document data (JSON)用于重新导入的文档Directly related entities(关闭)、评论(开启)、基线(关闭)、历史记录(关闭)
Outline (Word)仅标题,带编号添加目录(关闭)
Document (Markdown)以 Markdown 标题和文本表示的文档无
Document (Print or PDF)浏览器的打印对话框;在其中选择“存储为 PDF”无
Redline (Word)带 Word 修订的文档(请参阅修订标记)从基线(最新的)、目标(较晚的基线或当前)
Quality findings (Excel)每条需求九行(每项准则一行),带消息以及绿色的“是”或红色的“否”,末尾有“Report score”More attributes、包括创建时间、修改时间和全局 ID
需求 (ReqIF)ReqIF XML,含层级以及文档内的 traced to、satisfied by、verified by、satisfies、verifies 和 traced from 关联无
RSM (Excel)需求 → satisfied by 条目需求属性(编号、名称)、Related entity attributes(类、编号、名称、描述)
RTM (Excel)需求 → traced to 条目同 RSM
RVM (Excel)需求 → verified by 条目同 RSM
RVTM (Excel)需求 → 验证它的 Test Case,包括文档的每一行需求属性(编号、名称、描述、验证方法)、Test Case 属性(编号、名称、描述、状态)
TVM (Excel)文档中的 Test Case → 它们所验证的需求Test Case 属性(编号、名称、状态)、需求属性(编号、名称、描述)
VCRM (Excel)需求 × 验证方法,以 X 标记需求属性(编号、名称)、验证方法(全部)
Traceability matrix (Excel)、(Word)、(CSV)、(HTML)文档或整个项目的标准矩阵(请参阅文档生成)矩阵、范围(此文档或整个项目)

在矩阵报告中:

  • 没有关联条目的需求以红色底纹显示。在 VCRM 中,没有方法的需求以红色底纹显示。
  • 需求单元格在其相关行上合并。
  • 两行标题被冻结。

Word 输出

Document (Word)按以下顺序构建 Word 文件:

  1. 标题页(在页面设置中开启Cover page,或在交付物设置中开启Title page),否则为标题和一行斜体文字,含类型和“No. {number}”。从基线导出时,该行会加上“Baseline: {name} ({date})”。密级标识声明(页面设置)显示在标题下方的方框中。
  2. 修订历史(Version、Date、Author、Changes):文档的每个基线一行,最早的在前,直到所导出的基线为止。
    • 第一行为“Initial baseline”。后续行为“N added, N removed, N modified”或“No changes”。
    • Author 为基线的创建者或其审批人。
  3. 审批(Role、Name、Statement、Date),来自最新的(或所导出的)基线。没有审批记录时,交付物设置中计划的审批人会获得一个签名栏:Role、Name、Signature 和 Date,并带有供签名的空行。
  4. 文档描述,然后是目录、List of Figures和List of Tables,以及一个分页符。
  5. 每个条目作为一个 Word 标题,带其编号和名称,然后是其描述。标题 1 至标题 6 按深度对应;更深的级别保持为标题 6。一个 Attribute/Value 表格列出有值的所选列。
  6. 附录:通过嵌入链接关联的每个文档都从新的一页开始,带“{document} Appendix”及其内容,下降一级。

生成的表格可以放入某个章节,而不是放在开头。当文档中有以下名称之一的章节时就会如此(内置模板使用这些名称):

  • 修订历史:“Revision History”或“Document Revision History”。
  • 审批:“Approvals”、“Approval”、“Sign-off”、“Signoff”、“Signatures”或“Signature”。

题注、目录和交叉引用

  • 图题注(图片的题注、图插图)在图片下方显示为“Figure 1: {caption}”。表题注(矩阵块的标题、表格的题注)在表格上方显示为“Table 1: {caption}”。
  • 按章节为每个顶层章节分别编号:“Figure 3-1”是第 3 节中的第一个插图。没有题注的表格不编号。
  • 编号是 Word SEQ 域,List of Figures和List of Tables是基于题注的 Word 域。它们仅在文档有图题注或表题注时出现。在 Word 更新域之前,这些目录显示不带页码的题注。
  • 每个标题、图题注和表题注都带有书签。描述中的交叉引用成为指向该书签的 Word REF 域,因此在 Word 更新域后,它显示当前的标题(“3.2 Frost Warning”)或标签(“Figure 2-1”)。指向不在所导出文档中的条目的交叉引用保留其文本。
  • 说明中的标题会出现在目录中使描述中的标题成为比该条目低一级的真正 Word 标题。关闭时,它们保持为粗体段落。

交付物设置

交付 ▾ → 交付物设置…包含合同交付物通常显示的数据。应用保存这些数据;⌘Z / Ctrl+Z一步将其撤销。

字段显示位置
编号模型编号(条目自身的编号)(默认)或文档编号(仅保存在此文档中)(请参阅文档编号)。
标题页开启标题页(与页面设置中的Cover page是同一个开关)。
版本、编制人标题页和页眉(与页面设置中的字段相同)。
组织、编制对象、合同编号、CDRL 条目、DID 编号标题页。CDRL 条目也显示在页脚中。
徽标标题页顶部。PNG、JPEG 或 GIF,最大 400 KB。
标题页声明标题页底部的方框,例如分发声明。为空时:使用页面设置中的密级标识声明。
页眉和页脚默认开启。页眉显示“{number}, Version {version}”和标题;页脚显示日期、“Page X of Y”和“CDRL {item}”。它需要文档编号或版本。
计划的审批人每位审批人的角色和姓名。在基线记录审批之前,他们会获得签名行。

文档编号是文档标题旁边的编号字段。

页面格式

  • Word 模板的页面:US Letter 或 A4,纵向或横向,上下页边距 1 英寸,左右页边距 0.875 英寸。
  • Calibri 11 磅。
  • 真正的标题样式,因此 Word 的导航窗格和目录可以正常使用。
  • 表格标题行带底纹,并在每页重复。
  • 页面横幅(密级标识)在每页的页眉和页脚中重复,包括标题页。
  • 有标题页时,文件分为三节:标题页(仅横幅,无页眉,无页码)、前置部分(修订历史、审批、描述、目录和图表目录,以 i、ii、iii 编号)和正文(从 1 开始编号;“Page X of Y”按正文计数)。
  • Word 打开文件时会询问是否更新域。在此之前,目录显示“Right-click and choose Update Field to build the table of contents.”

富文本转换

  • 保留:粗体、斜体、下划线、删除线、上标、下标、行内代码 (Consolas)、突出显示、文本颜色和网页链接。
  • 描述中的标题成为粗体段落,或在开启上述选项时成为 Word 标题。
  • 列表成为缩进的“•”或“1.”段落。
  • 代码块成为带底纹的等宽行。引用成为缩进的斜体。
  • 表格保留合并的列和标题底纹。
  • PNG、JPEG 和 GIF 图片会嵌入,宽度最多约 6.5 英寸,其替代文本作为图片说明。SVG 和 WebP 图片不包含在 Word 文件中。

修订标记

交付 ▾ → 修订标记版 (Word)…写入带 Word 修订的文档。选择从基线和目标(较晚的基线或当前)。比较版本中的修订标记版 (Word)对其中显示的两个版本执行相同操作。

  • 文件以更改摘要表格开头:更改报告中的每项更改,包括属性、标签和关系。
  • 然后是目标版本的文档:添加的条目是修订插入;移除的条目是修订删除,放在其前一个条目之后;更改的名称或描述显示删除和插入的单词。
  • 在 Word 的审阅选项卡中接受或拒绝这些更改。已更改的描述显示为纯文本;未更改的描述保留其格式。
  • 这些更改归于目标基线的创建者,对于当前则归于您的姓名。

打印或 PDF…使用浏览器打印文档页面。横幅打印在每页的顶部和底部。有页眉时(交付物设置),“{number}, Version {version}”和标题在每页顶部重复,日期和 CDRL 条目在底部重复。在汇编中,每个部分从新的一页开始。页码、目录和题注编号仅在 Word 输出中提供。

评论

在属性面板的条目实体面板中(讨论部分)对条目发表评论。检查 ▾ → 评论,或标题栏中的💬 n 条未解决评论,会在属性面板中显示评论:

  • 文档及其条目上的每条评论,按条目分组,并显示“(N open)”。回复缩进显示在其所回复的评论下方。点击条目名称即可选中它。
  • 显示已解决会包括已解决的评论。
  • 每个讨论串的第一条评论上有解决/重新打开,每条评论都有×(删除)。
  • 要对文档本身发表评论,请在评论此文档…中键入,然后点击添加评论。
  • 顶部的×关闭评论;选择条目会改为显示其实体面板。
  • 有未解决评论的行显示💬 n;点击它可打开该条目的讨论。
  • 在任一位置都可以解决、重新打开和删除评论。
  • 所有导出…中的Comments (Excel)会收集这些评论。

请参阅评论和评审。

汇编

汇编将其他文档组合在一起。在评审页面上或通过创建评审包创建的新汇编标为评审包;之前创建的包标为Compilation,工作方式相同。请参阅评审。

插入文档…添加一个文档。它位于编写 ▾ → Insert ▸和+ 新建 ▾ 菜单中。

  • 它列出尚未包含的文档。
  • 插入的文档显示为顶层条目,其自身的内容位于其下方。提示消息显示“Inserted {document}”。
  • 没有其他文档时,您会看到“No other documents to insert.”

生成的章节

插入生成的章节…(位于编写 ▾ → Insert ▸和+ 新建 ▾ 菜单中)添加一个部分,每次显示或导出汇编时,其内容都会根据模型重建。

内容该部分包含的内容
Matrix or Test Report…插入会打开插入矩阵;在那里选择矩阵(或 Test Report)及其范围。范围Compilation (all parts)涵盖所有部分。将章节名称留空可使用矩阵名称。
缩略语列表标为 Acronym 的陈述的表格(Number、Name),按编号排序。
查询表格与查询匹配的实体的表格,含您列出的列(属性名称,以逗号分隔)。

该部分编号位于最后一个部分之后,因此各部分文档保留其编号。⌘Z / Ctrl+Z一步将其移除。没有名称时,您会看到“Enter a section name.”;没有查询或列的查询表格会显示“Enter a query and at least one column.”

Word 中的汇编

汇编的 Word 导出将每个顶层条目作为一个部分导出:

  • 部分标题显示为“Part A: {document}”(标题 1),并有一行注明文档类型、编号和固定的基线。
  • 部分内的章节编号带有部分字母:“A.1 Scope”、“B.1 Scope”。章节编号不会重复。
  • 第一部分之后的每个部分都从新的一页开始。
  • 使用按章节题注时,Part B 中的插图显示为“Figure B-1”。

汇编中的交付物设置…会添加汇编部分:

设置选项
部分标签部分 A、部分 B、…(默认)、第 1 卷、第 2 卷、…、附录 A、附录 B、…或无部分标签
章节编号按部分,带部分字母或编号(A.1、B.1)(默认)、跨部分连续编号(1、2、3)或每个文档保留各自的编号
每个部分从新的一页开始默认开启
每个部分的标题页部分标题及其说明行单独占一页
每个部分的导出来源当前,或该部分文档的某个基线。固定的部分在其行上显示 📌 和基线名称,并导出该基线的内容。

AI 工具

顶栏的✦ AI ▾列出适用于所选内容和文档的 AI 工具。每个 AI 结果都会先预览,一次撤销即可全部撤回。在基线中,这些工具被禁用。请参阅AI。

  • 对于所选的 Requirement 或 Statement:改写得更清晰…、添加可度量的标准…(需求)、简化…、拆分复合需求…、起草理由…、建议名称…、用 AI 检查(此需求)…、生成子需求…和生成测试用例…(需求)。
  • 对于任何所选条目:生成风险…。
  • 对于文档:生成需求…、总结文档…、翻译文档…和用 AI 检查(N 条需求)…。

键盘快捷键

按键Action
⌘F / Ctrl+F在文档中查找
Enter / Shift+Enter下一个 / 上一个匹配项(在搜索框中)
⌘↵ / Ctrl↵在所选条目之后添加一个条目
⌥⌘↵ / Ctrl+Alt↵为所选条目添加一个子条目
⌥⇧→ / Alt+Shift+→ / ⌥⇧← / Alt+Shift+←缩进 / 减少缩进所选条目
⌥ / Alt+↑ / ⌥ / Alt+↓上移 / 下移所选条目
↑ / ↓选择上一行 / 下一行;焦点随之移动
Tab下一个字段:所选行,然后是其编号、名称和描述
Enter / F2在行上时编辑其名称;在编号、名称或描述上时编辑该字段
Delete 或 Backspace从文档中移除所选条目(可在消息中撤销)
⇧Delete / Shift+Delete确认后删除所选条目及其子条目
Esc取消选择;在搜索框中则清除搜索
Enter / Esc保存 / 取消编号或名称编辑(焦点保留在字段上)
在大纲中按 ↑ ↓ Home End在大纲条目之间移动
在大纲中按 → / ←展开 / 折叠条目,或转到其第一个子条目 / 其父级
在大纲中按 Enter / Space在文档中打开该条目(焦点移到其行)/ 选中它
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+Z撤销 / 重做(在编辑器之外)

在 Windows 和 Linux 上,⌘ / Ctrl 使用 Ctrl,⌥ / Alt 使用 Alt。行快捷键在没有字段获得焦点时有效。编辑编号或名称时,⌘↵ / Ctrl↵ 和 ⌥⌘↵ / Ctrl+Alt↵ 也有效。请参阅键盘快捷键以及上文的富文本按键。

此浏览器中记住的设置

保存在此浏览器中:

  • 大纲窗格是否隐藏及其宽度。
  • 每个文档的列和列宽。
  • 列表排序。
  • 新条目的当前类。
  • 上次的报告类型。
  • 版本 1.8.0 之前保存的模板,直到您将其导入项目为止。

随文档保存并与项目中所有人共享:纸张、追溯状态、Word 模板、文档编号、编号模式和起始编号,以及自动重新编号。项目 Word 模板随项目保存。

消息

留言含义和解决方法
没有文档 /“Create a document with + New Document, or import Word, Excel, CSV or ReqIF with Import.”项目中还没有文档。
“No documents match. Clear the search or choose All.”清除搜索文档…或点击全部。
未找到文档该地址指向已删除的文档。请使用返回文档。
此文档为空 /“Add a requirement with “+ New Requirement”, or fill the document from a template with Write → Apply Template….”添加条目或应用模板。
“No items match the filter. Clear the filter to see every item.”更改或清除类和标签筛选项。
已筛选视图:无法编辑。清除筛选 /“Clear the filter or sort to add entities”编写已暂停;点击该警告即可清除。
“Type the text first.”快速添加提交时为空。
“The selected entity cannot move further that way.”该条目位于最前或最后、已锁定,或与已锁定的条目相邻。
“An entity cannot go under its own child. Choose another parent.”选择该条目子树之外的目标。
已过时(质量评分列)上次质量检查后文本已更改。请再次运行检查。
“Could not load the document templates.”模板目录加载失败;请重新加载页面。
“Preview shows spreadsheet exports only. Choose an Excel export.”预览仅适用于 Excel 报告。
“This document has no baseline. Save one first.”在运行更改报告之前创建基线。
“Export failed: … Check the Word template, then export again.”一键 Word 导出失败;请在编辑 Word 模板…中检查模板。
“Image exceeds the N MB limit.” /“File exceeds the N MB limit.”文件大于服务器的单个文件上限。

限制

限制:在文档行中编辑的名称限制为 200 个字符,编号限制为 139 个字符。快速添加接受 2,000 个字符。

限制:图像最长边会缩小到 4,000 px。附加的文件和图像受服务器单个文件上限(Free 方案为 10 MB,Individual 为 25 MB,Team 为 100 MB)和项目存储配额的限制。

限制:Word 输出只嵌入 PNG、JPEG 和 GIF 图片。深于 6 级的标题显示为标题 6。

限制:组织模板存在于 Holarch 服务器上(托管或自托管),桌面应用中没有;桌面应用将项目模板保存在项目文件中。一个组织最多容纳 200 个模板,每个最多 3,000 个章节。保存在某个项目中的模板不会在其他项目中提供:请将模板保存到组织,或在另一个项目中再次保存。