需求
文档生成
将实时的可追溯性、验证和接口矩阵以及测试报告放入文档,以四种格式导出,从基线构建文档,并为其添加标识:在每一页和每次导出中加上公司声明、DoD 分发声明、出口管制声明、版权声明或合同编号。
本页内容
概述
Holarch 根据模型构建交付物,因此文档始终与其背后的需求、测试和关联一致。三种工具涵盖评审人通常要求的内容:
- 矩阵块:文档文本中的可追溯性、验证或接口矩阵或测试报告,每当模型更改时都会更新。
- 导出矩阵:相同的矩阵和 Test Report 以独立文件的形式导出为 Excel、Word、CSV 或网页,可基于当前模型或基线。
- 密级标识和页面设置:为组织、项目或单个文档设置的密级标识(公司声明、分发声明、出口管制声明、版权或合同编号)会出现在每个导出中,另外还可为 Word 设置封面和页码。
文本中的动态值和动态表格在文档页面中介绍:Live Value…插入实体的一个属性,计数或合计…插入根据查询计算的数字,Live Table…插入来自查询的表格,交叉引用…插入章节、插图或表格的当前编号。
概念
矩阵
| 矩阵 | 行 | 列 | 作为缺口突出显示 |
|---|---|---|---|
| RTM(需求可追溯性矩阵) | 需求 | Number、Requirement、Parent、Traced From、Traced To、Satisfied By | 没有父级且没有任何追溯来源的需求 |
| 需求下传矩阵 | 需求 | Number、Requirement、Flows Down From、Flows Down To、Derived Requirements | 没有子级也没有派生需求的顶层需求 |
| 需求分配矩阵 | 需求 | Number、Requirement、Components、Functions、Other | 没有任何条目满足的需求 |
| 符合性矩阵(开启正式项目群时显示) | 客户规格说明中的需求 | Number、Requirement、Compliance、Response、Our Requirements and Design、Verification、Deviation/Waiver | 没有符合性声明的需求(Not assessed) |
| RVTM(需求验证可追溯性矩阵) | 需求 | Number、Requirement、Method、Level、Verified By、Status | 没有验证方法或没有验证测试用例 |
| VCRM(验证交叉引用矩阵) | 需求 | Number、Requirement、Inspection、Analysis、Demonstration、Test、Verified By、Status | 未选择验证方法 |
| 按验证级别的 VCRM | 需求 | Number、Requirement,然后是每个验证级别下的 I、A、D 和 T、Verified By、Status | 没有验证方法或没有验证级别 |
| Test Report | 某个测试周期的测试用例 | Number、Test Case、Verifies、Status、Actual Result、Run | 在该周期中未通过的测试用例 |
| 分配矩阵 | 功能(Action) | Number、Function、Performed By | 没有任何组件执行的功能 |
| 接口矩阵 | 组件(Asset) | 相同的组件;单元格列出从行组件到列组件的 Conduit | 与其他组件之间没有任何 Conduit 往来的组件 |
| N² 矩阵 | 功能(Action) | 相同的功能;单元格列出行功能产生、列功能接收的 Input/Output | 不交换任何输入或输出的功能 |
| 自定义矩阵 | 来自搜索查询的实体 | 来自第二个查询的实体;单元格列出两者之间的关系,或对所选的某个关系显示 X | 与任何列都没有关系的行 |
- Parent 是该行所 decomposes 的需求。Traced From、Traced To 和 Satisfied By 列出相关实体。在下传矩阵中,Derived Requirements 是该行所 traces to 的需求。
- 在 VCRM 中,X 标记每个计划的方法;Status 是迄今为止的验证结果,与测试中心一样由测试用例汇总得出。
- 在按验证级别的 VCRM中,列按验证级别属性的级别(Component、Subsystem、System)分组。X 位于需求的级别及其每个计划方法之下。
- 测试用例从不作为功能列出:分配矩阵和 N² 矩阵显示不是 Test Case 的 Action。
- 范围:矩阵涵盖一个文档的实体(按文档顺序和编号)、汇编的所有部分或整个项目。分配矩阵使用文档的功能,文档没有功能时使用所有功能。接口矩阵和 N² 矩阵也可以涵盖某个 Asset 或 Action 的子级,与 I² 图和 N² 图一样;对于整个项目,它们列出具有 Conduit 或 Input/Output 的组件或功能,最多 120 个。自定义矩阵最多显示 2,000 行和 120 列。
- Test Report块显示一个测试套件的一个测试周期或其当前结果。请参阅测试报告。
动态而非复制
矩阵块只存储要显示的内容,而不存储行。每次显示或导出文档时,Holarch 都会根据模型重建行。结果会缓存到下一次更改为止,因此大型项目仍能保持快速。
如何使用
将矩阵插入文档
- 打开文档,然后点击文档或某个条目的描述。
- 在富文本工具栏中,打开+并选择矩阵…。
- 选取矩阵和范围。范围默认为打开的文档。
- 对于自定义矩阵,请输入行和列的搜索查询(例如
class:Requirement和class:Asset),选择一个关系或保留任意关系,还可以为其指定标题。 - 对于Test Report,请选择测试套件和测试周期,或选择当前结果。
您会看到预览。每当模型更改时,它都会更新。
- 对于自定义矩阵,请输入行和列的搜索查询(例如
- 点击插入。
矩阵以虚线轮廓出现在文本中。其题注注明矩阵、范围以及有缺口的行数。
矩阵无法逐个单元格编辑;请改为更改模型。要移除它,请像删除其他内容一样在编辑器中删除该表格。
导出矩阵
- 在文档中,打开交付 ▾并选择可追溯性矩阵…。或选择交付 ▾ → 所有导出…并选取Traceability matrix (Excel)、(Word)、(CSV)或(HTML)。
- 在导出矩阵中,选取矩阵和范围,并在导出为中选择Matrix (Excel)、Matrix (Word)、Matrix (CSV)或Matrix (HTML)。
- 可选:在模型中选取一个基线而不是当前模型。列表显示项目的基线以及所选文档的基线。
字段下方的一行给出行数以及有缺口的行数。
- 点击导出。
提示消息显示“Matrix exported.”在 Excel、Word 和网页中,缺口以红色底纹显示。Word 和网页导出使用文档的页面设置。在 Word 中,文本列较宽,验证方法列较窄,列标题为I、A、D和T,表格下方附有图例(I = Inspection,A = Analysis,D = Demonstration,T = Test)。超过五列的矩阵使用横向页面。按级别的 VCRM 有第二行标题显示级别;接口矩阵、N² 矩阵和自定义矩阵为其行标题和对角线添加底纹。
来自基线的矩阵
已签署的交付物必须显示建立基线时的模型,而不是今天的模型。从基线构建的矩阵使用基线的实体和关系,其标题以“(baseline name)”结尾。
- 导出矩阵:在模型中选择该基线。
- 项目基线保存整个模型,因此每个矩阵都可以基于它。
- 文档基线保存文档、其条目以及与之关联的实体。该文档的矩阵是完整的。涉及文档之外内容的矩阵(整个项目,或接口矩阵或 N² 矩阵)会带有附注“Built from a document baseline, which holds only that document and the entities linked to it.”
测试报告
测试报告给出一个测试周期的结果:测试了什么、在哪种配置上、哪些通过和失败,以及这验证了哪些需求。
- 在测试中心中,使用开始新周期…记录一个测试周期。输入配置 / 版本和被测件(两者默认为运行中最常记录的值)。
- 在套件卡片上,打开⋯并选择测试报告…。或打开⋯ → Test Cycles…并点击某个周期上的报告…。
- 在导出测试报告中,选择测试周期,并在导出为中选择Test report (Word)、(Excel)、(CSV)或(HTML),然后点击导出。
Word 报告(默认)包含以下章节:
- Identification:测试套件、测试周期、结果保存时间和报告生成时间。
- Test Environment and Configuration:配置或版本、被测件、测试人员和运行日期。
- Summary of Results:按状态的计数和通过率。
- Results by Test Case:每个测试用例一行。
- Detailed Results:每个测试用例的预期结果和实际结果、测试人员、日期、配置、被测件、证据文件和步骤结果。
- Deviations and Open Issues:失败和受阻的测试用例及其关联的 Issue。
- Test Evidence:该周期中记录的证据文件。
- Requirement Verification Status:该套件所验证的需求,及其根据此周期结果得出的状态。
Excel 提供三个工作表(Results、Steps、Requirements);CSV 和网页提供结果表格。结果来自所保存的周期,因此套件重置后报告保持不变。名称、已验证的需求和 Issue 来自当前模型。在开始保存步骤结果和证据之前保存的周期,这些字段显示为“—”。
要将结果表格放入文档,请插入Test Report矩阵块(见上文)。
为文档和导出添加密级标识
密级标识是 Holarch 打印在您导出的所有内容上的文本:每页顶部的页眉、每页底部的页脚以及第一页上的声明。为项目或组织设置一次,每个导出都会带上它。文档可以用自己的密级标识替换它。
注意:托管服务 (app.holarch.app) 不能存放 CUI、涉密或受出口管制的信息(使用条款)。在那里,标准列表不包括 Distribution Statement B 至 F 和出口管制声明,并且提及 CUI、密级(例如 SECRET//NOFORN)、ITAR、EAR 或出口管制,或 Distribution Statement B 至 F 的密级标识不会被保存:“Holarch's hosted service can't hold CUI, classified or export-controlled information, so this marking can't be used here. Remove it, or use the desktop app or a self-hosted installation.”Company Confidential、Distribution Statement A、版权和合同编号等公司声明仍然可用。在此规则之前设置的密级标识会保留并照常打印;要更改,请删除受限部分。
桌面应用和自托管安装提供完整列表,并接受任何密级标识。密级标识是您选择的文本;Holarch 会打印它们,但不强制执行处理规则,适用您组织自己的管控措施。在每个版本中,密级标识中的出口管制声明都会关闭该项目的 AI。
标准密级标识列表会为您填入文本:
| 标准密级标识 | 标题 | 页脚 | 声明 |
|---|---|---|---|
| Company Proprietary | COMPANY PROPRIETARY | COMPANY PROPRIETARY | 注明公司的专有信息声明 |
| Company Confidential | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | 注明公司的保密声明 |
| Distribution Statement A至F(B 至 F:仅限桌面应用和自托管) | (无) | DISTRIBUTION STATEMENT A to F | 该声明的标准 DoD 措辞 (DoDI 5230.24),并填入原因、认定日期和管控机构 |
| 出口管制声明(ITAR/EAR)(仅限桌面应用和自托管) | (无) | Export-controlled technical data. See the notice on the first page. | 一条警告,说明文档可能包含受 ITAR (22 CFR 120–130) 或 EAR (15 CFR 730–774) 管制的技术数据 |
| 版权 | (无) | © Year 版权所有者. All rights reserved. | (无) |
| 合同编号 | (无) | Contract No. 合同编号 | (无) |
您留空的填写项会以方括号占位符的形式保留在文本中,例如 [reason]。编辑器随后显示“Complete the bracketed parts before you export.”
设置项目密级标识
- 按 ⌘K / Ctrl+K 并选择项目密级标识…。您也可以从文档中的页面设置…打开它,或从打开的项目的项目偏好设置…(主页上的主页 ▾)打开。
- 选择自有密级标识。
- 在标准密级标识中,选择一个条目,填写其字段(例如公司),然后点击添加到密级标识。
您会看到Header、页脚和Notice已填好。添加另一个条目可将它们组合:页眉和页脚以“ · ”连接,每条声明成为单独的段落。
- 如有需要,编辑文本,然后点击保存。
提示消息显示“Project marking saved.”只有项目所有者可以更改项目密级标识;其他成员只能查看。
清除清空这三个字段。无密级标识为项目关闭密级标识,即使组织设有密级标识也是如此。
设置组织密级标识
- 打开账户菜单并选择组织设置,然后打开该组织。
- 在文档密级标识下,点击编辑密级标识…。
- 按与项目相同的方式设置密级标识,然后点击保存。
提示消息显示“Organization marking saved.”它适用于该组织中所有没有自己密级标识的项目。只有组织管理员可以更改它。
为文档设置自有密级标识、封面和页码
- 在文档中,打开交付 ▾并选择页面设置…。
- 在密级标识下,选择其一:
- 项目或组织密级标识(默认):下方一行注明文档所用的密级标识。
- 自有密级标识:按与项目相同的方式设置页眉、页脚和声明。
- 无密级标识:文档及其导出不带任何密级标识。
- 填写其余内容:
- Cover page,含版本和Prepared by。封面也会显示声明。
- Word 导出中的Page numbers(“Page X of Y”)。
- 点击应用。
提示消息显示“Page setup saved.”页眉和页脚显示在文档的顶部和底部,声明显示在其标题下方。⌘Z / Ctrl+Z 一步撤销该更改。
最近的密级标识优先:文档自己的,否则为项目的,否则为组织的。
密级标识的打印位置
- 文档视图和打印或 PDF…:页眉和页脚位于每页的顶部和底部,声明位于标题下方。
- Word 导出(交付 ▾ → {template} (Word),或所有导出…中的Document (Word)):页眉和页脚在每页重复,如已选择则带页码,封面取代普通标题。文档中的动态矩阵块成为一个 Word 表格,标题位于其上方,列宽和 I/A/D/T 列标题相同,缺口以红色底纹显示。
- 导出矩阵和Traceability matrix (Word)或(HTML)。
- 其他 Word 文件:ICD 文档、演示文稿、图和Breakdown (Word)导出在每页带有页眉和页脚,并在标题下方带有声明。
- Excel 报告:页眉和页脚写入每个工作表的页眉和页脚,Excel 在页面布局视图中显示并打印它们。
- CSV:仅在您于Table (CSV)中勾选首行显示密级标识时才包含。它默认关闭,因此文件可以原样再次导入。
- 图的图像:PNG 和 SVG 导出会在图上方加一条带页眉的横条,在下方加一条带页脚和声明的横条。网页 (HTML)导出将它们显示在页面的顶部和底部。缩略图和文档中的图的图片不加标识。
- 演示文稿:PowerPoint、网页、PNG 和 SVG 幻灯片在每张幻灯片上显示页眉和页脚,在第一张幻灯片上显示声明。
- 汇编有自己的页面设置,在您导出汇编时使用。
模型检查
模型检查会报告指向已删除内容的动态值或动态表格(规则 Global.7,“Live values pointing to missing targets”):
- 实体已被删除的Live Value显示“{Entity: … Not found}”。
- 范围文档已被删除的矩阵块、测试套件或测试周期已被删除的Test Report块,或关系已不存在的自定义矩阵。
- 查询中引用了不存在的类、标签、关系或文档的Count or Total或Live Table。
- 其条目、插图或表格已被删除的Cross-Reference。
打开描述,然后编辑或移除该动态值,或为存在的目标重新插入它。请参阅模型检查。
提示
- 将 RVTM 或 VCRM 放在规格说明末尾作为其验证章节;它会一直保持最新,直到评审。
- 对于评审包,请构建一个汇编,并在其自身的页面设置中为其设置封面和密级标识。
- 将 VCRM 导出到 Excel 供评审委员会批注,同时在文档中保留动态块。
- 对于按集成级别组织的验证计划,请使用按验证级别的 VCRM,并先设置每条需求的验证级别。
- 对于接口控制文档,请插入一个范围限定于系统 Asset 的接口矩阵,使其子级及其 Conduit 显示在对角线和单元格中。