Skip to main content

设计文档

V-Proto 支持业务需求设计四件套，包括：控件定义、规则说明、处理步骤和参考文档。

1. 设计四件套​

1.1 控件定义​

info
  • 数据来源：记录此控件数据来源表、查询、返回值；
  • 控件定义：记录此控件的功能定义说明。

方法一：添加设计说明

选中控件，切换右侧面板到「说明」视图，可给控件录入设计说明。

img

方法二：说明视图

页面所有控件的设计说明全貌编辑一览，用于专注设计说明录入、对比等操作。

支持从Excel，快速批量复制、黏贴操作。

info

当多个控件说明一致时，可同时选择多个说明单元格，一键全部粘贴。

（目前还未提供右键菜单，可通过 Ctrl+V 快速实现，按住 Ctrl 鼠标点选多个不连续的单元格，按住 Shift 可选择连续的单元格）

img

1.2 规则说明​

支持导入应用说明模板。

一般规则说明
  • 总体说明：固定行；说明此窗体设置及目的及作用等。
  • 前置条件：固定行；当前需要用到的一些基础库和上游信息。
  • 初始状态：固定行；窗体被打开后的初始值、规则、显示内容等设定。
  • 操作角色&阅览权：固定行。
  • 新增、修改、删除规则：说明新建的条件；修改的规则；删除的规则等。
  • 提交规则：说明提交前的规则校验，提交后对状态的影响，对数据的影响等。
  • 其他业务规则：对本窗体中需要单独说明的业务规则或多个字段综合进行说明。

img

1.3 处理步骤​

一般记录本页面所使用的流程步骤，可把流程图上传到此。

img

1.4 参考文档​

一般为法律法规，或者行业内的标准。

img

2. 文档交付​

在 V-Proto 中支持多种文档的输出，以满足不同场景的文档交付。

（1）工作区内导出

文档导出操作，通常在工作区顶栏中，点击如下按钮，再选择对应文档类型即可。

img

（2）模块视图导出

模块视图支持快速导出设计说明文档。

img