软件系统介绍文档模板 | 您所在的位置:网站首页 › 软件产品简介怎么写 › 软件系统介绍文档模板 |
概述
开发背景
【比如为什么要开发这个系统】 开发目标【该系统需要完成的基本功能,对系统的大体描述】 参考资料【该系统涉及的开源项目等】 设计原则【设计该系统遵守的原则,比如支持多数据库,可移植行,可拓展性等】 需求分析 需求陈述【用平常语言描述该系统的全部功能和细节】 操作用例【描述具体的操作例子,比如登录后进行何种操作】 功能分析划分【分析功能并划分功能块】 系统登录【比如,需要实现两种登录模块,普通登录,管理员登录,并且描述可能出现的各种情况以及问题处理】 用户管理【比如:实现用户显示,添加,删除,修改】 …… 运行环境 总体设计 系统建模 层次方框图【从顶部开始,按照层次分类进行细化】 ER图(实体-联系图)【分析各个对象之间的联系,画图ER图】 接口设计 类图设计【使用UML画出各个类的属性、继承和方法】 接口设计【各个子系统之间的接口和用户接口】 内部接口设计【各个部件是通过何种方式进行连接,比如通过远程数据库,http等】 登录界面设计 用户管理界面设计…… 数据库结构设计【主要是描述】 数据库E-R图 数据库逻辑设计 出错处理【描述如果出错的处理方法】 安全保密设计【描述采用何种方法保证安全性】 详细设计 程序流程图【具体来说就是把经过总体设计得到的各个模块详细的加以描述。】 伪代码编写【使用中文或者英文进行伪代码编写,以后这些伪代码将会成为代码的注释】 实现 编码 代码约定 代码编写原则 测试要点 登录测试要点【描述该如何测试,数据的输入,类型】 主界面测试要点…… 测试结果和总结 维护 维护方法 维护文档 功能拓展方法 |
CopyRight 2018-2019 实验室设备网 版权所有 |