Skip to content

需求文档套件功能说明

功能概述

需求文档套件功能用于将多个具有关联关系的需求文档进行统一封装管理。当测试用例的生成需要依赖多份需求文档时,可通过套件功能将相关文档及子套件整合为一个整体,便于统一维护和后续基于套件生成测试用例,确保测试覆盖的完整性和文档引用的一致性。

核心功能

列表展示

  • 字段展示:列表展示 ID、名称、描述、文档列表、子套件、操作等字段。其中文档列表以数组形式展示关联的需求文档名称,子套件以数组形式展示关联的子级套件。
  • 批量操作:支持勾选多条记录进行【批量删除】、【批量导入】和【批量导出】。
  • 视图切换:支持列表视图与网格视图的切换展示。

新增需求文档套件

支持创建新的需求文档套件,配置信息包括:

  • 名称:套件的名称标识,为必填项。
  • 描述:对套件内容的文字说明。
  • 文档列表:从平台已有的需求文档中选择需要关联的文档,支持多选。
  • 子套件:从已有需求文档套件中选择其他套件作为子套件,支持多选,实现套件的层级嵌套管理。
  • 标签:为套件添加标签,便于分类和检索;标签需在【配置-标签】模块中预先创建。

保存校验规则:名称为必填项;文档列表和子套件至少选择其一,若均未选择,系统会提示"请选择文档或子套件!!!"。

查看详情

点击列表操作栏的【查看详情】按钮,可查看需求文档套件的名称、描述、文档列表、子套件、标签等详细信息。

套件编辑

支持对已有套件的信息进行修改,包括调整关联的文档列表、子套件、标签等内容。

套件复制

支持复制现有需求文档套件,快速创建一份包含相同配置(文档列表、子套件、标签等)的副本。

套件删除

支持单个或批量删除需求文档套件,确保数据的及时清理与更新。

基于套件运行生成测试用例

点击操作栏下拉菜单中的【运行】,系统可统一读取套件内所有关联文档及子套件的内容,作为生成测试用例的依据,跳转至用例生成任务创建页进行后续配置。

批量导入

支持下载 .xlsx、.csv、.json、.yaml 四种格式的导入模版,用户可在本地按规范填写后上传附件完成批量导入,附件大小限制为 20MB。

批量导出

支持选择一批需求文档套件进行统一导出,导出前可选择导出类型(如 Excel 类型),并支持勾选【是否导出全部】。

标签管理

点击列表页【新增标签】按钮,跳转至【配置-标签】页面。创建标签时需填写标签名称,类型默认为【测试套件】,创建完成后可供需求文档套件选用。

使用场景示例

  • 一个复杂项目中,需求被拆分到多个文档(如功能需求文档、接口文档、用户流程说明等),可通过建立套件将相关文档统一管理,并基于套件整体生成测试用例。
  • 支持通过子套件功能实现多层级需求组织,例如将不同模块的文档套件组合为更高层级的父套件,便于大规模项目的分层管理。
  • 在不同开发阶段(如 V1.0、V2.0 版本)维护不同套件并打上对应标签,确保各阶段生成测试用例时引用正确版本的需求集合。
  • 利用批量上传功能快速录入多个需求文档套件,加速测试准备阶段的用例生成效率。

使用方法

新增需求文档套件

  1. 选择项目进入平台后,点击左侧导航栏【测试用例生成】-【需求文档套件】,点击【新增】按钮。



  1. 填写套件名称(必填),在【文档列表】中选择需要关联的需求文档,在【子套件】中选择需要嵌套的子级套件,在【标签】中选择已创建的标签(如有)。确认无误后点击【保存】。



批量导入套件

  1. 在需求文档套件列表页,点击【批量导入】按钮。



  1. 下载对应的模版文件(支持 xlsx、csv、json、yaml 四种格式),按规范填写后选择文件上传,点击【保存】完成导入。附件大小不得超过 20MB。



管理需求文档套件

  1. 在列表页找到目标套件,点击右侧【查看详情】下拉菜单:
    • 编辑:修改套件信息,或调整关联的文档列表、子套件、标签。
    • 复制:基于当前套件快速创建一份副本。
    • 删除:移除该条需求文档套件记录。
    • 运行:跳转至用例生成任务创建页,基于当前套件生成测试用例。



批量导出

  1. 选择需要导出的套件记录,点击【批量导出】,选择导出类型,确认是否导出全部后点击【导出】。



批量删除

  1. 选择需要删除的需求文档套件,点击【批量删除】



  1. 根据需要勾选【是否删除全部数据】,点击【确定】执行删除。



新增标签

  1. 在需求文档套件列表页,点击【新增标签】按钮,跳转至【配置-标签】页面。



  1. 输入标签名称,类型默认为【测试套件】,点击【保存】。创建后的标签可在新增或编辑套件时选用。



注意事项

  • 套件内的文档应具有明确的关联关系,避免无关文档混入影响测试用例生成准确性。
  • 文档内容更新后,请同步更新对应套件,确保套件内文档内容的最新有效。
  • 删除套件不会影响原始需求文档,但基于该套件的生成历史需注意版本一致性管理。
  • 为套件合理命名、添加描述和标签,便于后续快速识别、检索和调用。