软件工程文档编写总结



（一）背景

    在完成机房收费系统之后，自己亲身经历了软件文档的编写工作，在第一次编写验收不过的情况下，自己从18号到26号完成了自己的第二次编写工作。初次编写，感觉自己还是有很多东西没有了解，但是，自己的收获还是颇多的！

（二）收获

    软件工程文档的编写是自己从编程业余爱好者向专业编程人士转变的一个里程碑，具有重要的意义。按照国家软件工程文档标准，软件工程文档都包括《可行性研究报告》《项目开发计划》《软件需求说明书》《概要设计说明书》《详细设计说明书》《数据库设计说明书》《数据要求说明书》《测试计划》《测试分析报告》《项目开发总结报告》《操作手册》《用户手册》《开发进度月报》。其中，《可行性研究报告》旨在分析、研究系统开发的可能性和可行性，目的在于为系统的开发以及通过审查提供有力的数据信息；《项目开发计划》对项目的开发做了详细的开发计划，目的是对系统的开发起到引导的作用，保证项目团队按时保质地完成项目目标，便于项目团队成员更好地了解项目情况，使项目工作开展的各个过程合理有序，在该文档中，尤其要注意的是应当通过甘特图来时刻显示开发的进度；《软件需求说明书》是为了描述软件系统的各种需求，以便业务需求提出者与需求分析人员、开发人员、测试人员及其相关利益人对软件的需求达成共识；《概要设计说明书》在总体上描述了系统的架构和各模块之间的关系，便于知道系统后期的开发工作；《详细设计说明书》则是详细地明确系统每一个结构、类和接口，为后期的代码实现和软件测试做准备；《测试计划》是在系统完成后，对系统进行测试工作的准则，测试是系统开发过程中非常重要的一个环节，完美的测试可以是系统的性能得到很好地优化，测试计划中应该详细介绍测试的用例，每一个功能和单元模块的输入、输出效果；《测试分析报告》是软件测试后的输出文档，记录了测试的过程和结果，并对发现的问题和缺陷进行分析，为纠正软件存在的问题提供依据，《测试分析报告》文档的质量直接决定着测试活动的质量，所以说也是非常重要的一部分；最后就是《项目开发总结报告》，它对系统从开始到最后投入运行做了一个详细的分析报告，深刻分析了系统开发过程中的所有经历，是一笔非常宝贵的财富。

    最后，我想重点介绍一下《数据库设计说明书》和《数据要求说明书》。数据对于一个完整的系统来说是很重要的，是系统实现一切功能的基础。所以，《数据库设计说明书》就显得尤为重要，它方便了开发人员用于创建数据库和对数据库进行一系列的操作，提供了系统的数据存储和处理过程，同时用图形的方式展现出来，适当的减少冗余，能够很好地提高系统的效率；《数据要求说明书》应对数据库中涉及到的数据进行详细说明，对系统中用到的静态数据和动态数据进行详细描述，并对输入、输出数据做初步的约定。总之，数据库的文档记录是软件工程文档编写中的重中之重。

    至于《用户手册》、《操作手册》都是为了方便用户以及开发人员查阅、翻看操作过程中比较详细的问题的，它们使用户能够很好地运用和处理系统，提高了系统的亲和力。

（三）认识

    1.凡事都要有认真负责的态度，就是由于自己敷衍了事的态度，导致自己第一次文档验收不过，同时也感谢自己有了二次编写，使自己的印象更加深刻，理解更加透彻；

    2.编写的文档还有诸多的不足，各种图形的运用还不够好，一方面是由于自己学习的深度还不够，另一方面也是由于自己没有深刻去体会文档的内涵；

    3.自己的路是要由自己来走的，没有任何人可以替代，同时，不同的人看到的风景也不一样的；