三九宝宝网宝宝教育智力培养

怎样编写开发手册

03月12日 编辑 39baobao.com

[父母不得不读的宝宝智能大开发手册]认知能力训练 a. 指出哪个玩具是红色的 父母可以把红色的蜡笔、红色的碗碟、红色的积木放在一起,然后问宝宝:“哪个东西是红色的?”宝宝可能会指红色的碗碟,这时父母需要告诉宝...+阅读

1 引言

1.1 编写目的:阐明编写需求说明书的目的,指明读者对象。

1.2 项目背景:应包括

● 项目的委托单位、开心单位和主管部门;

● 该软件系统与其他系统的关系。

1.3 定义:列出文档中所用到的专门术语的定义和缩写词的愿文。

1.4 参考资料:可包括

● 项目经核准的计划任务书、合同或上级机关的批文

● 文档所引用的资料、规范等

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

2 任务概述

2.1 目标

2.2 运行环境

2.3 条件与限制

3 数据描述

3.1 表态数据

3.2 动态数据:包括输入数据和输出数据。

3.3 数据库描述:给出使用数据库的名称和类型。

3.4 数据词典

3.5 数据采集

4 功能需求

4.1功能划分

4.2功能描述

5 性能需求

5.1 数据精确度

5.2 时间特性:如响应时间、更新处理时间、数据转换与传输时间、运行时间等。

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

6 运行需求

6.1 用户界面:如屏幕格式、报表格式、菜单格式、输入输出时间等。

6.2 硬件接口

6.3 软件接口

6.4 故障处理

7 其他需求

如可使用性、安全保密、可维护性、可移植性等。

求软件开发流程详解

第一步:需求调研分析

1相关系统分析员向用户初步了解需求,然后用WORD列出要开发的系统的大功能模块,每个大功能模块有哪些小功能模块,对于有些需求比较明确相关的界面时,在这一步里面可以初步定义好少量的界面。

2 系统分析员深入了解和分析需求,根据自己的经验和需求用WORD或相关的工具再做出一份文档系统的功能需求文档。这次的文档会清楚利用系统大致的大功能模块,大功能模块有哪些小功能模块,并且还列出相关的界面和界面功能。

3 系统分析员向用户再次确认需求。

第二步:概要设计

首先,开发者需要对软件系统进行概要设计,即系统设计。概要设计需要对软件系统的设计 进行考虑,包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、 运行设计、数据结构设计和出错处理设计等,为软件的详细设计提供基础。

第三步:详细设计

在概要设计的基础上,开发者需要进行软件系统的详细设计。在详细设计中,描述实 现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关系,需要说明软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑,以便进行编码和测试。应当保证软件的需求完全分配给整个软件。详细设计应当足够详细,能够根据详细设计报告进行编码。

第四步:编码

在软件编码阶段,开发者根据《软件系统详细设计报告》中对数据结构、算法分析和模块实现等方面的设计要求,开始具体的编写程序工作,分别实现各模块的功能,从而实现对目标系统的功能、性能、接口、界面等方面的要求。

第五步:测试

测试编写好的系统。交给用户使用,用户使用后一个一个的确认每个功能。

第六步:软件交付准备

在软件测试证明软件达到要求后,软件开发者应向用户提交开发的目标安装程序、数据库的数据字典、《用户安装手册》、《用户使用指南》、需求报告、设计报告、测试报告等双方合同约定的产物。

《用户安装手册》应详细说明安装软件对运行环境的要求、安装软件的定义和内容、在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。

《用户使用指南》应包括软件各项功能的使用流程、操作步骤、相应业务说明、特殊提示和注意事项等方面的内容,在需要时还应举例说明。

第七步:验收

用户验收。

软件详细设计说明书

