功能设计文档模板V1.0

XX-XX功能设计

1.业务说明

详细描述业务场景，可结合需求文档加以说明，必须表达清楚该模块（功能）的完整实际业务场景描述

2.业务流程

实际业务场景的业务执行流程，以业务流程图+详细流程描述的方式说明

例如：

3.界面设计

前端界面呈现的示意图及相应功能的说明

4.参数设计

系统参数设计，需要通过参数化的方式来控制业务流程走向

**本文档的参数自行加到《ERP系统参数说明.xlsx》文档

5.功能设计

为实现该模块（功能），必须具备的完整单一功能说明

6.数据库表设计

**属于该模块（功能）的表统一冠以代表该模块（功能）的前缀

**如果该模块（功能）属于其它模块，额外在本模块前缀的前面冠以大模块前缀

**前缀不得多于2个，例如sys_(系统模块前缀) sys_msg_(系统消息模块前缀)

6.1.sys_user（系统用户表）

说明：该数据表的详细说明

7.内部接口（方法）设计

用于模块（或功能）内部以及其他模块（或功能）调用的方法（接口）

7.1.多字符串加密

功能（方法）的详细描述

7.1.1.功能实现

实现该方法（接口）的设计思路、业务逻辑、数据流程等详细描述，复杂的逻辑配以流程图加以说明。

7.1.2.调用方式

路径：

范围：

私有

本模块

本系统

**在可访问的级别前加注星号

7.1.3.方法调用示例

给出方法调用的示例

7.1.4.参数

sys_id：目标系统代码

7.1.5.返回值

数据格式：User对象（或其它方式）

**必须对所有可能的返回值加以说明，例如错误代码

8.外部接口设计

8.1.获取所有用户接口

实现该接口的设计思路、业务逻辑、数据流程等详细描述，复杂的逻辑配以流程图加以说明。

8.2.访问方式

调用方：

本地前端代码调用

其它系统前端调用

其它系统后端调用

**在可调用的方式前加注星号

访问方式：GET、POST

8.3.接口示例

192.168.0.1/getSSOUrl?sys_id=2B

8.4.参数

传参方式：URL、POST

sys_id：目标系统代码

8.5.返回值

数据格式：json（或其他格式）

**必须对所有可能的返回值加以说明，例如错误代码

9.版本更新

**针对本设计文档的小范围更新说明，每次的更新说明必须注明更新时间

**大范围的改动（例如需求变动、流程变更、业务逻辑重构等）需要重建设计文档，命名规则为当前文档名称加版本号后缀V2.0（多次重建版本号依次递增）