Wiki文档模板

来自ling
跳转至: 导航搜索

lv1 概要设计说明书目录

==文档控制==
==前言==
===文档说明===
===相关术语===
===参考文档===
==应用概述==
===应用背景===
===应用说明及目标===
===应用定位和需求范围===
==典型系统核心业务流程==
===典型的系统核心业务流程一览===
===本系统核心流程交互时序图===
==总体设计==
===总体架构===
====系统架构====
====模块间包依赖关系====
====技术架构====
===开发目录结构===
==接口设计==
===系统外部接口===
===信息模型设计===
===数据文件设计===

lv2 概要设计

==文档说明==
==相关术语==
==参考文档==
<<[[增值税管理系统_L1_概要设计说明书]]>>
==典型系统核心业务流程==
===典型的系统核心业务流程一览===
本模块是系统的核心基础模块,包含如下功能和模块

===本模块核心流程交互时序图===
【文档要求:
请主要描述与本模块相关的业务流程(单模块设计不用考虑端到端流程),描述前后衔接的外部子系统或模块即可;并着重体现与本模块之间的交互关系,要求采用时序图描述;
】


==接口设计==

===子系统间模块提供的服务接口(对外接口)===
【文档要求:不体现详细描述,只体现清单信息,详细内容请指明要参见的《应用模块接口设计文档》。列表中的接口标号与“系统架构图”中的接口编号对应。】

接口编号	需求编号	服务名称	服务描述	服务来源
				
				
				

===子系统间模块调用的服务接口(外部接口)===
【文档要求:不体现详细描述,只体现清单信息,详细内容请指明要参见的《应用模块接口设计文档》。列表中的接口标号与“系统架构图”中的接口编号对应。】
外部服务调用一览:

接口编号	需求编号	服务名称	服务描述	服务来源
							

===模块间接口===
描述应用模块内部各功能点之间可重用功能的接口:
*inf1
*inf2

==功能设计==
功能(子模块)清单:
#xxxx1
#xxxx2

===子模块交互协作图===
*【文档要求:描述重要的本模块内部的“子模块之间”的交互协作图,交互步骤,顺序等内容;描述子模块如何通过组合关系,来实现重要的功能。】
*模块关系和层级

===包图===


===时序图===
无

===子模块1===
*功能描述
[要求描述:从设计角度描述此子模块的用途]
*实现说明
[要求描述:功能实现时的重点说明]
*表结构说明 
[要求描述:表结构设计和重点字段设计说明]
*类图
*时序图
[要求描述:描述重要逻辑类、接口之间的交互图,顺序,以及交互步骤等]
==数据结构设计==
===核心库表设计===

===数据文件设计===
#详细描述模块中使用的数据文件内容以及文件格式
#描述文件的生成与使用过程
#文件处理的各个环节,输入输出的过程图例

详细设计

==模块功能==
==系统的结构==
==表和model设计说明==
==dao设计说明==
==server设计说明==
==view设计说明==
==utils设计说明==
==常见问题==
==快速链接==