面向对象软件设计说明书模板 1 概述 1.1 系统简述 对系统要完成什么,所面向的用户以及系统运行的环境的简短描述,这部分主要来源于需求说明书的开始部分。 1.2 软件设计目标 这部分论述整个系统的设计目标,明确地说明哪些功能是系统决定实现而哪些时不准备实现的。同时,对于非功能性的需求例如性能、可用性等,亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考,看看其中明确了的功能性以及非功能性的需求。 这部分必须说清楚设计的全貌如何,务必使读者看后知道将实现的系统有什么特点和功能。在随后的文档部分,将解释设计是怎么来实现这些的。 1.3 参考资料 列出本文档中所引用的参考资料。(至少要引用需求规格说明书) 1.4 修订版本记录 列出本文档修改的历史纪录。必须指明修改的内容、日期以及修改人。 2 术语表 对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经说明过了,此处不用再重复,可以指引读者参考需求说明。 3 用例 此处要求系统用用例图表述(UML),对每个用例(正常处理的情况)要有中文叙述。 4 设计概述 4.1 简述 这部分要求突出整个设计所采用的方法(是面向对象设计还是结构化设计)、系统的体系结构(例如客户/服务器结构)以及使用到的相应技术和工具(例如OMT、Rose) 4.2 系统结构设计 这部分要求提供高层系统结构的描述,使用方框图来显示主要的组件及组件间的交互。最好是把逻辑结构同物理结构分离,对前者进行描述。别忘了说明图中用到的俗语和符号。 4.2.1 顶层系统结构 4.2.2 子系统1结构 4.2.3 子系统2结构 4.3 系统界面 各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书中已经对用户界面有了叙述,此处不用再重复,可以指引读者参考需求说明。如果系统提供了对其它系统的接口,比如说从其它软件系统导入/导出数据,必须在此说明。 4.4 约束和假定 描述系统设计中最主要的约束,这些是由客户强制要求并在需求说明书写明的。说明系统是如何来适应这些约束的。 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助,那么系统可能还受到其它的约束。这种情况下,要求清楚地描述与本系统有交互的软件类型(比如某某某数据库软件,某某某EMail软件)以及这样导致的约束(比如只允许纯文本的Email)。 实现的语言和平台也会对系统有约束,同样在此予以说明。 对于因选择具体的设计实现而导致对系统的约束,简要地描述你的想法思路,经过怎么样的权衡,为什么要采取这样的设计等等。 5 对象模型 5.1 系统对象模型 提供整个系统的对象模型,如果模型过大,按照可行的标准把它划分成小块,例如可以把客户端和服务器端的对象模型分开成两个图表述。 对象图应该包含什么呢? 在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些应该、哪些不应该被放进图中。 所有对象之间的关联必须被确定并且必须指明联系的基数

(一对

一、一对多还是多对多,0..1,*,1..*)。聚合和继承关系必须清楚地确定下来。每个图必须附有简单的说明。 可能经过多次反复之后才能得到系统的正确的对象模型。 6 对象描述 在这个部分叙述每个对象的细节,它的属性、它的方法。在这之前必须从逻辑上对对象进行组织。你可能需要用结构图把对象按子系统划分好。 为每个对象做一个条目。在系统对象模型中简要的描述它的用途、约束(如只能有一个实例),列出它的属性和方法。如果对象是存储在持久的数据容器中,标明它是持久对象,否则说明它是个临时对象(transient object)。 对每个对象的每个属性详细说明:名字、类型,如果属性不是很直观或者有约束(例如,每个对象的该属性必须有一个唯一的值或者值域是有限正整数等)。 对每个对象的每个方法详细说明:方法名,返回类型,返回值,参数,用途以及使用的算法的简要说明(如果不是特别简单的话)。如果对变量或者返回值由什么假定的话,Pre-conditions和Post-conditions必须在此说明。列出它或者被它调用的方法需要访问或者修改的属性。最后,提供可以验证实现方法的测试案例。 6.1 子系统1中的对象 6.1.1 对象:对象1 用途: 约束: 持久性: 6.1.1.1 属性描述: 1. 属性:属性1 类型: 描述: 约束: 2. 属性:属性2 6.1.1.2 方法描述: 1. 方法:方法1 返回类型: 参数: 返回值: Pre-Condition: Post-Condition: 读取/修改的属性: 调用的方法: 处理逻辑: 测试例:用什么参数调用该方法,期望的输出是什么…… 7 动态模型 这部分的作用是描述系统如何响应各种事件。例如,可以建立系统的行为模型。一般使用顺序图和状态图。 确定不同的场景(Scenario)是第一步,不需要确定所有可能的场景,但是必须至少要覆盖典型的系统用例。不要自己去想当然地创造场景,通常的策略是描述那些客户可以感受得到的场景。 7.1 场景(Scenarios) 对每个场景做一则条目,包括以下内容: 场景名:给它一个可以望文生义的名字 场景描述:简要叙述场景是干什么的以及发生的动作的顺序。 顺序图:描述各种事件及事件发生的...

