软件工程文档总结

软件工程文档总结

       忙碌了这么长时间、终于把文档都写完了、看着小伙伴们都把文档粘成博客、感觉没啥意义、而且第一次写这个文档、感觉实用性很低、就是混个脸熟、师傅说以后做工程都会涉及到、感觉以后会是个老朋友吧!

对于这十多个文档、我做了归类性总结、分别从用户、开发者、和管理者的角度分类画了导图。

下面就宏观讲下这些文档

    (1) 可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的

可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

    (2) 项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负

责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

    (3) 软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户

界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

    (4) 数据要求说明书：应给出数据逻辑描述和数据采集的各项要求，为生成和维护系

统数据文卷做好准备。

   (5) 概要设计说明书：是概要设计阶段的工作成果，应说明功能分配、模块划分、程

序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

   (6) 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

   (7) 用户手册：详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

   (8) 操作手册：为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的

具体细节。

   (9) 测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

   (10) 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结

果加以分析，并提出测试的结论意见。

   (11) 开发进度月报：是软件人员按月向管理部门提交的项目进展情况报告。报告应包

括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

   (12) 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际

执行的情况，如进度、成果、资源利用、成本和投入的人力等。此外还需对开发工作做出评价，总结出经验和教训。

   (13) 维护修改建议：软件产品投入运行以后，发现需对其进行修正和更改，应将存在

的问题、修改的考虑以及修改的影响估计做详细的描述，写成维护修改建议提交审批。

   以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制的。其中有的仅反

映一个阶段的工作，有的则需跨越多个阶段。

  软件生存期各阶段编制的文档

维护修改建议   

                                                               √
  (1) 有些需求要被满足，即回答“做什么?”
  (2) 所开发的软件在什么环境中实现以及所需信息从哪里来，即回答“从何处?”
  (3) 某些开发工作的时间如何安排，即回答“何时干?”
  (4) 某些开发(或维护)工作打算由“谁来干?”
  (5) 某些需求是怎么实现的?
  (6) 为什么要进行那些软件开发或维护修改工作?

  上述 13 个文档都在一定程度上回答了这 6 个方面的问题。

                         文档所回答的问题

       好多人都说文档不好写、其实没有什么不好写的、第一次写都有模板、照着填写就好了、做完一遍、自然而然就会觉得简单、没有什么难的、小伙伴们加油！

总之希望这篇博客对大家有所帮助吧！

——————————加快脚步、奔跑——————————chenchen