软件系统介绍文档模板
概述
开发背景
【比如为什么要开发这个系统】
开发目标
【该系统需要完成的基本功能，对系统的大体描述】
参考资料
【该系统涉及的开源项目等】
设计原则
【设计该系统遵守的原则，比如支持多数据库，可移植行，可拓展性等】
需求分析
需求陈述
【用平常语言描述该系统的全部功能和细节】
操作用例
【描述具体的操作例子，比如登录后进行何种操作】
功能分析划分
【分析功能并划分功能块】
系统登录
【比如，需要实现两种登录模块，普通登录，管理员登录，并且描述可能出现的各种情况以及问题处理】
用户管理
【比如：实现用户显示，添加，删除，修改】
……
运行环境
总体设计
系统建模
层次方框图
【从顶部开始，按照层次分类进行细化】
ER图（实体-联系图）
【分析各个对象之间的联系，画图ER图】
接口设计
类图设计
【使用UML画出各个类的属性、继承和方法】
接口设计
【各个子系统之间的接口和用户接口】
内部接口设计
【各个部件是通过何种方式进行连接，比如通过远程数据库，http等】
登录界面设计
用户管理界面设计
……
数据库结构设计
【主要是描述】
数据库E-R图
数据库逻辑设计
出错处理
【描述如果出错的处理方法】
安全保密设计
【描述采用何种方法保证安全性】
详细设计
程序流程图
【具体来说就是把经过总体设计得到的各个模块详细的加以描述。】
伪代码编写
【使用中文或者英文进行伪代码编写，以后这些伪代码将会成为代码的注释】
实现
编码
代码约定
代码编写原则
测试要点
登录测试要点
【描述该如何测试，数据的输入，类型】
主界面测试要点
……
测试结果和总结
维护
维护方法
维护文档
功能拓展方法
软件系统介绍文档模板相关推荐
- 软件需求分析文档模板_小议管理软件需求分析
从事管理软件设计,一般都是从用户需求分析开始.从事软件工作的,大概谁都知道需求分析的重要性,可能大部分人都吃过需求分析不充分的亏.兵法云,"谋定而后动".对一个项目而言,需求分析应 ...
- 软件项目管理文档模板目录
01_前期资料 1.方案 2.合同 3.招投标标书 4.立项报告 5.可行性分析报告等 02_项目计划 1.项目功能架构表 2.项目估算表 3.项目预算表 4.项目进度计划表 5.评审项目计划纪要等资 ...
- 软件设计文档示例模板，万能的软件设计文档模板
文章目录 1 设计概述 1.1 功能概述 1.2 非功能约束 2 系统部署图与整体设计 2.1 系统部署图 2.2 下单场景子系统序列图 2.3 退款场景子系统序列图 2.4 退款场景子系统活动图 3 ...
- SCADE Display（OpenGL）软件设计文档生成工具的设计考虑
SCADE Display(OpenGL)软件设计文档生成工具的设计考虑 2018年6月 1 引言 本文档描述在SCADE Display软件设计文档生成工具(以下简称为SDYSDDGEN)的设计过程 ...
- 软件需求说明书(文档模板)
软件需求说明书(文档模板)- - 其中的数据描述部分在实际工作中比较少涉及. 在上一次的文档中增加新模块 业务需求,详细描述为 现状.业务概述.业务组成.业务描述.业务流程. 功能需求也相应作了扩充, ...
- 敏捷开发：软件与文档
也曾尝试过,不带文档的"裸体"前进,可想而知,最后经常造成项目的返工,新来的人员要拼命读以前的人留下的几乎没有注释的源码. 后来尝试过,制订完善的规范,用了大量的软件 ...
- 十三种技术文档模板_竞品分析｜关于产品规划的思考：石墨文档 VS 腾讯文档 VS金山文档...
作者以在线协作文档行业领先的石墨文档.腾讯文档和金山文档为例进行了了竞品分析,通过对几款产品全方位的分析,总结了自己关于石墨文档产品规划的思考. 一.竞品概述 1. 竞品目的 2. 竞品目的 通过对石 ...
- 软件需求分析文档模版
软件需求分析文档模版(转载自国家计算机标准和文件模板) 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素.需求分析是软件定义阶段中的最后一步,是 ...
- 十三种技术文档模板_在线文档，知多少？
不知大家有没有在线编辑文档的习惯 在线编辑文档有许多好处 比如:多平台同步.协作编辑等 今天给大家推荐三款在线文档软件 -- 金山文档.腾讯文档.石墨文档 限于篇幅,这里仅介绍它们对应的 Window ...
- 软件项目文档_什么是软件项目的好的文档？
软件项目文档 开放地理空间(OSGeo)基金会最近参加了Google的第一个文档季节 ,其中Google赞助了高级技术作家为开源项目做出贡献. OSGeo是大约50个地理空间开源项目的总括组织. 多年 ...
最新文章
- 使用WMI对象收集计算机信息
- java 数据库工厂_月光软件站 - 编程文档 - Java - 简单的数据库连接工厂实现
- 干货：排名前16的Java工具类
- ACM一类方程问题的求解[最短路建模] bzoj2118
- C和汇编混合编程--------函数调用后ebp、esp值问题
- (大整数类Biginteger)大斐波数
- Yammer Metrics实现服务指标收集与监控
- 谷歌再遭反垄断起诉：曾试图“扼杀”三星应用商店！
- 管理感悟：可接受的不参加培训的理由
- linux 各文件夹的作用
- 简单版俄罗斯方块程序代码c语言,俄罗斯方块C语言程序代码.DOC
- 28.XAPP1052驱动详解-WinDriver DMA读写流程
- 保姆级透明背景动画导出 —— json格式（Mac系统）
- php paypal 订单查询,php – 成功付款后如何从paypal获取交易详情
- elixir 规格_六家使用Elixir的著名公司-以及为什么做出改变
- Canceled future for execute_request message before replies were done The Kernel crashed while execut
- web将pdf转成图片以及图片转回pdf的方法
- Android手电筒案例
- sht20 python_SHT20 IIC 寄存器概述
- 审视自己也是一种进步