软工视频和文档都已经完成了,接下来该好好地总结一下喽。
其实文档的编写主要是按照软件的生存周期来的,每个周期都有相应的文档。
文档名称 | 编写阶段 | 编写人员 | 预期读者 | 目的 |
可行性研究报告 | 制定计划 | 分析员、管理员 | 软件分析员、用户、维护人员 | 分析软件是否值得开发(从技术,经济,操作,法律,社会效益上进行分析)——是否可以做 |
项目开发计划 | 需求分析—设计 | 开发人员 | 管理人员、开发人员 | 对费用、时间、进度、人员组织、硬件设备的配置、开发环境和运行环境的配置进行说明 |
软件需求说明书 | 需求分析—设计—编码 | 开发人员 | 开发人员、用户 | 描述软件的功能和性能以及软件的约束范围——做什么 |
数据要求说明书 | 需求分析—设计—编码 | 分析员、开发员 | 设计人员、测试人员 | 了解系统中各项功能和非功能性需求实现时所需要的数据,根据此数据设计数据库 |
用户手册 | 需求分析—设计—编码 | 开发人员 | 用户 | 为了给使用者提供一个使用指南 |
概要设计 | 设计 | 管理人员、开发人员 | 设计人员、开发人员、测试人员 | 软件的总的体系结构——怎么做 |
详细设计文档 | 设计 | 开发人员 | 测试人员、开发人员、维护人员 | 表示出软件结构的图表,完成算法设计、数据结构设计、物理设计等,详细地描述的逐个模块——怎么做 |
数据库设计文档 | 设计 | DBA、架构师、程序员 | 开发人员 | 提供了数据库设计的可视性以及软件支持所需的信息 |
测试计划 | 设计—编码 | 开发人员 | 测试人员 | 确定了测试项,要测试的特征、测试任务,谁来完成每项任务以及需要制定应急方案的所有风险等 |
操作手册 | 编码 | 开发人员 | 操作员、用户 | 告诉使用者,本系统提供了哪些功能,以及如何正确地、有效地来使用这些功能。 |
测试分析报告 | 测试 | 测试人员 | 开发人员、维护人员 | 对测试的结果以及测试的数据等加以记录和分析总结 |
项目开发总结报告 | 测试 | 管理人员 | 管理人员 | 以方便我们在以后的项目开发中来更好的实施项目的制定开发 |
维护文档 | 维护 | 维护人员 | 维护人员 | 方便以后的维护工作 |
开发进度月报 | 整个开发期 | 管理人员 | 管理人员 | 本月完成的情况和下月的计划 |
在写文档的时候还会用到很多的图,下面来总结一下各种图
1.系统流程图
是描述系统物理模型的一种传统工具。它是表达数据在系统各部件之间流动的情况,而不是对数据加工处理的控制过程,它是物理数据流图而不是程序流程图。系统流程图形象的呈现了软件的功能,即使不懂软件的人也可以轻松的看懂,可以说它是软件设计师与用户之间沟通、交流的有效工具。
是对数据描述的集中管理,它的功能是存储和检索各种数据描述,数据字典是进行详细的数据收集和数据分析所获得的主要成果。用来定义数据流图中各个成分的具体含义。
3.数据流程图
从数据传递和加工角度,以图形方式来表达系统的逻辑功能、数据在系统内部的逻辑流向和逻辑变换过程.建立系统的功能模型。
描述信息流和数据从输入移动到输出的过程所经受的变换,它只是描绘数据在软件中流动和被处理的逻辑过程。
4.E-R图
也称实体-联系图(EntityRelationship Diagram),提供了表示实体类型、属性和联系的方法,用来描述现实世界的概念模型。
5.HIPO图:层次图(H图)+IPO图
它可以描述软件总的模块层次结构—H图(层次图)
可以描述每个模块输入/输出数据,处理功能及模块代用的详细情况——IPO图
HIPO图以模块分解的层次性以及模块内部输入,处理及输出三大基本部分为基础建立的。
6.结构图
是软件系统的模块层次结构
7.PAD图(问题分析图)
指问题分析图,是日本日立公司于1979年提出的一种算法描述工具,它是一种由左往右展开的二维树型结构。PAD图的控制流程为自上而下、从左到右地执行。
8.warnier图
9.Jackson图
10.N-S图
又称盒图,是一种结构化的流程图
文档也是第一次写,对于其中的内容理解的也不是特别的完善,通过以后的学习在进一步理解。