Sailing 之 详细设计说明模板说明

Sailing

Sailing开发平台提供了一整套基于业务域的概念和设计工具, 领域专家和应用开发者可以更快地将调研的成果转化为最终软件产品. 但很多时候, 甲方单位需要提供包括详细设计在内的一系列开发文档, 因此, 也有必要提供一种描述详细设计的文档模板.

此外, Sailing开发平台也在不断发展中, 后续也可能会提供直接根据配置信息来产生详细设计文档的功能.

需包含内容

1. 单据

Sailing中和应用最接近的概念是单据, 因此, 详细设计文档也以单据作为单元来描述. 一个单据对应一套后台实体模型和库表结构, 也表示为前端的一个功能项, 例如: 销售订单就是一个单据.
对单据类型的描述需要说明:

• 单据的名称
• 单据的作用说明
• 单据类型的名称
• 单据类型在整体流程中的位置: 图形说明
• 是否采用版本化
• 归属业务组织类型
• 图标
• 单据的实体模型
  
  • 实体: 多个
    
    • 实体名称
    • 所属模块
    • 说明
    • 字段: 多个
      
      • 名称
      • 字段类型
      • 说明
    • 导航属性说明: 多个
      
      • 名称
      • 类型(子实体|父实体|兄弟实体)
      • 目标实体
  • 附加字段部件(ElementPart)结构: 多个
    
    • 部件名称
    • 所属模块
    • 字段: 多个
      
      • 名称
      • 字段类型
      • 说明
    • 导航属性说明: 多个
      
      • 名称
      • 类型(子实体|父实体|兄弟实体)
      • 目标实体
• 单据的库表结构: 多个
  
  • 表名
  • 所属模块
  • 字段: 多个
    
    • 名称
    • 字段类型
    • 说明
• 基本实体计算规则: 无论什么场景下, 该单据都会有的实体内计算规则
  
  • 使用EntityRule语法描述
• 基本验证: 无论什么场景下, 该单据都需要验证的条件
  
  • 验证节点的说明
    
    • 规则类型
    • 验证字段及内容(文字说明)
• 列表页面项目: 单据列表中要显示的项目. PS: 所有的字段都会出现在高级查询汇总, 但只有主要搜索项会直接显示在搜索条中.
  
  • 序号
  • 名称
  • 描述
  • 对应字段路径
  • 类型
  • 宽度
  • 显示格式
  • 是否隐藏
  • 是否锁定
  • 跳转配置
  • 是否主要搜索项
• 列表页面通用额外功能: 除框架默认的新建, 打开, 保存, 删除, 工作流查询, 相关查询, 打印等功能外的附加功能
  
  • 功能名称
  • 图标
  • 显示条件
  • 禁用条件
  • 对应权限
  • 按钮动作: 文字说明
• 详情页面通用额外功能: 除框架默认的保存, 删除, 提交, 工作流查询, 相关查询, 打印等功能外的附加功能
  
  • 功能名称
  • 图标
  • 显示条件
  • 禁用条件
  • 对应权限
  • 按钮动作: 文字说明

2. 单据类型

一个单据项下可以有多个单据类型, 每种单据类型往往是这个单据在某个具体场景下的细化. 例如: 销售订单这个单据项下又细分了出口销售订单和内贸销售订单, 这种单据类型公用同一套实体模型, 但有各自不同的UI, 流程, 数据流向.

• 单据类型名称
• 单据类型的作用说明
• 单据类型的适用范围
• 编码规则: 文字说明
• 是否允许直接新建
• 单据明细项说明:
  
  • 明细项名称
  • 允许直接新建: 是否允许直接新建
  • 新建时资源: 允许直接新建时, 从什么资源项目选择. 如果没有则完全新建
  • 过滤条件: 从资源选择时需要应用的过滤条件
  • 转换规则: 从资源数据转换到当前数据的规则
• 基本实体计算规则: 该单据类型在流程的任何节点都需要有的计算你规则.
  
  • 使用EntityRule语法描述
• 基本验证: 该单据类型在流程的任何节点都需要有的计算你规则. 文字说明
• 初始化规则: 新建该单据类型时的实体初始化规则
  
  • 字段
  • 规则类型
  • 规则内容说明
• 不做变更控制字段: 如果单据启用了版本控制, 那么对这些字段的修改, 不会引起版本升级.
• 详情页UI:
  
  • 表单组件及布局: 截图说明, 多张
  • 表单内组件关联关系: 文字说明
