【软工】软工文档总结

1、定义

      软工文档是与程序开发、维护和使用有关的图文材料，记录了软件开发活动和阶段性成果、理解软件所必需的阐述性资料。

2、目的与作用

     (1)目的是为了保证项目开发的成功，最经济的花费这些投资，并且便于运行和维护，在开发的每一个阶段都需要编制文档。

      (2)作用是：

       a．作为开发人员在一定阶段内的工作成果和结束标志；
       b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转 换成“可见的”文字资料。以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是 否已达到，还将继续耗用资源的种类和数量；
       c．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；    

       d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相 互了解彼此的工作；
       e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。

3、内容

   1）文件的使用者

         对于使用文件的人员而言，他们所关心的文件的种类，随他们所承担的工作而异。虽然最后开发成功的软件交由用户使用，但并不意味着这些文档都必须交给用户。

   2）软件生存周期与各种文件的编制

      在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文件。

      在需求分析阶段内，由系统分析人员对被设计的系统进行系统分析，确定对该软件的各项功能、性能需求和设计约束，确定对文件编制的要求，作为本阶段工作的结果，一般地说，软件需求说明书、数据要求说明书和初步的用户手册应该编写出来。

      在设计阶段内，系统设计人员和程序设计人员应该在反复理解软件需求的基础上，提出多个设计，分析每个设计能履行的功能并进行相互比较，最后确定一个设计，包括该软件的结构、模块的划分、功能的分配以及处理流程。在被设计系统比较复杂的情况下，设计阶段应分解成概要设计阶段和详细设计阶段两个步骤。在一般情况下，应完成的文件包括：概要设计说明书、详细设计说明书和测试计划初稿。

      在实现阶段内，要完成源程序的编码、编译（或汇编）和排错调试得到无语法错的程序清单，要开始编写模块开发卷宗，并且要完成用户手册、操作手册等面向用户的文件的编写工作，还要完成测试计划的编制。

      在测试阶段，该程序将被全面地测试，已编制的文件将被检查审阅。一般要完成模块开发卷宗和测试分析报告，作为开发工作的结束，所生产的程序、文件以及开发工作本身将逐项被评价，最后写出项目开发总结报告。

      在整个开发过程中（即前五个阶段中），开发集体要按月编写开发进度月报。    在运行和维护阶段，软件将在运行使用中不断地被维护，根据新提出的需求进行必要而且可能的扩充和删改。

      对于一项软件而言，其生存周期各阶段与各种文件编写工作的关系可见表互，其中有些文件的编写工作可能要在若干个阶段中延续进行。

4、注意事项

   1）文件的预期读者。每一种文件都具有特定的读者。这些读者包括个人或是个人，是学生或是公司职员，是技术大牛还是小职员。他们都期待着使用这些文件的内容来进行工作。因此，这些文件的编写必须注意使用自己的预期读者的水平和要求。

   2）文件的内容。第一次写文档，开始的时候不知如何下手。慢慢的找到了学习的规律，尽量使每一小节的内容详细，扩展要完整。多个文档之间做到数据一致，也就是重复性要高。

   3）保存与管理。完成文档之后，首先要自己梳理一遍顺序，为文档命名，然后保存，随着软件的交付一起提交。在软件维护过程中，可能会对软件进行修改，这时候就会有文件的修改。一定要建立好修改记录。