功能设计文档模板V1.0
VBRAS-mac-trigger功能-开发设计文档-模板-v1.0
VBRAS-mac-trigger功能-开发设计文档一、概念约定二、项目背景2.1 用户规格（该项开发测试、经理填写）2.2需求背景为了方便wlan业务更便捷的承载与手、ipad等移动终端，设计出基于mac快速认证的无感知认证方案，用以简化认证操作，优化用户体验。
该方案中，为了继续兼容原portal 业务，该方案仅对原有portal架构做了扩展，新增了mac绑定服务器（或改造原portal服务器增加mac绑定和查询功能）完成对用户mac绑定的查询。
三、项目设计3.1配置和展示方式设计（注意友商分析对比）1、配置方式：⑴、采用开关式设计，通过一条命令开关实现功能控制。
⑵、支持配置恢复和配置概览。
2、配置相关文件与命令：注：基于以上配置命令与接口，暂定于配置文件与portal相关文件同一。
3.2功能点设计按照普通portal接入进行组网。
AAA-----Vbras-----AP------客户端，p服务器配置略)。
由ac对接入用户(无线、有线)做portal认证，在原portal server和AAA基础上新增mac-trigger server（可能与portal为同一服务器）。
3.3功能流程设计用户通过限时流量触发机制启动mac快速认证，由ac通过portal协议报文和mac绑定服务器交互完成用户的绑定查询；如果对应mac有绑用户，则mac绑定服务器通知portal 服务器（或mac绑定服务器单独直接）向ac发起针对该用户的portal认证，认证成功后，ac放行用户。
如果对应mac未查询到绑定用户，则ac向用户推送portal页面，进行普通的portal认证。
3.4关键数据结构设计1、关键宏定义：无2、数据结构定义typedef struct{u8 version; /* portal协议版本号*/u8 type; /* 报文类型*/u8 auth_mode; /* 认证方式*/u8 srv; /* 保留字段，值为0 */u16 serial_no; /* 报文的序列号网络序*/u16 req_id; /* 请求id 有BAS设备随机产生主机序*/u32 user_ip; /* Portal用户的IP地址*/u16 user_port; /* 目前没有用到，在所有报文中其值为0 */u8 err_code; /* 错误码*/u8 attr_num; /* 可变长度的属性字段个数*/unsigned char authenticator_MD5[MD5_DATA_LEN]; /* 用MD5算法实现的验证字*/} __attribute__((packed)) portal_header_t;3. 全局变量定义无四、checklist五、测试建议（希望测试重点验证部分）注意核对用户不同状态上线时触发的阶段报文内容区别。
软件详细设计文档模板
Xxx系统详细设计修改记录目录1 背景 (1)2 名词解释 (1)3 设计目标 (1)3.1 实现的功能 (1)3.2 设计的性能指标 (1)4 系统环境（可选） (1)4.1 相关软件及硬件 (1)4.2 系统限制 (1)5 设计思路及折衷 (1)5.1 方案一 (2)5.2 方案二 (2)5.3 对比和折衷 (2)6 系统设计 (2)6.1 架构设计 (2)6.1.1 (2)6.1.2 (2)6.2 模块设计 (2)6.2.1 Xxx模块 (2)6.2.2 (2)6.2.3 (2)6.3 数据库设计 (2)6.4 服务接口说明 (3)6.4.1 Xxx接口 (3)7 非功能性需求的设计 (3)7.1 性能设计 (3)7.2 安全设计 (4)7.3 容错设计 (4)7.4 兼容性设计 (4)8 设计评审意见 (4)1 背景对系统的需求背景做概述，不用写太详细，主要是为了进一步对齐核心需求。
2 名词解释1.AAAA：针对文档中出现的专有名词，进行必要的说明3 设计目标3.1 实现的功能描述系统主要提供的功能模块3.2 设计的性能指标1.数据量在百万级时，平均查询耗时<100ms4 系统环境（可选）4.1 相关软件及硬件1.java: (版本)2.springboot:（版本）3.Mysql: (版本), 存储引擎4.Rabbitmq: (版本)5.ES:(版本)4.2 系统限制1.排序操作只能在1000数据内进行排序，否则，耗时会有所增加。
2.5 设计思路及折衷描述在思考方案和技术选型时，对若干方案的优劣势进行对比，并根据方案和业务需求的匹配度，选择合适的方案。
5.1 方案一5.2 方案二5.3 对比和折衷6 系统设计6.1 架构设计6.1.1图文描述系统内部各模块，和各模块之间的关系6.1.2图文描述当前系统和外围相关系统的关系6.2 模块设计要实现的系统各功能模块，通过文字，用例图，时序图，流程图，泳道图等来描述。
概要设计说明书-模板
XXX概要设计说明书（版本V1.0）二〇一八年十月文档信息修订表目录1.引言 (1)1.1编写目的 (1)1.2背景 (1)1.3定义 (1)1.4参考资料 (1)2.总体设计 (1)2.1需求规定 (1)2.1.1 系统功能要求 (1)2.1.2 系统性能要求 (1)2.1.3 输入输出要求 (2)2.1.4 数据管理能力要求 (2)2.1.5 故障处理要求 (2)2.1.6 其他专门要求 (2)2.1.7 系统界面要求 (2)2.2运行环境 (2)2.2.1 设备 (2)2.2.2 支持软件 (2)2.2.3 接口 (2)2.2.4 控制 (2)2.3基本设计概念和处理流程 (2)2.4结构 (2)2.5功能需求与系统模块的关系 (3)2.6人工处理过程 (3)2.7尚未解决的问题 (3)3.接口设计 (3)3.1用户接口 (3)3.2外部接口 (3)3.3内部接口 (3)4.运行设计 (4)4.1运行模块组合 (4)4.2运行控制 (4)4.3运行时间 (4)5.系统数据结构设计 (4)5.1逻辑结构设计要点 (4)5.2物理结构设计要点 (4)5.3数据结构与程序的关系 (4)6.系统出错处理设计 (4)6.1出错信息 (4)6.2补救措施 (5)6.3系统维护设计 (5)XXXX概要设计说明书1.引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。
1.2背景a 待开发的软件系统的名称b 列出本项目的任务提出者、开发者、用户及将运行该软件的计算机站（中心）1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有关的参考文件，如：本项目经核准的计划任务书或合同，上级机关的批文；属于本项目的其他已发表文件；本文件中引用的文件、资料，包括要用到的软件开发标准。
列出文件编号、发表日期和出版单位。
2.总体设计2.1需求规定2.1.1 系统功能要求2.1.2 系统性能要求2.1.3 输入输出要求2.1.4 数据管理能力要求2.1.5 故障处理要求2.1.6 其他专门要求2.1.7 系统界面要求2.2运行环境简要说明对本地系统运行环境的规定。
软件工程详细设计文档模板
软件开发中心Software Development Center 详细设计说明书项目名称<项目名称>文档类别<文档类别>文档编号<文档编号>版本<V1.0>密级<秘密>二〇二一年三月十五日版本修订记录目录1引言1.1.编写目的{简要说明编写这份详细设计说明书的目的，指出预期的读者。
本详细设计说明书的编写目的是为了说明程序系统的各个层次中的每个软件对象（包括每个模块和程序）的设计考虑，以向系统实现（编码和测试）阶段提供关于程序系统实现方式的详细描述，从而成为编码的技术基础。
本详细设计说明书的适用读者为：软件开发者、测试人员}1.2.项目概况{1.说明待开发的软件系统的名称2.列出本项目的任务委托单位、开发单位、协作单位、用户单位3.说明项目背景，叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。
如果本次开发的软件系统是一个更大的系统的一个组成部分，则要说明该更大系统的组成和介绍本系统与其它相关系统的关系和接口部分4.保密说明：本项为可选项，一般的软件公司都会要求对软件开发的概要设计文档进行保密，不允许被复制、使用和扩散到公司之外的范围，如果需要强调则允许做相关的保密说明5.版权说明：本项为可选项，若有必要，才要作有关的描述。
}1.3.术语定义{列出本文档中所引用到的专门术语的定义和首字母缩写词、缩略语的原文，以便对详细设计说明书进行适当的解释}1.4.参考资料{列出所本文档所使用的参考资料，包括：A 本软件开发所经核准的合同或标书或可行性报告等文档B 软件开发计划书C 需求分析报告D 测试方案（若存在初稿的话）E 概要设计说明书F 与本项目有关的已发表的文件或资料G 本文件中各处引用的文件、资料，所采用的软件开发标准和规范注意：必须列出文件、资料的作者、标题、编号、发表日期和出版单位，以说明这些文件资料的来源。
CAR_PT800_汽车制造_功能设计方案V1.0
CAR060.功能文档汽车制造业条码系统化――新大陆PT800设备应用方案文档作者: CONSULTANTS（罗忠秋）创建日期: 2008-5-8更新日期: 2008-6-28控制编码: CAR/I4UG当前版本: 1.0审批签字:客户项目经理新大陆项目经理客户业务负责拷贝数量_____1 文档控制1.1 更改记录1.2 审阅1.3 分发人员目录1 文档控制 (1)2 编写说明 (4)2.1 系统概述 (4)2.2 打印样卡 (4)2.3 打印设备 (5)3 功能介绍 (6)3.1 用户登录 (6)3.1.1选择日期班次 (6)3.1.2输入用户密码 (6)3.2 功能设置 (7)3.2.1设置机号 (7)3.2.2打印设置 (7)3.3 总成测试 (7)3.3.1功能流程图 (7)3.3.2扫描总成条码 (8)3.3.3选择测试结果 (8)3.3.4选择缺陷 (8)3.3.5浏览数据 (9)3.4 总成返修 (10)3.4.1功能流程图 (10)3.4.2扫描总成条码 (10)3.4.3扫描缺陷代码 (10)3.4.4选择返修原因 (11)3.4.5总成条码浏览 (11)3.5 总成检验 (11)3.5.1功能流程图 (11)3.5.2扫描总成条码 (12)3.5.3选择检验结果 (12)3.5.4选择总成缺陷 (12)3.5.5选择缺陷原因 (13)3.6 总成料架组合 (13)3.6.1功能流程图 (13)3.6.2扫描料架条码 (13)3.6.3打印总成料架信息 (14)3.6.4浏览料架总成条码 (14)3.7 总成发货 (14)3.7.1功能流程图 (14)3.7.2选择单号 (15)3.7.3扫描料架条码 (15)3.7.4浏览料架条码 (15)3.8 总成返修 (15)3.8.1功能流程图 (15)3.8.2选择供应商 (16)3.8.3选择材料 (16)3.8.4产品流转跟踪卡打印 (17)3.9 物料发货 (17)3.9.1功能流程图 (17)3.9.2选择物料清单号 (18)3.9.3扫描包装条码 (18)3.9.4数据浏览 (19)3.10 成品卡1(进热卡2) (19)3.10.1功能流程图 (19)3.10.2读取产品流转跟踪卡 (19)3.10.3选择零件 (20)3.10.4打印成品卡1 (20)3.10.4浏览进热卡号 (20)3.10.5成品卡1(进热卡)卡样 (20)3.11 热处理进炉 (21)3.11.1功能流程图 (21)3.11.2扫描热处理炉号 (21)3.11.3扫描进热卡 (21)3.11.4扫描进热卡 (22)3.12 出热卡2 (22)3.12.1功能流程图 (22)3.12.2扫描热处理炉号 (22)3.12.3扫描进热卡 (23)3.12.4输入零件数量 (23)3.12.5浏览出热卡号 (23)3.12.6出热卡样卡 (23)3.13 成品卡2(非小总成) (24)3.13.1功能流程图 (24)3.13.2扫描出热卡 (24)3.13.3打印成品卡 (24)3.13.4浏览打印 (25)3.13.5成品卡2样卡 (25)3.14 成品卡2(小总成) (25)3.14.1功能流程图 (25)3.14.2扫描出热卡 (26)3.15 装配上线 (26)3.15.1功能流程图 (26)3.15.2扫描总成条码 (26)3.15.3扫描装配卡 (26)3.15.4扫描装配卡 (26)3.16 读流转卡打印 (27)3.16.1重打流转跟踪卡 (27)4 异常现象及解决办法 (28)5 已结及未结的问题 (29)5.1 未结的问题 (29)5.2 已结的问题 (29)2 编写说明本功能文档主要适用于实际业务流程中，对条码系统化业务相关的管理人员和操作人员。
软件架构设计文档模板
项目名称软件架构设计文档版本 <V1.0>修订历史记录目录1.简介51.1目的51.2范围51.3定义、首字母缩写词和缩略语51.4参考资料51.5概述52.整体说明52.1简介52.2构架表示方式52.3构架目标和约束53.用例视图63.1核心用例63.2用例实现64.逻辑视图64.1逻辑视图64.2分层64.2.1应用层64.2.2业务层74.2.3中间层74.2.4系统层74.3架构模式74.4设计机制74.5公用元素及服务75.进程视图76.部署视图77.实施视图87.1概述87.2层87.3部署88.数据视图89.大小和性能810.质量811.其它说明812.附录A 指南813.附录B 规范914.附录C 模版915.附录D 示例9软件架构设计文档1.简介软件构架文档的简介应提供整个软件构架文档的概述。
它应包括此软件构架文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述1.1目的本文档将从构架方面对系统进行综合概述，其中会使用多种不同的构架视图来描述系统的各个方面。
它用于记录并表述已对系统的构架方面作出的重要决策本节确定此软件构架文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。
应确定此文档的特定读者，并指出他们应该如何使用此文档1.2范围简要说明此软件构架文档适用的范围和影响的范围1.3定义、首字母缩写词和缩略语本小节应提供正确理解此软件构架文档所需的全部术语的定义、首字母缩写词和缩略语。
这些信息可以通过引用项目词汇表来提供1.4参考资料本小节应完整地列出此软件构架文档中其他部分所引用的所有文档。
每个文档应标有标题、报告号（如果适用）、日期和出版单位。
列出可从中获取这些参考资料的来源。
这些信息可以通过引用附录或其他文档来提供1.5概述本小节应说明此软件构架文档中其他部分所包含的内容，并解释此软件构架文档的组织方式2.整体说明2.1简介在此简单介绍软件架构的整体情况，包括用例视图、逻辑视图、进程视图、实施视图和部署视图的简单介绍。
(完整word版)软件架构设计文档实用模板
项目名称错误!未指定书签。
版本 <V1.0>修订历史记录目录1.简介51.1目的51.2范围51.3定义、首字母缩写词和缩略语51.4参考资料51.5概述52.整体说明52.1简介52.2构架表示方式52.3构架目标和约束53.用例视图63.1核心用例63.2用例实现64.逻辑视图64.1逻辑视图64.2分层64.2.1应用层64.2.2业务层74.2.3中间层74.2.4系统层74.3架构模式74.4设计机制74.5公用元素及服务75.进程视图76.部署视图77.实施视图87.1概述87.2层87.3部署88.数据视图89.大小和性能810.质量811.其它说明812.附录A 指南813.附录B 规范914.附录C 模版915.附录D 示例9错误!未指定书签。
1.简介软件构架文档的简介应提供整个软件构架文档的概述。
它应包括此软件构架文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述1.1目的本文档将从构架方面对系统进行综合概述，其中会使用多种不同的构架视图来描述系统的各个方面。
它用于记录并表述已对系统的构架方面作出的重要决策本节确定此软件构架文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。
应确定此文档的特定读者，并指出他们应该如何使用此文档1.2范围简要说明此软件构架文档适用的范围和影响的范围1.3定义、首字母缩写词和缩略语本小节应提供正确理解此软件构架文档所需的全部术语的定义、首字母缩写词和缩略语。
这些信息可以通过引用项目词汇表来提供1.4参考资料本小节应完整地列出此软件构架文档中其他部分所引用的所有文档。
每个文档应标有标题、报告号（如果适用）、日期和出版单位。
列出可从中获取这些参考资料的来源。
这些信息可以通过引用附录或其他文档来提供1.5概述本小节应说明此软件构架文档中其他部分所包含的内容，并解释此软件构架文档的组织方式2.整体说明2.1简介在此简单介绍软件架构的整体情况，包括用例视图、逻辑视图、进程视图、实施视图和部署视图的简单介绍。
《软件架构设计文档》模板
目 录1.文档简介31.1 文档目的31.2 文档范围3 1.3 定义、缩写词和缩略语3 1.4参考资料3 2.架构描述方式32.1 架构视图阅读指南32.2 图表与模型阅读指南4 3.架构设计目标43.1 关键功能43.2 关键质量属性43.3 业务需求和约束因素5 4.架构设计原则54.1 架构设计原则54.2 备选架构设计方案及被否原因5 4.3架构设计对后续工作的限制（详设，部署等）5 5.逻辑架构视图65.1 职责划分与职责确定 65.2 接口设计与协作机制75.3重要设计包96.开发架构视图10 6.1 Project 划分106.2Project 110 6.2.1 Project 目录结构指导11 6.2.2程序单元组织11 6.2.3框架与应用之间的关系（可选）116.3Project 2 ......126.4Project n ..........12 7.运行架构视图12 7.1 控制流组织127.2 控制流的创建、销毁、通信13 7.3加锁设计13 8.物理架构视图13 8.1 物理拓扑138.2 软件到硬件的映射148.3 优化部署159. 数据架构视图159.1 持久化机制的选择169.2 持久化存储方案169.3 数据同步与复制策略1610. 关键质量属性的设计原理161. 文档简介［帮助读者对本文档建立基本印象，并为阅读后续内容扫清障碍。
］1.1 文档目的［文档目的，非项目目的。
否则造成同一项目多个文档之间的内容重复，不利于文档维护。
本小节应指明文档针对的读者对象，最好列出各种读者角色，并说明每种读者角色应该重点阅读的章节。
］1.2 文档范围［文档的Scope，非项目的Scope。
否则造成同一项目多个文档之间的内容重复，不利于文档维护。
］1.3 定义、缩写词和缩略语［集中列举文档中的定义、缩写词和缩略语。
］1.4 参考资料［本项目经审核的计划书、合同、上级批文；本项目的其他已发表文件；本文档引用的文件资料，如软件开发标准。
产品文档模板
产品文档模板一、引言产品文档是用于描述产品功能、设计和技术细节的重要文档。
它为产品开发团队、用户和其他相关方提供了一个全面了解产品的工具。
本文档提供了一个通用的产品文档模板，帮助读者编写规范、准确的产品文档。
二、产品概述（这部分应该包含产品的名称、版本、主要特点和目标用户等信息，以下为示例）1. 产品名称：XXX（填写你的产品名称）2. 版本：v1.0（填写产品的版本号）3. 主要特点：（列出产品的主要特点，可以按照重要性排列）a) 特点1：（给出特点1的详细描述）b) 特点2：（给出特点2的详细描述）c) 特点3：（给出特点3的详细描述）4. 目标用户：（描述产品的目标用户群体）三、功能需求（这部分应该详细描述产品的功能需求，以下为示例）1. 功能1：（给出功能1的详细描述，包括输入、输出和处理逻辑等）2. 功能2：（给出功能2的详细描述，包括输入、输出和处理逻辑等）3. 功能3：（给出功能3的详细描述，包括输入、输出和处理逻辑等）四、设计和架构（这部分应该描述产品的设计和架构，以下为示例）1. 总体设计：（描述产品的总体设计，可能包括软件和硬件的组成）2. 模块设计：（描述产品的各个模块的功能和相互关系）3. 数据库设计：（描述产品使用的数据库结构和数据流程）4. 界面设计：（描述产品的用户界面设计和交互方式）五、性能和安全需求（这部分应该描述产品的性能和安全需求，以下为示例）1. 性能要求：（描述产品的性能指标，比如响应时间、吞吐量等）2. 安全要求：（描述产品的安全性要求，包括用户认证、权限控制等）3. 可靠性要求：（描述产品的可靠性要求，比如故障恢复、备份等）六、测试计划（这部分应该描述产品的测试计划，包括测试目标、方法和时间表等）1. 测试目标：（列出产品测试的主要目标）2. 测试方法：（描述产品测试所采用的方法和工具）3. 测试时间表：（给出产品测试的时间安排）七、部署和维护（这部分应该描述产品的部署和维护需求，以下为示例）1. 部署环境：（描述产品的部署环境要求）2. 安装和配置：（描述产品的安装和配置步骤）3. 维护计划：（描述产品的维护计划，包括更新和升级策略）八、问题和解决方案（这部分应该列出产品开发过程中可能遇到的问题和相应的解决方案）1. 问题1：（描述问题1的详细信息，并给出解决方案）2. 问题2：（描述问题2的详细信息，并给出解决方案）3. 问题3：（描述问题3的详细信息，并给出解决方案）九、变更记录（这部分应该记录产品版本的变更历史，包括版本号、修改内容和日期等）1. v1.0：初始版本（填写初始版本的变更内容和日期）2. v1.1：修复了功能1的BUG（填写修复的内容和日期）3. v1.2：添加了功能2（填写新增的内容和日期）十、附录（这部分收录产品文档中使用到的附加信息，如术语解释、参考资料等）1. 术语解释：（列出文档中使用到的专业术语的解释）2. 参考资料：（列出产品开发过程中参考的相关资料）以上是一个通用的产品文档模板，读者可以根据自己的实际需求进行适当的修改和调整。
软件文档模板
软件文档模板一、文档概述。
本文档旨在为软件开发人员提供一个标准的软件文档模板，以便他们能够按照统一的格式和规范编写软件文档。
通过本文档，开发人员可以清晰地了解如何组织和呈现软件文档的内容，确保文档的完整性和规范性。
二、文档结构。
本文档包括以下几个部分：1. 标题，软件名称。
2. 版本信息。
3. 文档目的。
4. 文档范围。
5. 文档约定。
6. 背景介绍。
7. 功能描述。
8. 界面设计。
9. 数据结构。
10. 系统流程。
11. 使用说明。
12. 常见问题解答。
13. 附录。
三、版本信息。
版本号，V1.0。
修订日期，XXXX年XX月XX日。
修订内容，初版发布。
四、文档目的。
本文档的目的是为了规范软件文档的编写，统一文档格式，提高文档的质量和可读性，方便开发人员和用户了解软件功能和使用方法。
五、文档范围。
本文档适用于所有软件开发人员，包括但不限于需求分析人员、设计人员、开发人员、测试人员等。
六、文档约定。
1. 本文档中的所有术语和缩写均按照行业通用标准进行解释和使用。
2. 文档中的示例和截图仅供参考，实际情况以软件实际版本为准。
3. 如有任何疑问或建议，请及时与文档编写者联系。
七、背景介绍。
在这一部分，我们将介绍软件的背景信息，包括软件的开发目的、所属行业、市场需求等内容。
通过背景介绍，读者可以更好地理解软件的定位和意义。
八、功能描述。
在这一部分，我们将详细描述软件的各项功能，包括主要功能和辅助功能。
通过功能描述，读者可以清晰地了解软件的功能特点，为后续的使用说明提供基础。
九、界面设计。
在这一部分，我们将展示软件的界面设计，包括主界面、各个功能模块的界面设计等。
通过界面设计，读者可以直观地了解软件的界面风格和操作方式。
十、数据结构。
在这一部分，我们将介绍软件的数据结构，包括数据库设计、数据表结构等内容。
通过数据结构的介绍，读者可以深入了解软件的数据存储方式和数据处理逻辑。
十一、系统流程。
在这一部分，我们将描述软件的系统流程，包括各个功能模块之间的交互流程、数据传递流程等内容。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
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（多次重建版本号依次递增）。