【软件工程】——文档总结

【前言】

软件开发过程中需要写很多的文档，每一个文档都有其所对应的写作目的、预期读者、以及对应的UML图，这些文档可以更好的让我们进行软件开发。

【文档】

一、《可行性研究报告》

用途：软件项目的具体开发流程，为项目整体进展提供计划基础。包括提出项目开发的目的，确定详细项目的实施范围、定义递交的工作成果、评估实施过程中的主要风险、制定项目实施时间计划、成本和预算计划、人力资源计划等。

预期读者：老板、软件设计人员、软件分析员

二、《软件需求说明书》

用途：确定系统必须提供的服务，划出系统必须完成的功能，对开发计划进一步细化，由用户和软件分析员共同完成，然后交给软件设计人员。

预期读者：用户、软件分析员、软件设计人员

UML配图：用例图、类图

三、《概要设计说明书》

用途：设计软件的整体结构，把软件按照移动的原则分解模块层次，赋予每个模块一定的任务，并确定模块间的调用关系和接口

预期读者：软件设计人员、软件编码人员

UML配套：类图、包图、部署图、协作图、活动图

四、《详细设计说明书》

用途：依据概要设计阶段的分解，为每个模块完成的功能进行具体的描述，要把功能描述转变为更为精确的、结构化的过程描述。内容包括模块内的算法、流程、状态转化。描述方式有流程图、N-S图、PAD图、伪代码等。

预期读者：软件设计人员、软件编码人员、软件测试人员

UML配图：对象图、类图、包图、时序图

五、《数据库设计说明书》

用途：对于设计中的数据库的所有标识，逻辑结构和物理结构做出具体的设计规定。

预期读者：数据库设计师、数据库管理员

概念设计：根据用户的需求设计数据库的概念结构，它以规范的形式，表达了用户需求所涉及事物的理解。
逻辑设计：根据概念设计结果设计数据库的逻辑结构，即表达方式和实现方法。
物理设计：确定系统存储内容、存储介质。

六、《数据库要求说明书》

用途：明确系统软件中的各项功能和功能性需求实现时所需要的数据，然后据此设计数据库。对数据库中的数据进行逻辑分类与描述，确定数据的采集方式。

预期读者：数据库设计师、数据库管理员、软件测试人员

七、《测试计划》

用途：描述将要进行测试活动的范围、方法、资源和时间进度的文档。它确定了测试项，要测试特征、测试任务、谁来完成每项任务以及需要一定应急方案的所有风险等。

预期读者：软件开发人员、软件设计人员、软件编码人员、软件测试人员、用户

UML配图：用例图、类图、包图、构件图、协作图

八、《测试分析报告》

用途：在测试的基础上，对测试的结果以及测试的数据等加以分析和总结，它是测试过程中的一个重要的环节。对今后软件的功能的加强起着关键作用。另外，它还利于今后软件开发者阅读源程序，更具测试提供的数据和结果，分析源代码，掌握各函数的功能和局限性，从而缩短软件开发者在开发时间所耗费精力、资金

预期读者：软件开发人员、软件设计人员、软件编码人员、软件测试人员

九、《项目开发总结报告》

用途：对项目开发的实际测试结果进行总结、评价，以便在今后项目开发中更好的实施项目的制定开发，提高开发效率。

预期读者：软件开发人员

十、《操作手册》

用途：为使用者说明该软件提供了那些功能，以及如何正确的、有效的来使用这些功能

预期读者：用户、软件测试人员

十一、《用户手册》

用途：给使用者提供一个使用指南，以便为首次使用该软件的用户说明使用方法，以及为已经使用或者正在使用的用户在使用过程中遇到的问题提供解决问题的方法。

预期读者：用户、团建设计人员