【软件工程】-文档总结

【前言】

    机房收费系统文档是根据在机房收费系统开发、软工视频以及文档样本的学习中编写的。写文档的开始都不知道写文档的目的是什么，随着一步步的深入学习了解到了文档编写的重要性，也知道文档的编写和软件的生存周期是密切相关的。

    软件开发文档是软件开发使用和维护过程中的必备资料，它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。

   在项目开发过程中，应该编写好十三种文档，文档编写要求具有针对性、精确性、完整性、灵活性、可追溯性。

 

一．文档编写目的

◇ 《可行性分析报告》

    可行性分析报告的编写目的是说明该软件开发项目在技术、经济和社会条件方面的可行性，评述为了合理地到达开发目标而可能选择的各种方案，说明并论证所选定的方案。

 

◇ 《项目开发研究计划》

    项目开发研究计划的编写目的是根据可行性分析报告推荐的可行方案，落实各项工作的负责人，参加人员以及各种资料的要求，制定项目开发进度、验收标准和成本概算等，指导整个项目开发工作的顺利进行。

 

◇ 《软件需求说明书》

   软件需求说明书的编写是为了使用户和软件开发者双方对该软件的运行环境、功能和性能需求的初始规定有一个共同的理解，使之成为整个开发工作的基础，为概要设计提供需求说明。

 

◇ 《概要设计说明书》

    概要设计（又可称程序系统设计）说明书编写的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程，程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错设计等，为程序的详细设计奠定基础。

 

◇ 《详细设计说明书》

    详细设计（又可称程序设计机）说明书编写目的是说明一个软件系统各个层次的每个程序（每个模块或子程序）的实际考虑，为程序员编写程序提供依据。

 

◇《数据库设计说明书》

    数据库设计说明书的编写目的是对设计中的数据库的所有标识，逻辑结构和物理结构作出具体的设计规定，指导程序员的建库工作。

 

◇ 《数据要求说明书》

    数据要求说明书的编写目的是为了向整个开发时期，提供被处理数据的描述和数据采集要求的技术信息。

 

◇ 《用户手册》

    用户手册的编写目的是为了详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解，为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

 

◇《操作手册》

   操作手册的编写目的是为了向操作人员提高该软件每一个运行的具体过程和有关的知识，包括安装和操作方法细节。

 

◇《测试计划》

    测试计划的编写目的是为了提供一个对该软件的测试安排，包括每项测试计划活动的内容、进度安排、设计考虑、测试数据的整理方法以及测试准则。

 

◇ 《测试分析报告》

    测试分析报告是为了把组装测试和确认测试的结果、发现的问题以及分析评价以文件的形式加以记载，作为软件验收的依据之一。

 

◇ 《开发进度月报》

   开发进度月报的编写目的是软件人员为了及时按月向管理部门提交的项目进展情况报告，以便及时发现和处理开发过程中出现的问题。报告应包括进度计划与实际执行的情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的计划等。

 

◇ 《项目开发总结报告》

    项目开发总结报告的编写目的是为了在软件项目开发完成之后，于项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外，还有需对开发工作作出评价，总结出经验和教训。

 

二、文档预期读者

     可行性研究报告：分析人员，系统开发人员、维护人员
     项目开发计划：开发人员、管理人员、用户、系统分析人员
     软件需求说明书：用户、维护人员、软件开发人员
     概要设计说明书：软件详细设计人员、软件开发人员、软件管理人员、软件维护人员
     详细设计说明书：软件开发人员，代码编写人员、系统实施人员、维护人员
     数据库设计说明书：数据库设计人员、软件开发人员、软件维护人员
     数据要求说明书：用户、数据库设计人员、软件维护人员
     测试计划：系统测试员
     测试分析报告：开发人员、用户、软件质量管理员、项目管理员
     项目开发总结报告：项目开发人员
     操作手册：所有对本系统进行操作人员，系统实施与维护人员
     用户手册：用户
     开发进度月报：系统开发管理人员（由各个阶段小负责人编写）

 

三、文档编写时间

    对于一项软件而言，文档是在其生存周期的各个开发阶段，依次编写而成的。其中有些文档的编写工作可能在若干个开发阶段延续进行，才能逐步完善。

 

 

【总结】

    在软件开发中是一个阶段一个阶段的进行，前一个阶段任务的完成是下一个阶段开始进行的前提和基础。后一个阶段任务的完成使得下一阶段提出的结果更加具体化。每一个阶段的开始和结束都有严格的标准。文档是过程中通信的工具，更是阶段衔接的纽带。所以文档的编写显得尤为重要。