目 录
一、引言 1
1.1 编写目的 1
1.2 命名规范 1
1.3 参考资料 1
1.4 相关文档 1
1.5 涉及名词解释 1
1.6 版本更新记录 2
二、整体设计 2
2.1 运行环境 2
2.3 子系统清单 3
2.4 功能模块清单 3
三、数据库设计 5
四、系统功能使用设计 10
五、功能模块设计 19
六、存储过程设计 25
七、接口设计 29
7.1 用户接口 29
7.2 外部接口 29
7.3 内部接口 29
八、角色授权设计 30
九、系统错误处理 30
9.1 出错信息管理 30
9.2 故障预防与补救 30
9.3 系统维护设计 31
9.3.1 编码规范化 31
9.3.2 编码模块化 31
9.3.3 始终收集反馈 31
9.3.4错误日志 31
十、项目测试计划 31
一、引言
1.1编写目的
在完成对“书籍影视交流平台”系统需求分析的基础上,我们依据《需求规格说明书》对该系统进行了设计,为了文档化对系统的设计,故编写此文档。
1.2 命名规范
数据库表名、字段名使用大写开头的英文进行命名。
所有函数使用驼峰命名法。
所有前端页面使用小写英文单词来命名。
1.3 参考资料
[1] 吕云翔.软件工程实用教程[M].北京:清华大学出版社,2015.
1.4 相关文档
[1] 《需求规格说明书》
[2] 《软件开发计划书》
[3] 《部署文档》
[4] 《测试报告》
[5] 《用户使用说明书》
1.5 涉及名词解释
[1] 用户:包含未注册用户以及已经完成注册的用户,在平台中主要进行交互的对象。
[2] 小组管理员:指在参与小组中的一个负责的对象,能够对其小组的帖子进行管理。
[3] 系统管理员:则是指整个平台的管理员,与实际平台的功能等等关联不大。
1.6 版本更新记录
表1-1 版本更新记录表
版本 更新者 更新 更新纪要 完成度
v1.0.0 2020.4.19 项目创建 暂无
二、整体设计
2.1 运行环境
使用Windows系统进行开发,开发环境如下:
操作系统:Windows 10 + Ubuntu 16.04
数据库系统:MySQL
IDE:Visual Studio Code
测试工具:Google Chrome
编码方式:UTF-8
运行环境如下:
操作系统:Windows、Android
运行后端:Flask
运行前端:Vue.js
浏览器:IE9及以上