软件工程（十二）-文档

软件工程

1.何为软件工程？
软件工程是指导计算机软件开发和维护的一门工程学科。采用工程的概念、原理、技术和方法来开发和维护计算机软件，把经过实践考验而证明正确的管理技术和当前能够得到最好的技术和方法结合起来，以经济地开发出高质量的软件并有效地维护它。
2.软件工程的过程？
软件工程的过程是：生产一个最终能满足需求且达到工程目标的软件产品所需要的步骤；主要包括开发过程、运作过程、维护过程。它们覆盖了需求、设计、实现、确认以及维护等活动。

软件文档

1.何为软件文档？
软工文档是记录软件开发活动和阶段性成果、理解软件所必需的阐述性资料。
2.为什么要写文档？
之前开会，听师哥师姐说提高班的文档是最全的，出去上班之后就没这么全了，当时还不知道文档是什么。软件文档能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导、帮助、解惑的作用，尤其在维护工作中，文档是不可或缺的资料，因此我们需要编写软件工程文档。
3.每个文档的编写目的和预期读者。
（1）可行性研究报告
编写目的：从各个方面分析此软件开发的必要性和可能性。
预期读者：董事长、总经理、项目经理。
（2）项目开发计划
编写目的：对开发系统做规划，拟出详细的计划，主要包括人员组织、时间进度、设备、开发/运行环境、成本费用。
预期读者：董事长、总经理。
编写者：项目负责人。
（3）软件需求说明书
编写目的：了解用户的需求，收集需求的改变，根据市场需求设计软件。
预期读者：开发人员、用户代表。
（4）概要设计说明书
编写目的：建立整个软件系统结构，包括子系统、模块以及相关层次的说明、每一模块的接口定义。
预期读者：开发人员。
（5）详细设计说明书
编写目的：再概要设计说明书的基础上进行再细化的设计，设计程序的蓝图。
预期读者：开发人员、编写人员。
（6）数据库设计说明书
编写目的：设计数据库，为后期数据库设计指明方向。
预期读者：数据库设计师、数据库管理员
（7）数据要求说明书
编写目的：明确系统中各项功能和非功能需求实现所需要的数据，根据此数据设计数据库。
（8）测试计划
编写目的：描述测试活动的范围、方法、资源、时间。
预期读者：编写人员、测试人员
（9）测试分析报告
编写目的：在测试的基础上对测试结果已经测试的数据加以记录和分析总结。
预期读者：开发人员。
（10）项目开发总结报告
编写目的：总结开发工作的经验，对工作进行评价，找出不足之出，吸取经验教训。
预期读者：全体开发人员。
（11）操作手册
编写目的：告诉使用者系统提供的功能，以及如何正确使用这些功能。
预期读者：用户、测试人员。
（12）用户手册
编写目的：为用户使用此软件时提供指导，指明使用方法。
预期读者：用户
（13）开发进度月报
编写目的：总结当月工作，包括进度、资源消耗、费用的指出。
预期读者：全体开发人员。

总结

写文档说难也难，说简单也简单。难得是之前没有接触过，要靠自己编写完，不过可以通过查看网上其它得文档，照葫芦画瓢。简单得是，系统是自己做得，怎么实现得，自己都知道，怎么想得就怎么写。