【软工学习】文档总结

    视频文档学习的最后阶段是根据文档模板编写一系列的文档，这些文档贯穿整软件的设计开发运行维护周期。

【文档的重要性分析】

    从任何角度分析软工文档都还是非常重要的，它记录着软件工程师对程序的设计思路，并且让以后对该软件进行维护人员可以很清楚的了解这个软件，针对后来的维护人员的软件文档，除了这个以后还有针对用户的软件文档，就像手机的说明书一样，使用户简单明了的知道怎么使用这个软件。

    软工文档起到多种桥梁作用，使它有助于程序员编制程序，有助于管理人员监督和管理软件开发，有助于用户了解软件的工作和应做的操作，有助于维护人员有效地修改和扩充。

【编写文档的一些感受】

    花了两个星期的时间完成了软工文档的编写，说实话刚开始的时候真的不知道从哪里入手，于是第一个文档编写了长达两天的时间，后来慢慢的从网上也是搜一些资料，问了一下其他同学，看了一些师哥师姐关于这一部分的博客，才理清了思路，慢慢上手了。其中在对数据库设计文档编写的时候，遇到了比较多的问题，或许也是因为在做第一遍机房收费系统的时候，用的是现成的数据库的原因吧，对于数据库设计这方面就没有深究过，哎，还是应了那句话：欠下的，总是要还的。跟同学交流了一下，也从网上查了一下，才很艰难的写了出来。都说万事开头难，果不其然，写文档的过程中我信服了这个观点。其实，迈出了第一步，接下来的路就好走啦。

【师傅验收的一些建议】

    从总体上志鹏师傅还是肯定了我写的这一系列文档，该画的图都有，就是有些地方在理解上存在一定的偏差。师傅还说了好多自己的学习经验，聊了好久，收获好多。我自身存在的一个比较严重的问题就是：有些文档的用户不明确，不知道其真正的用武之地，对于其中几个比较重要的文档师傅要我重新思考一下，做好总结。

【文档总结】

1、可行性分析报告

内容：包括对现有程序的分析和对所建设系统的设计，分析对比各种可能引用的系统情况。做好投资预算、效       益分析。同时进行经济、技术、管理、环境可行性分析。

预期读者：系统开发者、管理决策者等

目的：从技术、经济、操作、法律、社会效益等方面来看，该系统是否可行，能不能立即进行。

最终：形成可行性分析报告

2、项目开发计划

内容：对新项目描述、实施计划、支持条件的分析概括。

3、软件需求说明

内容：包括开发任务的概述、系统运行环境说明及需求的相关规定。

最终：形成软件需求说明书

4、软件系统设计（概要设计+详细设计）

内容：

    概要设计：系统接口、运行环境、系统数据结构、出错处理

    详细设计：程序结构剖析及其功能等的详细分析说明

最终：形成总体设计说明书和详细设计说明书

5、数据库设计（设计+要求）

内容：

    数据库设计：外部设计、运行设计、结构设计

    数据库要求：数据的逻辑描述和数据采集

重点：

    数据库的结构设计：需要进行概念设计、逻辑设计、物理设计三个阶段，每个阶段都有一定的表达形式。

    数据库的运行设计：需要编写数据字典并且进行相关的安全保密性设计。

最终：形成数据设计、要求说明书

6、软件测试

内容：包括软件测试前期准备、测试用例的制定、执行测试计划

最终：形成软件测试报告

7、项目开发总结报告

内容：对软件开发成果的阶段总结、软件开发进度调整规划、软件评价、开发过程中经验教训的总结。

8、说明书

内容：包括用户说明书、操作说明书（二者如出一辙）

目的：将软件介绍给有需要的人

9、开发进度月报

内容：介绍项目工作状态、工程进度，物资分析，总结本阶段经验教训并制定下一阶段计划

注：自我感觉不太重要的进行了略写

【学习阶段小结】

利用一个多月的时间，完成了软件工程视频和文档的学习及总结，进一步了解了软件工程，对于日后的工作学习都将受益。并且体验了第一次文档的编写，有苦更有甜。在日后的学习中将不断深入这部分的学习。理论加实践，逐步走上专业化道路！