某企业全称
详细设计说明书
企业全称
2023年4月3日
目 录
1 引言
1.1 编写目的
1.2 范围
1.3 术语
1.4 参考资料
1.5 约定
2 模块设计
2.1 模块1
2.1.1 描述
2.1.2 用户界面
2.1.3 类设计
2.1.4 处理流程
2.1.5 关联模块
2.1.6 其他程序设计
2.1.7 相关的数据表
2.2 模块2
3 接口设计
4 配置文件说明
5 非功能性需求设计
6 附录
7 图表目录
1引言
1.1编写目的
[编写说明]简要地说明设计的目的。
1.2范围
[编写说明]
简要说明本系统的实现细节,不包括概要设计部分, 也不包括系统中硬件的设计。例如:
1. 细化模块的详细划分。
2. 确定系统的命名规则(模块、类、方法等),确保系统的设计风格与代码的风格一致。
3. 定义模块间接口方法命名标准、入参格式、返回格式。
4. 规定编码规范及其他设计约束。
5. 确定底层类实现所采用的技术框架。
6. 确定选取表现层的技术,及其展示的统一风格。
…
指明本文档的读者。
1.3术语
[编写说明]
列出本文件中用到的专门术语的定义和缩写词的原词组及说明。可以援引概要设计说明书中的相关说明,或省略。