再谈机房收费系统文档
2014-06-06 22:21
197 查看
文档就被我草草的写完了，之前一直拖着没有让师父给指导，不看不知道，一看吓一跳，我对于文档的把握还是有很大欠缺的。文档写的也是很潦草，支离破碎啊
我们目前软件开发大多是瀑布模型
文档贯穿软件工程的始终，从前期的项目准备，中期的开发到后期的维护、培训，无不以文档作为工作的依据。
其中重要的文档有软件需求说明书，概要设计说明书，详细设计说明书，数据库设计说明书，用户手册等
写文档大概的目的就是：
1.通过文档让明天加入这个团队的新人也能一起工作，了解所要知道的内容。或团队中的成员离职，不至于影响项目的进行。
2.通过文档可以让维护人员轻松地处理当前项目结束后的维护工作。
3.对客户需要的文档，加以说明软件的功能，客户是软件的需求者，所开发的软件就是为客户服务的，当然要以客户为中心，客户是项目资金的源头，为用户编写文档这个无可厚非
《需求分析说明书》：对于软件开发来说，《需求分析说明书》就好像是盖楼时所用的图纸，是最重要的文档，由项目经理对客户相关部门进行业务调研后编写，语言侧重于从业务的角度描述功能需求。内容涉及三大部分，其一，编写目的、背景、目标任务等公共性语言；其二，功能性需求，将业务梳理成几大功能模块，一级功能下细分二级功能，依次类推，将最终细化的功能按描述、输入、处理和输出进行详细描述；其三，非功能性需求，包括性能、处理能力、进度、界面设计和运行环境的规定。
编写人员：分析员
阅读人员：用户，分析员，测试员，程序员，项目经理
包含；原型图，IPO图，数据流图，数据字典
我所理解的原型图大概类似于这样吧（不对了请指导）
一般用户上下机的IPO图
数据流图
数据字典
《数据库设计说明书》：由项目经理来做，根据《需求分析说明书》在建模工具中设计好逻辑模型和物理模型，然后将其整理到此文档中，文档还包含数据库所有的表结构和相关的字段说明。
编写人员：程序员
阅读人员：程序员，维护人员
包含：概念结构设计 E—R图 逻辑结构设计 物理结构设计 数据库表格信息 数据字典
E-R图
数据库表格信息
《概要设计说明书》：系统的功能分配，模块划分，程序的总体结构，输入输出，运行设计，数据结构设计等做一个大体的设计方向。
编写人员：程序员
阅读人员：主要是项目经理
包含：E—R图，程序系统的结构
《详细设计说明书》：主要包含两部分内容，其一，体系结构的设计，还有就是基础技术；其二，是本文档的核心部分，包括每个细分模块的详细设计说明，包括程序描述、功能、性能、输入项、输出项、算法、流程逻辑、接口、存储分配、注释设计、限制条件、测试计划和尚未解决的问题等内容。本说明书对项目所采用的技术和接口都做了详细的规定，是指导程序员开发的直接工具。
编写人员：程序员
阅读人员：程序员，测试员，维护员
包含：程序系统的详细结构，E—R图，系统流程图，IPO图，数据库表格信息，
上机的流程图：
《用户使用手册》：详细描述系统的功能，性能，用户界面，使用户可以根据此文档掌握如何使用此软件
按标准说，应该由文案写，但在大多数的软件公司中都不设这个职位，因此要么由项目经理写要么由测试人员写，关键看是谁给客户做培训。
包含：安装过程，各功能说明，系统流程图
我们目前软件开发大多是瀑布模型
文档贯穿软件工程的始终，从前期的项目准备，中期的开发到后期的维护、培训，无不以文档作为工作的依据。
其中重要的文档有软件需求说明书，概要设计说明书，详细设计说明书，数据库设计说明书，用户手册等
写文档大概的目的就是：
1.通过文档让明天加入这个团队的新人也能一起工作，了解所要知道的内容。或团队中的成员离职，不至于影响项目的进行。
2.通过文档可以让维护人员轻松地处理当前项目结束后的维护工作。
3.对客户需要的文档，加以说明软件的功能，客户是软件的需求者，所开发的软件就是为客户服务的，当然要以客户为中心，客户是项目资金的源头，为用户编写文档这个无可厚非
《需求分析说明书》：对于软件开发来说，《需求分析说明书》就好像是盖楼时所用的图纸，是最重要的文档，由项目经理对客户相关部门进行业务调研后编写，语言侧重于从业务的角度描述功能需求。内容涉及三大部分，其一，编写目的、背景、目标任务等公共性语言；其二，功能性需求，将业务梳理成几大功能模块，一级功能下细分二级功能，依次类推，将最终细化的功能按描述、输入、处理和输出进行详细描述；其三，非功能性需求，包括性能、处理能力、进度、界面设计和运行环境的规定。
编写人员：分析员
阅读人员：用户，分析员，测试员，程序员，项目经理
包含；原型图，IPO图，数据流图，数据字典
我所理解的原型图大概类似于这样吧（不对了请指导）
一般用户上下机的IPO图
数据流图
数据字典
| 数据项编号 | 数据项名 | 定义 | 描述 |
| 001 | 上机 | 学生通过输入卡号上机操作 | 用户学生上机操作 |
| 002 | 下机 | 输入卡号下机 | 用户学生下机操作 |
| 003 | 结账 | 账目汇总 | 详细的描述了每个操作员的工作情况；充值记录，退卡记录，注册卡 |
编写人员：程序员
阅读人员：程序员，维护人员
包含：概念结构设计 E—R图 逻辑结构设计 物理结构设计 数据库表格信息 数据字典
E-R图
数据库表格信息
| 表名 | 名称 | 描述信息 | 状态 |
| 基本数据设定 | BasicData_Info | 基本数据信息 | 暂时使用 |
| 退卡 | CancelCard_Info | 退卡信息 | 实验中 |
| 日结账单 | CheckDay_Info | 日结账信息 | 实验中 |
| 周结账单 | CheckWeek_Info | 周结账信息 | 实验中 |
| 上机 | Online_Info | 上机信息 | 实验中 |
| 充值 | Recharge_Info | 充值信息 | 实验中 |
| 学生信息 | Student_Info | 学生信息 | 暂时使用 |
| 用户信息 | User_info | 用户信息 | 暂时使用 |
| 值班 | WorkLog_Info | 值班信息 | 实验中 |
编写人员：程序员
阅读人员：主要是项目经理
包含：E—R图，程序系统的结构
《详细设计说明书》：主要包含两部分内容，其一，体系结构的设计，还有就是基础技术；其二，是本文档的核心部分，包括每个细分模块的详细设计说明，包括程序描述、功能、性能、输入项、输出项、算法、流程逻辑、接口、存储分配、注释设计、限制条件、测试计划和尚未解决的问题等内容。本说明书对项目所采用的技术和接口都做了详细的规定，是指导程序员开发的直接工具。
编写人员：程序员
阅读人员：程序员，测试员，维护员
包含：程序系统的详细结构，E—R图，系统流程图，IPO图，数据库表格信息，
上机的流程图：
《用户使用手册》：详细描述系统的功能，性能，用户界面，使用户可以根据此文档掌握如何使用此软件
按标准说，应该由文案写，但在大多数的软件公司中都不设这个职位，因此要么由项目经理写要么由测试人员写，关键看是谁给客户做培训。
包含：安装过程，各功能说明，系统流程图
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