软件开发文档干什么的

在软件的生产过程中,总是伴随着大量的信息要记录、要使用。因此,软件文档在产品的开发生产过程中起着重要的作用。

1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。

2)提高开发效率。软件文档的编制,使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性,便于及时加以纠正。

3)作为开发人员在一定阶段的工作成果和结束标志。

4)记录开发过程中的有关信息,便于协调以后的软件、开发、使用和维护。

5)提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。

6)便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需要的软件提供依据。

文档在各类人员、计算机之间的多种桥梁作用中看出:

既然软件已经从手工艺人的开发方式发展到工业化的生产方式,文档在开发过程中就起到关键作用。从某种意义上来说,文档是软件开发

规范的体现和指南。按规范要求生成一整套文档的过程,就是按照软件开发规范完成一个软件开发的过程。所以,在使用工程化的原理和方法来指导软件的开发和维护时,应当充分注意软件文档的编制和管理。

PS:软件开发文档包括:

操作手册

维护修改建议

软件需求(规格)说明书

开发文档 软件需求(规格)说明书

数据要求说明书

概要设计说明书

详细设计说明书

可行性研究报告

项目开发计划

管理文档 项目开发计划

测试计划

测试报告

开发进度月报

开发总结报告

以下为关联文档:

thinkphp5 0开发手册应用设置在哪儿thinkphp5.0开发手册应用设置在哪儿 打开组策略,定位到计算机配置——Windows设置——安全设置——软件限制策略——其他规则(注:如没有,请右键选中软件限制策略从中新建),在右边...

码出高效 java开发手册这本书怎么样《码出高效:Java开发手册》 引爆技术圈,全球瞩目的中国计算机民族图书,中国人自己原创的Java编程规范,希望未来社会发展的每一行代码都规范、合理、高效!马云、行癫、鲁肃亲笔推...

学习嵌入式Linux应用开发完全手册提供一下几种方案 一、还按照《嵌入死linux应用开发完全手册》(韦东山)的内容来,但是嵌入式l呗冒崇咆俑男臭赘幢蚀inux的开发环境自己搭建。当时我是按照《鸟哥的私房菜-基础篇...

关于嵌入式linux应用开发完全手册这本书这样交叉使用只不过是为了方便传文件,或者说是对于习惯了在windows下操作的人们而言,比较方便的一个方法。毕竟Linux下的操作很多都是命令行,很多有用的软件包不见得在Linux下...

软件开发需要编写哪些文档这个问题没有一定的,因为这里有多种因素 如,开发阶段、文档化要求程度等,若是通过CMM评估的,文档就较多 一般的是按项目开发过程来分,基本的有 可行性研究报告(若是一个新项目且未...

人力资源开发怎样开发同样的模式在家做,选择网资的十大理由 (一)真正的以小搏大,完全符合投资原则,以最小的投入获取最大的利益; (二)风险小,风险包括经济风险和人格风险; (三)回报高,91%的资金全部分配,是任何...

怎样编写公章管理制度转载 公司公章管理制度 一、公司印章指公司行政章、合同章及财务章,公章由公司财务办公室负责管理,未经总经理批准不得随意交由他人管理和使用。因故需临时交接,须经总经理批准...

ISO9001质量管理手册如何编写按照ISO9001:2008《质量管理体系 要求》标准体系编写,对标准的各项要求,充实、细化为自身组织可以据此执行的具体要求,并应指明相关的程序文件、记录的名称。 给你一个我单位的...

怎样编写人力资源计划她还记得,去年这个时候,因为编写的人力资源计划不够理想,经理一顿数落…… 前几天,小琴参加了一个人力资源管理沙龙,于是她就把“如何编写一份优秀的人力资源计划”这个话题抛了...

推荐阅读
图文推荐