机房重构-文档总结

    说到机房重构，那边不能不提一下文档做的制作了，虽然我们在学习软工视频的时候已经知道如何去写文档，但那毕竟不是完整制作。机房重构的目的就是让我们先熟悉一下如何编写一份完整的文档，毕竟以后做项目都是由文档驱动，所以做一份满足大众需求的文档还是很有必要的。

    也许大家在做项目的时候都有这样的体会：代码都写不出来，哪里还有功夫去写文档呀。要不就是文档写好了，项目做到一半发现制作的和理想的有些出入，还要返回来重新修改文档，弄得手忙脚乱的。但是如果有一份完善的文档，项目制作起来会非常的得心应手，对于日后的维护与更新的工作，效率也会得到大大提升。

    下面就详细的介绍一下文档分类。一个软件的生命周期主要分为定义阶段、开发阶段、维护阶段。



    文档不同，包含的内容也不同，编写的人和阅读的人也不一样，所以要按照要求去编写文档。

文档名称	编写人员	阅读人员	主要内容
可行性研究报告	系统分析人员	软件开发商（即你的老板）	在从技术、经济、管理和开发环境等几个方面，确定一个软件可以完成，需求方和开发商共同讨论项目中的开发方案。
项目开发计划	系统分析人员	项目经理、分析员、开发人员、用户	对项目的概述（包括工作内容、人员分配等），实施计划（包括任务分配，进度方面）、支持条件（包括对计算机硬件的要求）
软件需求说明书	系统分析人员	项目经理、开发人员、用户	开发本软件的意图，对功能、性能各方面的需求，对计算机运行环境的需求。
概要设计说明书	技术文档工程师	项目经理、设计人员、开发人员	总体设计，对需求规定、开发环境的限制，接口设计、运行设计，对模块组合、运行控制及时间的限制
详细设计说明书	技术文档工程师	项目经理、设计人员、开发人员	程序系统的结构，程序设计说明，包含对程序的描述、功能、性能、输入输出项、算法、接口、逻辑流程、存储、限制条件
数据要求说明书	技术文档工程师	项目经理、 开发人员、 数据库设计人员	对数据的逻辑描述、对数据的要求和范围
数据库设计说明书	技术文档工程师	项目经理、 开发人员、 数据库设计人员	介绍标识符和状态、使用此数据库的应用程序，介绍逻辑结构和物理结构，写出数据字典等
测试计划	测试文档工程师	项目经理、测试人员	测试内容、标识符的进度和条件、测试需求人数、标识符的控制、输入输出和过程、对数据的整理
测试分析报告	测试文档工程师	项目经理、测试人员	测试的情况，对结果的分析和发现，对功能的结论和评价，指出系统缺陷并提出建议，以及本次测试消耗的资源
操作手册	操作管理文档工程师	用户	对软件的概述以及结构的说明、安装于初始化、对运行步骤的说明、对非常规操作的说明、对远程操作的说明
用户手册	用户管理文档工程师	用户	对功能和性能的介绍，对运行环境说明，对使用过程的说明（安装、输入、输出的要求）
开发进度月报	进度管理文档工程师	项目经理、开发人员	工程的进度与状态、对资源好用的状态、经费的支出状态、下月的工作计划
项目开发总结报告	技术文档工程师	项目经理、老板	实际开发出产品的功能和性能，对开发效率、产品质量的评价，对出现错误的原因分析、总结经验和教训

    在这些文档里，有两个比较容易混淆的文档，那就是操作手册和用户手册，那么我们怎么去区分这两个文档呢？这两个文档又有什么相同和不同之处呢？我理解的是两个文档的面相对象都是用户，只是从不同的角度去撰写，级别也是不一样的，操作手册是系统级别的文档，用户手册是需求级别的文档。操作手册会对每一个页面进行详细的介绍，每一个按钮都会讲述它的操作进程，更强调操作步骤。而用户手册主要是针对功能来介绍，会从头开始说明服务器的配置，系统安装，操作系统的要求，系统维护等等，是一套成熟的流程模式。

    总结：随着学习的越来越深入，对文档的理解也越来越加深了，有了文档，不仅使我们的开发工作变得简单，还为以后的维护工作提供了方便，所以一份完整的文档是一款好的软件的基础！！