• 列表页面通用额外功能: 除框架默认的和单据默认的功能按钮外, 额外的功能.
  
  • 功能名称
  • 图标
  • 显示条件
  • 禁用条件
  • 对应权限
  • 按钮动作: 文字说明
• 详情页面通用额外功能: 除框架默认的保存, 删除, 提交, 相关查询, 打印等功能外的附加功能
  
  • 功能名称
  • 图标
  • 显示条件
  • 禁用条件
  • 对应权限
  • 按钮动作: 文字说明
• 打印格式
  
  • 名称
  • 模板: 附件信息提供
• 工作流
  
  • 流程图: 图形说明
  • 说明: 总体说明
  • 工作流启动前置条件: 提交前, 附加的验证. 文字说明
  • 节点
    
    • 节点名称
    • 节点类型: 开始, 结束, 审批, 人工, 自动
    • 状态: 当工作流停留在该节点时, 单据的状态. 开始节点没有状态
    • 子状态: 当工作流停留在该节点时, 单据的子状态. 开始节点没有状态
    • 节点作用说明:
      
      • 审批节点:
        
        • 审批模式: 常规, 会审
        • 合并审批人: 上一级审批是同一个人的话, 此节点的审批结果和上一级审批相同
        • 审批参与人: 文字描述
        • 自动通过条件: 满足条件自动通过, 验证器写法
        • 自动通过动作: 自动通过后, 需要执行的动作, 文字描述
        • 自动拒绝条件: 满足条件自动拒绝, 验证器写法
        • 自动拒绝动作: 自动拒绝后, 需要执行的动作, 文字描述
        • 自动跳过条件: 满足条件自动跳过, 验证器写法
        • 自动跳过动作: 自动跳过后, 需要执行的动作, 文字描述
        • 人工通过动作: 人工通过后, 需要执行的动作, 文字描述
        • 人工通过动作: 人工通过后, 需要执行的动作, 文字描述
        • 节点流转条件: 满足条件才能流转到下一节点: 文字说明
      • 自动节点:
        
        • 动作
          
          • 执行条件: 满足条件才能执行动作. 文字说明
          • 需要执行的动作: 文字说明
      • 人工节点:
        
        • 直接通过条件: 满足条件直接跳过节点. 文字描述
        • 参与人: 停留在该节点时, 可以操作的人员范围. 文字描述
        • 节点流转条件: 满足条件才能流转到下一节点: 文字说明
        • 关联任务模板: 流程停留在该节点时, 会向参与人发送相关任务. 文字说明
        • UI变化: 流程停留在该节点时, UI的变化内容
          
          • 能否修改: 可修改, 不可修改, 有条件修改
          • 可编辑项列表: 当能否修改为有条件修改时, 参考该列表
          • 需隐藏项目列表:
          • 额外功能: 单据流程停留在该节点时才有的功能项
            
            • 功能名称
            • 图标
            • 显示条件
            • 禁用条件
            • 对应权限
            • 按钮动作: 文字说明
      • 结束节点:
        
        • 是否回到起点: 这种结束节点相当于把单据回到了流程开始前的状态
    • 节点流转路径
      
      • 条件: 满足条件才流转到下一个节点
      • 下一节点: 流转的目标
• 选单UI: 其他模块需要选择该单据类型的数据时, 使用的数据选择页面. 选单页面是对话框的形式, 对话框分多页, 向导式呈现.
  
  • 每种数据的UI用多个截图说明
• 相关报表
  
  • 名称
  • 内容: 文字说明
• 任务模板
• 消息模板
• 预警
• 统计图表

3. 单据转换

多种单据通过单据转换串联在一起形成单据链, 以此来表示业务流程. 框架也通过单据转换中隐含的数据对应管理来做数量金额的勾稽关系控制并出具相应查询统计.

• 说明
• 业务场景名称
• 特定业务场景的流程中的位置: 图示
• 上游单据-单据类型
• 下游单据-单据类型
• 数据转换项目名称
  
  • 来源属性路径
  • 目标属性路径
  • 选单过滤条件
  • 附加来源数据
    
    • 数据源
    • 过滤条件
  • 转换规则:
    
    • 字段
    • 规则类型
    • 规则内容说明
  • 验证规则: 文字说明
  • 反写规则: 文字说明