文档编写那些可能你不知道的事

     对于文档的编写，你了解多少呢？下面描述了一些我不知道的问题，看看你知道吗？

    （一）总体来说，每一个文档在目录和引言之间，都要有一个变更记录表，当然，变更记录表的形式不固定，可以自己设计，但是主要的几项不能丢掉，如修改记录，变更时间，修改人，验收人等。在文档的编写时，你的文档标题是“****系统设计文档吗”？还是只是把文档的名称写上，没有放系统的名称。

 

    （二）每一个文档中，都会出现一些问题，就我的问题，分析如下：

       1、可行性研究报告

       可行性研究报告由项目组长编写，给项目经理和boss看，所以预期读者是项目经理和boss。可行性研究报告，顾名思义，它是想分析一下，这个项目是否可行，话句话说，就是老板和项目经理看到这份报告后，确定这个项目要不要做！所以，这个项目的精髓就在于分析要开发的系统的经济可行性，技术可行性，社会因素可行性。编写目的自然是全方位分析这个系统，在现在的条件下，是否能够开发，开发时间，开发的预计资金。对于这个文档，你有没有丢掉三个重要的可行性分析呢？

 

       2、项目开发计划

      项目开发计划由项目组长编写，预期读者是开发小组，项目经理，boss以及客户。开发小组看项目开发计划，可以通过甘特图看到项目具体开发安排，项目经理和boss通过开发计划，可以大概得评估项目的价值，和项目开发安排是否合理，客户通过项目开发计划，可以确认项目是否符合自己的要求，以及是否需要更改。简单的理解，项目开发计划主要就是甘特图（我理解为“具体描述这个项目的所有工作安排即什么时间，什么地点，所有小组人员在做什么”）。项目开发计划中要写明非移交产品，如：可行性分析报告、项目开发计划书、软件需求说明书、概要设计书、详细设计说明书、测试计划、测试分析报告、开发进度月报、项目开发总结报告以及源代码等。

 

     3、软件需求说明书

     软件需求说明书预期读者为开发人员和用户。通过需求说明书，客户描述出自己对系统的要求，和预期系统的功能，系统开发人员通过需求说明书了解系统的大概模型和系统要实现的功能。 软件需求说明书主要用于开发人员和客户沟通，形成纸质文件，在系统验收时提供凭证。需求说明书中主要的部分是对输入和预期输出的描写，也就是IPO图。通过预期的输入、处理、输出的这个图，描述出系统需要实现的绝大多数功能。

 

    4、概要设计说明书

    预期读者为开发人员、项目经理、验收维护人员、客户。概要设计说明书交给各个被调研单位审核，并经领导层讨论通过后，软件开发小组成员将以这本说明书为框架开发新的系统。在概要设计说明书中，可以用系统原型（可以设计系统原型，也可以把旧系统直接作为系统原型）直观的介绍系统功能，数据库（数据库中的表名、触发器、命名规范等），模块以及功能块等。在后期，可以把类图、包图放到概要设计说明书中。概要设计可以参考需求说明书和数据库设计说明书来写。对于概要设计中的数据库设计，可以简写。概要设计中应该写明系统期望实现什么、系统的出粗处理、补救措施和简单的维护计划。

 

     5、详细设计说明书

     详细设计说明书预期读者为开发人员、项目经理、验收维护人员。主要定义类、方法、参数注释（头注释、单行注释、多行注释、模块注释等。要以实际设计说明）、命名规范、详细类图等。举个注释的例子：

'头注释：***************************
        '**设计者：—
        '**设计时间：----年--月--日
        '**项目名称：
        '**审核人：
        '**修改人：
        '**修改时间：
		'**补充说明：
       '***************************
'单行注释：注释内容
'多行注释：代码功能，出错处理，等其他注释内容
'模块注释：*****************************
       	 '**模块名称：
  		 '**模块功能：
		 '**创建时间：
         '**创建人：
         '**更改人：时间
         '**模块说明
         '*****************************

     在详细设计中，所有的约定都要做好，例如编码规则，这样，开发小组的各个成员才能按照规定，分别编写自己的部分，在最后把所有的工作合到一起的时候，才能在一定程度上保证系统可以使用。

 

      6、数据库设计说明书

     数据库设计主要是给系统开发人员看的。在数据库设计中，主要从物理设计，逻辑设计和结构设计三个方面来描述数据。使用ER图来描述数据库设计。对于数据库中的表，尽量用手写表，不要截图，写明数据库中表的命名规范和数据库中的约定。写明数据库存储过程，若出现图类的总结，在图的下面要详细的描述图中出现的数据。

 

     7、测试计划

     测试计划的预期读者为测试人员和客户，为做好集成测试和验收测试，需为如何组织测试制定实施计划，计划应包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。测试计划中要包含测试用例。

 

     8、测试分析报告

     测试分析报告主要是给软件开发者看的，测试分析报告是在测试分析的基础上，对测试结果以及测试数据等加以记录和分析总结。它也是测试过程中的一个重要环节，同时，它也是对软件性能的一个总的分析和认可及对不足之处的说明。

 

     9、用户手册

     用户手册主要是给用户看的，用户是在不了解这个系统的内部结构，不知到系统的功能的前提下，使用的用户手册。用户手册主要告诉用户该如何操作这个系统，可以截图说明系统如何使用。截图上一定要有相应的操作说明的文字，方便用户理解。

 

     对于文档编写，这些都是我的一些个人想法，如果出现错误，欢迎评论指出，感激不尽！