设计文件编写规范.ppt

设计文件编写规范 目录 设计文件编写规则 需求规格说明书编写规则 用户手册编写规则 设计文件容易出现问题剖析 设计文件编写规则(1) 一项计算机软件的筹划、研制及实现，构成一个软件开发项目。一个软件开发项目的进行，一般需要 在人力和自动化资源等方面作重大的投资。为了保证项目开发的成功，最经济地花费这些投资，并且便 于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。这些文件连同计算机程序及数据一起， 构成为计算机软件。设计文件是计算机软件中不可缺少的组成部分，它的作用是：??? a．作为开发人员在一定阶段内的工作成果和结束标志；??? b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转 换成“可见的”文字资料。以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是 否已达到，还将继续耗用资源的种类和数量；??? C．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；??? d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相 互了解彼此的工作；??? e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。??? 换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。??? 计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类 则是应编制的技术资料或技术管理资料，可称之为文件。本指南规定软件文件的编制形式，并提供对这 些规定的解释。本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。 设计文件编写规则(2) 在软件开发的过程中，产生的文件是很多的，为了便于保存、查找、使用和修改，应该对文件按层次地加以分类组织。一个软件开发单位应该建立一个对本单位文件的标识方法，使文件的每一页都具有明确的标识。例如可以按如下四个层次对文件加以分类和标识。 a．文件所属的项目的标识； ??? b．文件种类的标识； ??? C．同一种文件的不同版本号；??? d．页号。 设计文件编写规则(2) 文件包含的基本内容 （1）封面、目录、正文 （2）封面应该包括： 项目名称、版本号、 作者、文件状态和 所属部门。 设计文件编写规则(3) 版本变更 目录规则 （1）目录一般 使用三级目录。 （2）目录应该 单独为一页。 设计文件编写规则(4) 正文规则 （1）正文字体一般为小四号字和五号字，如果是政府公文或红头文件是四号字。 （2）文内的标题一般使用三级或四级。 一级标题一般使用三号字，加粗； 二级标题一般使用四号字，加粗； 三级标题一般使用小四号字，加粗； 也可采用更小的号字，但要求一个项目内的所有文档的正文字体一致。 （3）标题的方式有（1，1.1，1.1.1或一，1.1，1.1.1 ，第一章，1.1， 1.1.1三种，我们推荐第一种）。 需求规格说明书编写规则 用户手册编写规则 设计文件容易出现问题剖析（1） 为了加深大家的印象我们将对目前开发的实例进行分析。 文档的基本准则：从2010年6月1日开始设计文件全部采用CMM2.0的全套模板，并进行评审，但以前的文档不做修改，所有技术体系对外提交文档必须经过项目经理、部门经理、项目管理部经理审核后才能发出。 设计文件容易出现问题剖析（2） 设计文件容易出现问题剖析（3） 设计文件容易出现问题剖析（3） 总结 文档最重要的几个特点： 一致、通顺、无错别字、有封面、修订记录、目录以及有页码。 （1）一致是指文章标题与页眉、正文内容一致；所有文件标题字体及大小一致、正文字体一致；所有文件页眉一致。 （2）语言通顺流畅、使用WORD的基本错字检查工具无错别字。 （3）每篇文章都应该有封面、修订记录、目录和页码。 请大家按这个原则来书写文档，应该给大家一些帮助。 谢谢大家 * * 11）行间距不一致，将段与段之间的空行却掉。 10）P94—P96字体与文件中其他位置不一致 9）P91字体与文件中其他位置不一致 8）P87字体与文件中其他位置不一致 7）P79字体与文件中其他位置不一致 6）P67字体与文件中其他位置不一致 5）P62字体与文件中其他位置不一致 4）P58字体与文件中其他位置字体不一致 3）P13中的字体与其他表格不同 2）文件没有页码 1）目录与其他文件不一致 金融生态环境监测评价系統规格说明