机房收费系统文档

前提：

       好的开始是成功的一半。谨遵师傅教导：做一件事情之前进行宏观把握，了解全局，这便是编写文档成功的一半。

过程：

     整个机房收费系统文档的成功编写历时大约10天的时间，针对此项目的学习做了两个方面的是计划，第一，机房收费系统文档编写；第二，机房收费系统文档完善验收。在机房收费系统文档编写期间，

• 首先进行宏观把握，通过整体了解得到以下收获：

第一：编写的主要文档

第二：根据《软件工程文档模板》和《文档样本》，了解到各个文档要编写的主要内容：

（1）可行性研究报告：<1>引言 <2>前提 <3>现有系统的分析 <4>所建议的系统 <5>其他系统方案 <6>投资与效益 <7>社会因素分析 <8>结论

（在可行性研究报告中最主要的是关于技术与经济方面的内容）

（2）项目开发计划：<1>引言 <2>概述 <3>实施计划 <4>支持条件 <5>专题计划要点

（3）软件需求说明书：<1>引言 <2>任务 <3>需求规定 <4>运行环境要求

（4）概要设计说明书：<1>引言 <2>总体设计 <3>接口设计 <4>运行设计 <5>系统数据结构 <6>系统出错处理

（5）详细设计说明书：<1>引言 <2>程序系统的结构 <3>各个程序的相关说明

（6）数据库设计说明书：<1>引言 <2>外部设计 <3>结构设计 <4>运用设计

（7）数据要求说明书：<1>引言 <2>数据的逻辑描述 <3>数据的采集

（8）测试计划：<1>引言 <2>计划 <3>测试设计 <4>评价准则

（9）测试分析报告：<1>引言 <2>测试概要 <3>结果及分析 <4>软件功能 <5>分析摘要 <6>资源消耗

（10）项目开发总结报告：<1>引言 <2>实际开发结果 <3>开发工作评价 <4>经验与教训

（11）操作手册：<1>引言 <2>软件征述 <3>安装与初始化 <4>运行说明 <5>非常规过程 <6>远程操作

（12）用户手册：<1>引言 <2>用途 <3>运行环境 <4>使用过程

（13）开发进度月报：<1>标题 <2>工作进度与状态 <3>资源耗用与状态 <4>经费支出与状态 <5>下个月的工作计划 <6>建议

• 其次在实践的过程中，遇到了一些问题，并且通过自己完整的实践解决了一些问题：
  

第一，在编写文档过程中所遇到的问题：

（1）各个文档的预期读者混乱        （2）每个文档中用到的专门术语的定义不知该如何着手

（3）用户手册与操作手册的区别     （4）数据精度应该如何认识

（5）投资与效益分析的依据             （6）各个文档中用到的图形的规范

第二，在实际文档的编写过程中，对之前的困惑有了更加深刻的了解：

（1）各个文档的预期读者是交叉的并没有明显的界限，领导阶层的比如项目经理或者CEO从他们的身份出发，所有的文档他们都有权限查看，但是他们主要的查看的是整个项目开发过程中的一些宏观的文档，比如可行性分析报告、项目开发计划、开发进度月报；关于测试分析报告与测试计划自然主要侧重于测试人员查看的；关于概要设计说明书、详细设计说明书、数据库设计说明书、数据要求说明书倾向于系统设计人员查看；关于操作手册和用户手册偏向于用户查看。

（2）用户手册和操作手册有一个明显的区别在于：用户手册比操作手册多了关于用户在使用过程中遇到问题时的解决方案。

（3）投资与效益分析的依据主要根据系统开发的实际情况来进行计算的，比如实际的投资预算、实际的资源消耗、实际开发进度等，目前由于还没有进入实际的项目开发过程中所以目前文档中关于投资与效益的分析可谓是稍微结合实际与想象的。

• 最后，在师傅的验收过程当中，有些困惑更加明确和了解：

第一，每个文档中用户的专门术语的定义是一些缩略语，比如TGB代表提高班，DBMS代表数据库管理系统诸如此类的定义

第二，数据精度的编写主要侧重于金额、时间等数值型的相关说明

第三，用户手册与操作手册的关系：

<1>操作手册是用户手册的一部分

<2>操作手册是系统级别的文档，用户手册是需求级别的文档

<3>操作手册讲述的是如何操作该系统的某个页面；用户手册是在用户想做什么事情，在这样的前提下引导用户去操作该系统完成这样的需求

<4>在做项目时更多查看的是操作手册，需求明确

<5>用户手册是一套成熟的流程模式，包括系统操作说明，服务器配置、系统安装、操作、维护等方面

感受：

（1）在第一次接触文档时，编写的主要目的是要明白各个文档的预期读者和主要内容。

（2）在进行视频学习的时候应该注意关于图形的讲解，比如甘特图、用例图、IPO图、类图、架构图、时序图、视图等。