XXX项目-详细设计说明书

XXX项目
详细设计说明书模板
版本：V3.0.1
北京暴风科技股份有限公司
XXXX年X月
目录
1引言 (1)
1.1文档目的 (1)
1.2文档内容................................................................................ 错误！未定义书签。

1.3术语和缩写 (1)
1.4文档约定................................................................................ 错误！未定义书签。

1.5参考资料 (1)
2子系统1 (1)
2.1模块1 (1)
2.1.1功能设计 (1)
2.1.2服务/接口定义 (2)
2.1.3代码设计 (2)
2.1.4单元测试 (3)
3流程设计 (3)
3.1业务流程1 (3)
3.1.1流程描述 (3)
3.1.2服务定义 (3)
3.1.3代码设计 (3)
3.1.4服务调用设计 (3)
3.1.5单元测试 (3)
4模板补充说明 (3)
4.1关于字体 (3)
4.2关于页眉页脚 (4)
4.3关于图、表 (4)
1 引言
1.1 文档目的
编写本说明书是为了明确并细化XXX系统的设计方案，以及系统代码设计时应遵循的规程和要求等，并作为本系统开发和维护的参考文档。

本说明书的读者对象为项目管理者、项目设计开发者和项目验收者。

1.2 术语和缩写
表1-1
1.3 参考资料
[说明本文件的参考文档。

]
2 子系统1
2.1 模块1
2.1.1 功能设计
[描述本模块包含的功能，明确页面的输入输出项及其与库表的对应关系，定义页面之间的跳转关系。

]
表2-1
表2-2 [页面跳转流程，可选]
图2-1 2.1.2 服务/接口定义
[定义本模块相关的内部和外部服务/接口。

] 2.1.3 代码设计
[用UML定义本模块复杂功能的代码实现逻辑。

]
2.1.4 单元测试
[定义本模块关键服务/接口和功能的单元测试方法和测试用例。

]
3 流程设计
3.1 业务流程1
3.1.1 流程描述
3.1.2 服务定义
[详细定义本流程要调用的服务。

]
3.1.3 代码设计
[用UML定义本模块新建服务的代码实现逻辑。

]
3.1.4 服务调用设计
[详细描述如何调用本系统和外部系统的服务]
3.1.5 单元测试
[定义本流程的单元测试方法和测试用例。

]
4 模板补充说明
4.1 关于字体
●封面题名项目计划一号黑体
●大标题 1 项目目标黑体二号
●一级节标题 1.1质量目标黑体三号
●二级节标题 1.1.1过程质量黑体四号
●三级节及以下标题 1.1.1.1测试过程质量黑体小四号
●正文测试过程质量要求宋体小四号
●表及表题表1-1 宋体五号
●英文和数字字体采取Arial
4.2 关于页眉页脚
●封面：没有页眉页脚；
●版本及目录：页眉为文档名称；页角中的页码采取罗马数字，从Ⅰ开始；
●正文：页眉与版本及目录一致，为文档名称；页码编号采取阿拉伯数字，从1开始。

4.3 关于图、表
●图的对齐方式为“居中对齐”；
●表的对齐方式为“自动调整-根据窗口调整表格”；
●图、表的题注在图、表下方居中显示，格式为“图/表A-B”，其中A为章节号，B为
该章图的顺序编号。

题注通过选中图/表后点击右键选择“插入题注”的方式添加；
●表格表头高0.8CM，行高默认为0.6CM，根据文字行数成倍增加单元格高度，如单元
格内两行文字时，行高2倍高即1.2CM；
●表格内文字设置为垂直居中，并根据相应内容，设置水平居中（短、或者是序列号）、
或左对齐（内容较长的话）。