• 首页>范文 > 范文
  • 开发文档怎么写

    1.怎么写项目开发的文档

    软件开发中文档的编写是一个不可缺少的环节,常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点,注重文档还是关心代码。

    我这里写一个《用户信息模块的概要设计文档》,只列举主要内容了

    1.功能描述:用于完成系统用户信息的新增、删除、修改、查询;

    2.功能用例:一个主用例用户信息,附加新增、删除、修改、查询4个子用例,操作人员为管理员,图形就不画了,很简单的;

    3.业务流程:查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示,反之保存成功提示。

    4.约束限制:超级管理员可操作所有(包含删除,我这里考虑仅是逻辑删除、非物理删除)的用户信息;系统管理员可操作除系统管理员、超级管理员外的全部用户信息;单位管理员可操作本单位用户信息;用户帐号信息系统内全局唯一;

    5.系统性能:要求同时支持500个并发操作;页面操作响应时间小于1s;页面大小小于1kb;

    当前用户所属员工信息不存在时,可直接进行员工信息的添加,并完成用户信息的同步保存,确保事务的完整性;

    6.运行环境:依赖系统整体运行环境为准(存在特殊需要注明);

    7.操作实体:用户信息、员工信息、系统日志等。

    8.异常处理:如果系统框架中已经提供相关说明,这里仅需要注明符合系统架构异常处理方式即可。

    9.外部接口:输入—用户ID,输出—用户信息;

    10.其他说明:用户帐号必须定义为字母开头,数字与字母组合,并保证全局唯一;用户密码采用md5算法加密,系统架构已提供相关接口。

    11.注意事项:用户帐号不能为空,不能存在空格,不能超过6位;超级用户信息仅在系统初始化中完成其信息写入操作,其他用户无权对其进行修改。

    项目组中也不是所有人都必须参与文档的编写,通常业务需求人员、设计人员、架构师、项目经理、小组长占大多数,而且这些人中很多也不是专注于写代码的角色。

    2.电子开发文档怎么写

    没写过,给你个范例。

    开发文档范例一.需求规格说明书 1。引言 1)编写目的:阐明保险需求说明书的目的,指明读者对象。

    2)项目背景:包括 a 项目的委托单位、开发单位和主管部门。 b 该软件系统与其他系统的关系。

    3)定义:列出文档中所用到的专业术语的定义和缩写的原文。 4)参考资料:包括 a 项目经核准的计划任务书、合同或上级机关的批文。

    b 项目开发计划。 c 文档所引用的资料、标准和规范。

    列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。 2。

    任务概述 1)目标。 2)运行环境。

    3)条件与限制。 3。

    数据描述 1)静态数据。 2)动态数据。

    包括输入数据与输出数据。 3)数据库描述。

    给出使用数据库的名称和类型。 4)数据词典。

    5)数据采集。 4。

    功能需求 1)功能划分。 2)功能描述。

    5。性能需求 1)数据精确度。

    2)时间特性。如响应时间、更新时间、数据转换与传输时间、运行时间等。

    3)适应性。如操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时、应具有的适应能力。

    6。运行需求 1)用户界面。

    如屏幕格式、报表格式、彩单格式、输入输出时间等 2)硬件接口。 3)软件接口。

    4)故障处理。 7。

    其他需求 如可使用性、安全保密、可维护性、可移植性等。 二、概要设计说明书 1。

    引言 1)编写目的:阐明保险需求说明书的目的,指明读者对象。 2)项目背景:包括 a 项目的委托单位、开发单位和主管部门。

    b 该软件系统与其他系统的关系。 3)定义:列出文档中所用到的专业术语的定义和缩写的原意。

    4)参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。可包括 a 项目经核准的计划任务书、合同或上级机关的批文。

    b 项目开发计划。 c 需求规格说明书。

    d 测试计划(初稿)e 用户操作手册(初稿)。f 文档所引用的资料、采用的标准和规范。

    2。任务概述 1)目标。

    2)运行环境。 3)需求概述。

    4)条件与限制。 3。

    总体设计 1)处理流程。 2)总体结构和模块外部设计。

    3)功能分配。表明各项功能与程序结构的关系。

    4。接口设计 1)外部接口。

    包括用户接口、软件接口与硬件接口。 2)内部接口。

    模块之间的接口。 5。

    数据结构设计 1)逻辑结构设计。 2)物理结构设计。

    3)数据结构与程序的关系。 6。

    运行设计 1)运行模块的组合。 2)运行控制。

    3)运行时间。 7。

    出错处理设计 1)出错输出信息。 2)出错处理对策。

    如设置任务、性能将级、恢复及再启动等。 8。

    安全保密设计 9。维护设计 应说明为方便维护工作的设施。

    如维护模块等。 三、详细设计说明书 1。

    引言 1)编写目的:阐明编写概要设计说明书的目的,指明读者对象。 2)项目背景:应包括项目的来源和主管部门等。

    3)定义:列出文档中使用到的专门术语和缩写词的愿意。 4)参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。

    可包括 a 项目经核准的计划任务书、合同或上级机关的批文。b 项目开发计划。

    c 需求规格说明书。d 测试计划(初稿)e 用户操作手册(初稿)。

    f 文档所引用的资料、采用的标准和规范。 2。

    总体设计 1)需求概述 2)软件结构:如给出软件系统的结构图。 3。

    程序描述 逐个给出模块的以下说明: 1)功能。 2)性能。

    3)输入项目。 4)输出项目。

    5)算法:模块所选用的算法。 6)程序逻辑:详细描述模块实现的算法。

    可采用:a.标准流程图 b.PDL语言 c.N-S图 d.PAD e.判定表与描述算法的图表。 7)接口。

    8)存储分配。 9)限制条件。

    10)测试要点:给出测试模块的主要测试要求。

    3.软件开发文档应该如何写

    模块开发卷宗(GB8567——88)1标题软件系统名称和标识符模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)程序编制员签名卷宗的修改文本序号修改完成日期 卷宗序号(说明本卷宗在整个卷宗中的序号)编排日期(说明整个卷宗最近的一次编排日期)2模块开发情况表3功能说明扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。

    可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。

    4设计说明说明本模块(或本组模块)的设计考虑,包括:a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。5原代码清单要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。

    6测试说明说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。7复审的结论把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。

    4.网站开发文档怎么写

    网站前期调查阶段 文档1:《前期调查分析报告》主要内容可以是,进行了什么样的调查;调查的对象;调查的覆盖率;调查的结果。

    这个结果得出的结论,和一些建设性意见。 确定网站主题阶段 文档2:《网站CI形象报告》主要内容主题定位、网站命名、网站标志、标准色彩、标准字体、宣传标语文档3:《网站目标设计说明书》对网站目标的一个详细说明,其中包括初期目标、中期目标和最终目标。

    确定网站内容和阶段 文档4:《网站访问者来源报告》描述网站的服务对象(文化层次,兴趣爱好,上网条件),估计对象在整个网民中所占的比率。它是《网站功能分析说明书》的一部分。

    文档5:《网站功能分析说明书》可以描述以下的问题,为什么人们会来你的网站;你的网站有什么特色的服务吗;你们第一次来你的网站原因;有什么可以吸引他们在来的吗? 文档6:《内容和功能清单》明确网站需要什么内容,需要什么功能。使用目标清单、访问者的需求和竞争性分析这些已经收集的所有信息,开始做两个新的清单:一个是网站的内容要素,一个是网站的功能。

    为每个清单增加仍和潜在的页面或内容的类型。内容的类型包括静态的、动态的、功能的和事物处理的。

    浏览竞争对手的网站,把他们有而你没有的内容和功能加入你的清单。当你建立这两个清单是,让每个人建他们自己的清单,然后把这些清单合并在一起。

    让每个人检查一遍合并后的清单,确定清单中每个条目的重要性。如果有必要的话,修订你的清单。

    文档7:《可视化目录文件清单》 文档8:《网站层次结构图》。

    5.网站开发文档怎么写

    网站前期调查阶段

    文档1:《前期调查分析报告》主要内容可以是,进行了什么样的调查;调查的对象;调查的覆盖率;调查的结果。这个结果得出的结论,和一些建设性意见。

    确定网站主题阶段

    文档2:《网站CI形象报告》主要内容主题定位、网站命名、网站标志、标准色彩、标准字体、宣传标语文档3:《网站目标设计说明书》对网站目标的一个详细说明,其中包括初期目标、中期目标和最终目标。

    确定网站内容和阶段

    文档4:《网站访问者来源报告》描述网站的服务对象(文化层次,兴趣爱好,上网条件),估计对象在整个网民中所占的比率。它是《网站功能分析说明书》的一部分。

    文档5:《网站功能分析说明书》可以描述以下的问题,为什么人们会来你的网站;你的网站有什么特色的服务吗;你们第一次来你的网站原因;有什么可以吸引他们在来的吗?

    文档6:《内容和功能清单》明确网站需要什么内容,需要什么功能。使用目标清单、访问者的需求和竞争性分析这些已经收集的所有信息,开始做两个新的清单:一个是网站的内容要素,一个是网站的功能。为每个清单增加仍和潜在的页面或内容的类型。内容的类型包括静态的、动态的、功能的和事物处理的。浏览竞争对手的网站,把他们有而你没有的内容和功能加入你的清单。当你建立这两个清单是,让每个人建他们自己的清单,然后把这些清单合并在一起。让每个人检查一遍合并后的清单,确定清单中每个条目的重要性。如果有必要的话,修订你的清单。

    文档7:《可视化目录文件清单》

    文档8:《网站层次结构图》

    6.怎么写项目开发的文档

    软件开发中文档的编写是一个不可缺少的环节,常见的如《需求分析》、《概要分析》、《数据库设计》等。

    在“软件人”的阵营里向来存在两种观点,注重文档还是关心代码。 我这里写一个《用户信息模块的概要设计文档》,只列举主要内容了 1.功能描述:用于完成系统用户信息的新增、删除、修改、查询; 2.功能用例:一个主用例用户信息,附加新增、删除、修改、查询4个子用例,操作人员为管理员,图形就不画了,很简单的; 3.业务流程:查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示,反之保存成功提示。

    4.约束限制:超级管理员可操作所有(包含删除,我这里考虑仅是逻辑删除、非物理删除)的用户信息;系统管理员可操作除系统管理员、超级管理员外的全部用户信息;单位管理员可操作本单位用户信息;用户帐号信息系统内全局唯一; 5.系统性能:要求同时支持500个并发操作;页面操作响应时间小于1s;页面大小小于1kb; 当前用户所属员工信息不存在时,可直接进行员工信息的添加,并完成用户信息的同步保存,确保事务的完整性; 6.运行环境:依赖系统整体运行环境为准(存在特殊需要注明); 7.操作实体:用户信息、员工信息、系统日志等。 8.异常处理:如果系统框架中已经提供相关说明,这里仅需要注明符合系统架构异常处理方式即可。

    9.外部接口:输入—用户ID,输出—用户信息; 10.其他说明:用户帐号必须定义为字母开头,数字与字母组合,并保证全局唯一;用户密码采用md5算法加密,系统架构已提供相关接口。 11.注意事项:用户帐号不能为空,不能存在空格,不能超过6位;超级用户信息仅在系统初始化中完成其信息写入操作,其他用户无权对其进行修改。

    项目组中也不是所有人都必须参与文档的编写,通常业务需求人员、设计人员、架构师、项目经理、小组长占大多数,而且这些人中很多也不是专注于写代码的角色。

    7.asp.net开发文档怎么写,谁有样板

    系统需求和需求分析说明书文件状态:√草稿正式发布正在修改 文件标识 当前版本 [1.0.0] 作 者 [罗豪] 完成日期 [2005-12-5] 版本历史版本/状态 修订人 修改日期 备注 V1.0.0 罗豪 2005-12-12 第一部分、概述项目名称及背景Ø 项目名Ø 称开放式上市基金交易平台Ø 开发背景随着我国经济水平的持续发展,金融产品也在不断发展。

    经中国证监会批准,开放式上市基金已在逐渐发展,为了开展此项业务,建设银行某分行需要一个基金交易平台,以便银行窗口人员(本系统的操作人员)在此平台上为广大用户提供基金交易的便捷服务。文档说明本文档为系统设计人员提供需球分析,并为开发人员提供开发依据,也可用于和用户交流需求。

    本文大档先大致的描述了项目的背景,系统的功及其用户的环境等,然后主要对系统得功能进行了需求分析,运用OOAD的方法,从用例出发,对系统功能进行分析和说明。第二部分、任务说明功能概述本系统满足了开发式基金的销售问题,基金销售人员可利用WEB使用它来和他们的客户进行基金交易,并对基金产品、客户资料和客户资金帐户进行了管理。

    其功能大致如下:用户环境该银行的数据库使用的是Oracle9i。应用服务器为Weblogic8.13、其他要求性能要求超过至少可100人并发访问,WEB页面相应不能3秒。

    技术要求要求系统采用J2EE技术,利用Struts、EJB和WebService来实现此平台。使系统基于组件,可扩展性强,并能分布式部署。

    第三部分、需求分析1、实现功能Ø 系统用例图此系统的用例共有18个,由于一张图很难完全显示在此文档上,所以这里从功能相关的角度,分成了5张图,分别如下:Ø 功能清单功能编号 功能名称 文中标题编号 备注 01 注册 无 02 登录 无 03 退出 无 04 添加基金产品 无 05 查询基金产品信息 无 06 修改基金产品信息 无 07 添加新客户 无 08 查询客户基本信息 无 09 修改客户基本信息 无 10 查询客户详细信息 无 11 开立资金账户 无 12 查询资金账户 无 13 追加账户资金 无 14 取出账户资金 无 15 冻结资金账户 无 16 购买基金 无 17 查询基金账户 无 18 赎回基金 无 2、用例说明Ø 注册 A、用例图 见系统用例图 B、描述 基金柜台操作人员利用WEB输入系统首页URL,在系统首页上,有一个新用户的链接,点击进入,即可进行在线注册信息输入;输入用户、密码、确认密码、真实姓名和性别后,可点击注册按钮进行注册,用户名在系统中只能重复,并不区分大小写,AAA认为与aaa同效。注册提交后,要记录注册信息。

    注册成功,返回首页,以便登录。 C、参与者 基金柜台操作人员Ø 登录 A、用例图 见系统用例图 B、描述 基金柜台操作人员利用WEB输入系统首页URL,在系统首页上,有用户和密码的输入框,输入用户名和密码提交后,系统验证系统是否有此用户和此用户的密码是否正确,如果正确,进入系统功能主页,否则返回系统首页,并提示相关信息。

    C、参与者 基金柜台操作人员Ø 退出 A、用例图 见系统用例图 B、描述 点击在功能主页上退出的链接,系统清除会话信息,并返回到系统首页。 C、参与者 基金柜台操作人员Ø 添加基金产品 A、用例图 见系统用例图 B、描述 在功能主页上,点击基金产品管理,再点击添加基金产品链接,可进行添加基金产品。

    输入产品名称、产品价格或描述后,点击添加按钮,进行添加基金产品。系统要交验产品名称是否已经在系统中存在,不区分大小写。

    如果不存在,记录该产品信息,否则,返回本页,并提示相关信息。 C、参与者 基金柜台操作人员Ø 查询基金产品信息 A、用例图 见系统用例图 B、描述 在功能主页上,点击基金产品管理,再点击查询产品信息链接,可开始查询基金产品信息,需输入产品编号或名称进行查询,查询后显示产品信息:产品编号、产品名称、产品价格、产品描述和产品状态。

    C、参与者 基金柜台操作人员Ø 修改基金产品信息 A、用例图 见系统用例图 B、描述 先查询该产品信息,在查询出来的结果页面上,点击修改按钮,便可进行产品信息修改,输入修改的产品信息后,系统更新该产品信息。 C、参与者 基金柜台操作人员Ø 添加新客户 A、用例图 见系统用例图 B、描述功能主页上,点击客户资料管理,再点击添加新客户的链接,输入客户信息:客户姓名、性别、身份证、电话、地址、E-mail、爱好,然后系统添加客户信息,身份证是客户的唯一性判断标准。

    系统需要记录最后修改人员的操作代码和最后修改日期。C、参与者 基金柜台操作人员Ø 查询客户基本信息 A、用例图 见系统用例图 B、描述功能主页上,点击客户资料管理,再点击查询客户信息的链接,然后输入客户编号或身份证,进行查询,查询后显示客户基本信息:客户编号、姓名、客户可用资产和客户总资产。

    系统需要记录最后修改人员的操作代码和最后修改日期。客户可用资金 = 客户资金帐户资金客户总资产= 客户资金帐户资金 + 所有基金帐户当前市值 C、参与者 基金柜台操作人员Ø 修改客户基本信息 A、用例图 见系统用例图 B、描述先查询出客户基本信息后,然后点击修改按钮,输入修改信息,点击修改按钮后进行客户资料的修改,客户代码不能修。

    8.我该怎么写详细开发文档

    以下nbsp;是我们单位的nbsp;项目开发计划书nbsp;希望对你有帮助编制项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、nbsp;所需经费预算、所需软、硬件条件等问题作出的安排记载下来,以便根据本计划开展和检查本项目的开nbsp;发工作。

    编制内容要求如下:nbsp;nbsp;nbsp;nbsp;1nbsp;引言nbsp;nbsp;nbsp;1.1编写目的nbsp;nbsp;nbsp;nbsp;说明编写这份项目开发计划的目的,并指出预期的读者。nbsp;nbsp;nbsp;1.2背景nbsp;nbsp;nbsp;说明:nbsp;nbsp;nbsp;a.待开发的软件系统的名称;nbsp;nbsp;nbsp;b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络;nbsp;nbsp;nbsp;C.该软件系统同其他系统或其他机构的基本的相互来往关系。

    nbsp;nbsp;nbsp;1.3定义nbsp;nbsp;nbsp;nbsp;列出本文件中用到的专门术语的定义和外文首字母组词的原词组。nbsp;nbsp;nbsp;1.4参考资料nbsp;nbsp;nbsp;列出用得着的参考资料,如:nbsp;nbsp;nbsp;a.本项目的经核准的计划任务书或合同、上级机关的批文;nbsp;nbsp;nbsp;b.属于本项目的其他已发表的文件;nbsp;nbsp;nbsp;C.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。

    nbsp;列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。nbsp;nbsp;nbsp;2nbsp;项目概述nbsp;nbsp;nbsp;nbsp;2.1nbsp;工作内容nbsp;nbsp;nbsp;简要地说明在本项目的开发中须进行的各项主要工作。

    nbsp;nbsp;nbsp;2.2主要参加人员nbsp;nbsp;nbsp;扼要说明参加本项目开发工作的主要人员的情况,包括他们的技术水平。nbsp;nbsp;nbsp;nbsp;2.3产品nbsp;nbsp;nbsp;2.3.1程序nbsp;nbsp;nbsp;列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式,并通过引用有关文件,逐项说明其功能和能力。

    nbsp;nbsp;nbsp;nbsp;2.3.2文件nbsp;nbsp;nbsp;列出需移交给用户的每种文件的名称及内容要点。nbsp;nbsp;nbsp;nbsp;2.3.3服务nbsp;nbsp;nbsp;列出需向用户提供的各项服务,如培训安装、维护和运行支持等,应逐项规定开始日期、所提供支持nbsp;的级别和服务的期限。

    nbsp;nbsp;nbsp;2.3.4非移交的产品nbsp;nbsp;nbsp;nbsp;说明开发集体应向本单位交出但不必向用户移交的产品(文件甚至某些程序)。nbsp;nbsp;nbsp;2.4验收标准nbsp;nbsp;nbsp;nbsp;对于上述这些应交出的产品和服务,逐项说明或引用资料说明验收标准。

    nbsp;nbsp;nbsp;nbsp;2.5完成项目的员迟用限nbsp;nbsp;nbsp;nbsp;2.6本计划的批准者和批准日期nbsp;nbsp;nbsp;nbsp;3nbsp;实施计划nbsp;nbsp;nbsp;nbsp;3.1工作任务的分门与人员分工nbsp;nbsp;软件开发网nbsp;nbsp;nbsp;对于项目开发中需完成的各项工作,从需求分析、设计、实现、测试直到维护,包括文件的编制、审批、打印、分发工作,用户培训工作,软件安装工作等,按层次进行分解,指明每项任务的负责人和参加人员。nbsp;nbsp;nbsp;3.2nbsp;接口人员nbsp;nbsp;nbsp;说明负责接口工作的人员及他们的职责,包括:nbsp;nbsp;nbsp;anbsp;.负责本项目同用户的接口人员;nbsp;nbsp;nbsp;b.负责本项目同本单位各管理机构,如合同计划管理部门、财务部门、质量管理部门等的接口人员;nbsp;nbsp;nbsp;nbsp;c.负责本项目同各分合同负责单位的接口人员等。

    nbsp;nbsp;nbsp;nbsp;3.3进度nbsp;nbsp;nbsp;nbsp;对于需求分析、设计、编码实现、测试、移交、培训和安装等工作,给出每项工作任务的预。定开始日期、完成日期及所需资源,规定各项工作任务完成的先后顺序以及表征每项工作任务完成的标志性事件(即所谓“里程碑“)。

    nbsp;nbsp;nbsp;nbsp;3.4预算nbsp;nbsp;nbsp;nbsp;逐项列出本开发项目所需要的劳务(包括人员的数量和时间)以及经费的预算(包括办公费、差旅费、机时费、资料费、通讯设备和专用设备的租金等)和来源。nbsp;nbsp;nbsp;3.5关键问题nbsp;nbsp;nbsp;逐项列出能够影响整个项目成败的关键问题、技术难点和风险,指出这些问题对项目的影响。

    nbsp;[Page]nbsp;nbsp;nbsp;4nbsp;支持条件nbsp;nbsp;nbsp;说明为支持本项目的开发所需要的各种条件和设施。nbsp;nbsp;nbsp;4.1计算机系统支持nbsp;nbsp;nbsp;逐项列出开发中和运行时所需的计算机系统支持,包括计算机、外围设备、通讯设备、模拟器、编译nbsp;(或nbsp;汇编)程序、操作系统、数据管理程序包、数据存储能力和测试支持能力等,逐项给出有关到货日期、nbsp;使用时间的要求。

    nbsp;nbsp;nbsp;4.2需由用户承担的工作nbsp;nbsp;nbsp;逐项列出需要用户承担的工作和完成期限。包括需由用户提供的条件及提供时间。

    nbsp;nbsp;nbsp;4.3由外单位提供的条件nbsp;nbsp;nbsp;nbsp;逐项列出需要外单位分合同承包者承担的工作和完成的时间,包括需要由外单位提供的条件和提nbsp;供的时间。nbsp;nbsp;nbsp;nbsp;5nbsp;专题计划要点nbsp;nbsp;nbsp;说明本项目开发中需制。

    9.软件开发文档应该如何写

    模块开发卷宗(GB8567——88)

    1标题

    软件系统名称和标识符

    模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)

    程序编制员签名

    卷宗的修改文本序号

    修改完成日期

    卷宗序号(说明本卷宗在整个卷宗中的序号)

    编排日期(说明整个卷宗最近的一次编排日期)

    2模块开发情况表

    3功能说明

    扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。

    4设计说明

    说明本模块(或本组模块)的设计考虑,包括:

    a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;

    b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;

    c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。

    5原代码清单

    要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。

    6测试说明

    说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。

    7复审的结论

    把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。

    开发文档怎么写

    发表评论

    登录后才能评论