1.需求文档怎么写
文档需要体现:
1,电路板的尺寸规格,比如材质要求、面积、形状、板厚、最小线宽、最小线距、单面制板还是双面或是多层制板、定位孔位置及定位孔尺寸等等;
2,元器件封装,普通插式元件还是贴片封装元件,是0805封装还是0603或是。。;
3,接口形式。是焊盘还是插座、用什么规格的插座;
4,有什么特殊的接地要求。
以上这些是最起码的文档内容,没有这些内容指导就不好做事啦。还有更复杂的要求就暂免了,如EMI、EMS等等。
2.如何写软件设计文档
按照以下格式填就好了,不过是我自己写的,有不好的地方大家互相学习修改一下~
详细设计文档规范
1.0概述
这部分提供对整个设计文档的概述。描述了所有数据,结构,接口和软件构件级别的设计。
1.1 目标和对象
描述软件对象的所有目标。
1.2 陈述范围
软件描述。主要输入,过程功能,输出的描述,不考虑详细细节。
1.3 软件内容
软件被置于商业或者产品线中,讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。
1.4 主要系统参数
任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。
2.0 数据设计
描述所有数据结构包括内部变量,全局变量和临时数据结构。
2.1 内部软件数据结构
描述软件内部的构件之间的数据传输的结构。
2.2 全局数据结构
描述主要部分的数据结构。
2.3 临时数据结构
为临时应用而生成的文件的描述。
2.4 数据库描述
作为应用程序的一部分,描述数据库结构。
3.0 结构化和构件级别设计
描述程序结构。
3.1 程序结构
详细描述应用程序所选定的程序结构。
3.1.1 结构图
图形化描述结构。
3.1.2 选择性
讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。
3.2 构件描述
详细描述结构中的每个软件构件。
3.2.1 构件过程叙述(PSPEC)
描述构件的过程。
3.2.2 构件接口描述
详细描述构件的输入和输出。
3.2.3 构件执行细节
每个构件的详细演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 规范/限制
]3.2.3.4 本地数据结构
3.2.3.5 在3.2.3.6设计中包含的执行结果
3.3 软件接口描述
软件对外界的接口描述
3.3.1机器对外接口
与其他机器或者设备的接口描述。
3.3.2系统对外接口
对其它系统、产品和网络的接口描述。
3.3.3与人的接口
概述软件与任何人的界面。
4.0 用户界面设计
描述软件的用户界面设计。
4.1 描述用户界面
详细描述用户界面,包括屏幕显示图标、图片或者类型。
4.1.1 屏幕图片
从用户角度描述界面。
4.1.2 对象和操作
所有屏幕对象和操作的定义。
4.2 界面设计规范
用户界面的设计和实现的规范和标准。
4.3 可见构件
实现的GUI可见构件说明。
4.4 UIDS描述
用户界面开发系统描述。
5.0约束、限制和系统参数
会影响软件的规格说明、设计和实现的特殊事件。
6.0测试标准
测试策略和预备测试用例描述。
6.1 测试的类别
规定实施测试的类别,包括尽量详细的描述。这里是针对黑盒测试现象的描述。
6.2期待软件反馈
测试期待的结果描述。
6.3执行界线
特殊执行需要的说明。
6.4 重要构件确认
决定性构件或者需要特殊注意的构件的测试确认。
7.0附录
设计说明的补充信息。
7.1系统可跟踪矩阵
一个定期回归系统规格跟踪软件需求的矩阵。
7.2 产品战略
如果规格说明书是为一个产品设计的,描述相关的产品战略。
7.3 使用分析算法
描述所有分析活动所使用到的分析算法。
7.4 补充信息 (如果有需要特别说明的)
3.毕业设计文档怎么写
1、工程设计类选题
明确设计具体任务,设计原始条件及主要技术指标;设计的具体要求、该学生的侧重点、主要的数据,应完成的工作量(如开题报告、设计说明书、图纸、译文及计算机应用要求等)等内容应填写具体、明确。
2、软件开发类选题
明确软件开发的具体任务,一般应包括弄清系统的现状及其发展趋势,建立仿真模型,编写计算机程序,上机调试与结果分析等具体内容,应完成的工作量要求(如开题报告、论文、译文、程序以及程序使用说明等)要填写具体、明确。
3、实验研究或科研类选题
明确选题的来源,具体任务目标,国内外相关研究现状及其评述;该学生的研究重点,研究的实验内容、实验原理及实验方案;计算机应用及工作量要求(如论文、开题报告、译文等)应填写具体、明确。
4、文科类毕业论文
明确选题的任务、方向、研究范围和目标、查阅文献、收集资料并整理分析,了解相关的研究历史和研究现状,要求完成的工作量(论文文献评述、译文等)。
二、主要参考文献与资料
在确定毕业设计(论文)题目和明确基本要求后,指导教师应给学生提供一些相关资料和相关信息,指导学生收集主要参考资料和参考文献。
三、按毕业设计(论文)各环节拟定阶段工作进度计划
4.如何写详细设计文档
在大多数软件项目中,要末不作详细设计,要么开发完成后再补详细设计文档,质量也不容乐观,文档与系统往往不能同步,使详细设计文档完全流于形式,对工作没有起到实际的帮助。
·
详细设计是相对概要设计而言的,是瀑布开发流程的一个重要环节,在概要设计的高层设计的基础上,从逻辑上实现了每一模块的功能,是编码阶段的主要参考资料,是从高层到低层、逐步精化思想的具体实现。
详细设计文档的内容包括各个模块的算法设计,
接口设计,
数据结构设计,交互设计等。必须写清楚各个模块/接口/公共对象的定义,列明各个模块程序的
各种执行条件与期望的运行效果,还要正确处理各种可能的异常。
·
在开发过程中,由需求及设计不正确、不完整所导致的问题是项目进度拖延、失败的一个主要因素,而软件系统的一个重要特性就是需求和设计的不断构建和改进,在写详细设计文档过程中,
详细设计实际上是对系统的一次逻辑构建,可以有效验证需求的完整性及正确性。
如果不写详细设计文档,一般就从概设直接进入编码阶段,这时开发人员所能参考的资料就是需求规格说明书及页面原型、数据库设计等,不能直接进行开发,需要进行信息的沟通,把页面原型不能体现的设计讲清楚,这样既容易遗忘,也容易发生问题,详细设计文档可以作为需求人员、总体设计人员与开发人员的沟通工具,把静态页面无法体现的设计体现出来,包含整体设计对模块设计的规范,体现对设计上的一些决策,例如选用的算法,对一些关键问题的设计考虑等等,使开发人员能快速进入开发,提高沟通效率,减少沟通问题。
对于系统功能的调整,后期的维护,详设文档提供了模块设计上的考虑、决策,包括模块与整体设计的关系、模块所引用的数据库设计、重要操作的处理流程、重要的业务规则实现设计等等信息,提供了对模块设计的概述性信息,阐明了模块设计上的决策,配合代码注释,可以相对轻松读懂原有设计。
·存在的问题要由专门的人写,是比较麻烦的,也是很需要时间的,会对进度造成压力,也容易形成工作瓶颈,使设计人员负担过重,而开发人员无事可作。对于现在一般的以数据库为中心的管理系统而言,这个工作始终是要作的,区别只不过是不是形成专门文档,形成文档可能会多花一两周时间,但相对于规避的风险和问题来说,也是值得的,另外由于现在高级语言的流行,所以更详细的设计应该直接体现在代码的设计上,而文档则只体现设计上的一些决策,协调整体设计与模块设计的关系,把页面原型所不能体现的设计情况文档化,所以所花费的时间是有限的。
设计内容容易过细,但设计阶段是不能考虑特别清楚地,时间也不允许。
对于这个问题,一个对策是上边所提到的,文档只体现设计上的决策,页面原型所不能反映的信息,详细设计只体现总体设计对模块设计的一些考虑,例如对功能的数据库设计等等,而具体的实现实现,则到代码中再去实现,相关的设计也仅体现在代码中。
需求、设计需要不断的被更新、构建,则设计文档需要不断的重新调整,文档的维护需要跟上,否则文档和系统的同步就很难得到保障了,且造成多余的工作量。文档的内容易流于形势,质量糟糕,不能成为开发人员的参考手册,一是要建立起相关制度,如有修改,先改文档,后作开发,从工作流程上切实保障文档与系统的同步,二是要规范文档质量,对文档该写什么,不该写什么,标准是什么,粒度是什么,语法应该如何组织,有明确的标准和考虑,同时,建立审计文档评审、审核制度,充分保障系统的使用。·
首先是文档的内容,根据项目和团队的不同,详细设计文档的内容也有所不同,一般说来,粒度不宜过细,不能代替开发人员的设计和思考,但要把有关设计的决策考虑进去,包括与其他模块、整体设计的关系、操作的处理流程,对业务规则的设计考虑等,有一个标准为,凡是页面原型、需求规格说明书所不能反映的设计决策,而开发人员又需要了解的,都要写入文档。
其次是文档所面向的读者,主要为模块开发人员、后期维护人员,模块开发人员通过详细设计文档和页面原型来了解所开发的功能,后期维护人员通过实际系统、模块代码、详细设计文档来了解一个功能。
再有就是谁来写文档,因为文档主要考虑的是设计上的决策,所以写文档的人应该为负责、参加设计的技术经理、资深程序员,根据团队情况和项目规模、复杂度的不同,也有所不同。
还需要保证文档的可读性、准确性、一致性,要建立严格的文档模板及标准,保证文档的可读性及准确性,同时建立审核及设计评审制度,来保障设计及文档的质量,另外在工作流程中要强调,要先设计、先写文档,再进行开发。
5.做软件项目设计文档怎么写啊
按照以下格式填就好了,不过是我自己写的,有不好的地方大家互相学习修改一下~
详细设计文档规范
1.0概述
这部分提供对整个设计文档的概述。描述了所有数据,结构,接口和软件构件级别的设计。
1.1 目标和对象
描述软件对象的所有目标。
1.2 陈述范围
软件描述。主要输入,过程功能,输出的描述,不考虑详细细节。
1.3 软件内容
软件被置于商业或者产品线中,讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。
1.4 主要系统参数
任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。
2.0 数据设计
描述所有数据结构包括内部变量,全局变量和临时数据结构。
2.1 内部软件数据结构
描述软件内部的构件之间的数据传输的结构。
2.2 全局数据结构
描述主要部分的数据结构。
2.3 临时数据结构
为临时应用而生成的文件的描述。
2.4 数据库描述
作为应用程序的一部分,描述数据库结构。
3.0 结构化和构件级别设计
描述程序结构。
3.1 程序结构
详细描述应用程序所选定的程序结构。
3.1.1 结构图
图形化描述结构。
3.1.2 选择性
讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。
3.2 构件描述
详细描述结构中的每个软件构件。
3.2.1 构件过程叙述(PSPEC)
描述构件的过程。
3.2.2 构件接口描述
详细描述构件的输入和输出。
3.2.3 构件执行细节
每个构件的详细演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 规范/限制
]3.2.3.4 本地数据结构
3.2.3.5 在3.2.3.6设计中包含的执行结果
3.3 软件接口描述
软件对外界的接口描述
3.3.1机器对外接口
与其他机器或者设备的接口描述。
3.3.2系统对外接口
对其它系统、产品和网络的接口描述。
3.3.3与人的接口
概述软件与任何人的界面。
4.0 用户界面设计
描述软件的用户界面设计。
4.1 描述用户界面
详细描述用户界面,包括屏幕显示图标、图片或者类型。
4.1.1 屏幕图片
从用户角度描述界面。
4.1.2 对象和操作
所有屏幕对象和操作的定义。
4.2 界面设计规范
用户界面的设计和实现的规范和标准。
4.3 可见构件
实现的GUI可见构件说明。
4.4 UIDS描述
用户界面开发系统描述。
5.0约束、限制和系统参数
会影响软件的规格说明、设计和实现的特殊事件。
6.0测试标准
测试策略和预备测试用例描述。
6.1 测试的类别
规定实施测试的类别,包括尽量详细的描述。这里是针对黑盒测试现象的描述。
6.2期待软件反馈
测试期待的结果描述。
6.3执行界线
特殊执行需要的说明。
6.4 重要构件确认
决定性构件或者需要特殊注意的构件的测试确认。
7.0附录
设计说明的补充信息。
7.1系统可跟踪矩阵
一个定期回归系统规格跟踪软件需求的矩阵。
7.2 产品战略
如果规格说明书是为一个产品设计的,描述相关的产品战略。
7.3 使用分析算法
描述所有分析活动所使用到的分析算法。
7.4 补充信息 (如果有需要特别说明的)
6.嵌入式系统的设计文档怎么写
文档格式规范 1.标题分级 文档标题一般最深到5级标题,这5级标题的格式应该通过“ ”→“ ”设置。
标题一律设为自动更新,表1以正文为小四号字为例说明各级标题格式,若正文是5号字,则字号相应变动。表1 标题格式列表 标题例中文字体西文字体字号首行缩进段前段后对齐方式标题11 内容黑体Arial小二不缩进各0.5行居中 标题21.1内容黑体Arial三号不缩进各0.3行左对齐 标题31.1.1内容黑体Arial四号不缩进各0.2行左对齐 标题41.内容楷体TimesNew Roman四号缩进2字符各0.2行左对齐 标题51) 内容黑体Arial小四缩进2字符各0.2行左对齐 注:(1)使用这种方法设置标题格式,是为了自动生成目录使用,一般生成到前三级。
自动生成完的目录都会带有链接,同时按下“Ctrl+Shift+F9”可以去掉该链接;失去链接后的目录文字带有下划线,此时选中目录,然后按下“ ”即可去掉。目录格式也可以通过“ ”→“ ”设置。
(2)检查标题是否完整。最多生成到5级进行查看。
(3)标题末尾一定不要用标点符号。2.表 (1)表标题在表体上方,与不能分开。
表标题应设为自动更新。表标题格式字号应比正文字号小一号。
(2)表字格式单独设置。字号应比正文字号小一号。
例如:宋体、Times New Roman、小五。注意表字。
文档格式规范 1.标题分级 文档标题一般最深到5级标题,这5级标题的格式应该通过“ ”→“ ”设置。标题一律设为自动更新,表1以正文为小四号字为例说明各级标题格式,若正文是5号字,则字号相应变动。
表1 标题格式列表 标题例中文字体西文字体字号首行缩进段前段后对齐方式标题11 内容黑体Arial小二不缩进各0.5行居中 标题21.1内容黑体Arial三号不缩进各0.3行左对齐 标题31.1.1内容黑体Arial四号不缩进各0.2行左对齐 标题41.内容楷体TimesNew Roman四号缩进2字符各0.2行左对齐 标题51) 内容黑体Arial小四缩进2字符各0.2行左对齐 注:(1)使用这种方法设置标题格式,是为了自动生成目录使用,一般生成到前三级。自动生成完的目录都会带有链接,同时按下“Ctrl+Shift+F9”可以去掉该链接;失去链接后的目录文字带有下划线,此时选中目录,然后按下“ ”即可去掉。
目录格式也可以通过“ ”→“ ”设置。(2)检查标题是否完整。
最多生成到5级进行查看。(3)标题末尾一定不要用标点符号。
2.表 (1)表标题在表体上方,与不能分开。表标题应设为自动更新。
表标题格式字号应比正文字号小一号。(2)表字格式单独设置。
字号应比正文字号小一号。例如:宋体、Times New Roman、小五。
注意表字行距、对齐方式、行高,不要太空。(3)尽量使用三线表,即左、右及中间边线是空的。
为了对齐可使用白颜色的的表线。样表见表1。
(4)正文中必须对文档中出现的表进行说明。(5)注意表的对齐方式,尽量使用通栏表,如表1。
3.图 (1)文档中的图和图标题都必须放在四周边线是空白的表格中。注意:图标题放在图下方,图和图标题不是组合在一起的。
表标题应设为自动更新。图字格式应单独设置。
(2)如果要使用word图时,不要直接在原文档中绘图,而是应该另外新建一个专门用来画图的文档,在这个文档中完成该图。然后再将该图复制后,通过选择“ ”中的“图片”进行粘贴,这样可放大缩小。
注意图应设为“ ”。(3)在word中画图时,若要在“ ”中插入文字时,必须设置文本框的内部边距上下左右均为0。
(4)如果要在文档中插入非word图,则必须将图所在的文件转换成PDF格式,然后将该PDF放大到400%时进行截图。截图若有边线或空边可通过设置图片 边距解决。
(5)正文中必须对文档中出现的图进行说明。4.正文 (1)正文格式:字体:中文-宋体,英文-Times New Roman;字号:五号或小四;首行缩进2字符(中文)。
可使用18-22磅固定行距。不自动更新。
(2)不使用自动编号系统!不使用“Tab”键!(3)使用公式编辑器编辑的单独公式,行距使用“单倍行距”。5.参考文献 参考文献按在正文中出现的先后次序列表于文后。
文档的参考文献以[作者名 出版年]作为序号标识,如[2003王宜怀]、[2002Kegl]等。同时出现在正文与参考文献列表中。
在撰写正式论文初稿的过程中,参考文献的标识方法与文档同。论文完成后,使用查找/替换方法,将文中的序号标识更换为正式序号,并对文后的参考文献的位置进行调整并排序。
文献类型标识:以单字母方式标识以下各种参考文献类型:专著[M],论文集[C],报纸文章[N],期刊文章[J],学位论文[D],报告[R],标准[S],专利[P];对于论文集中析出的文献,其文献类型标识用[A];对于其他未说明文献类型,采用[Z];对于数据库、计算机程序及电子公告等电子文献类型,使用[文献类型标识/载体类型标识]:如:联机网上数据库[DB/OL],光盘图书[M/CD],网上期刊[J/OL],网上电子公告[EB/OL];格式举例:(1)专著、论文集、学位论文、报告:[序号]主要责任者.文献题名[文献类型标识].出版地:出版者,出版年,起止页码(任选).(2)期刊文章:[序号]主要责任者.文献题名[J],刊名,年,卷(期):起止页码.(3)论文集中的析出文献:[序号]析出文献主要责任者.析出文献题名[A].原文献主要责任者(任。
7.硬件开发的硬件开发文档规范
1、硬件需求说明书 硬件需求说明书是描写硬件开发目标,基本功能、基本配置,主要性能指标、运行环境,约束条件以及开发经费和进度等要求,它的要求依据是产品规格说明书和系统需求说明书。
它是硬件总体设计和制订硬件开发计划的依据,具体编写的内容有:系统工程组网及使用说明、硬件整体系统的基本功能和主要性能指标、硬件分系统的基本功能和主要性能指标以及功能模块的划分等。2、硬件总体设计报告 硬件总体设计报告是根据需求说明书的要求进行总体设计后出的报告,它是硬件详细设计的依据。
编写硬件总体设计报告应包含以下内容:系统总体结构及功能划分,系统逻辑框图、组成系统各功能模块的逻辑框图,电路结构图及单板组成,单板逻辑框图和电路结构图,以及可靠性、安全性、电磁兼容性讨论和硬件测试方案等。3、单板总体设计方案 在单板的总体设计方案定下来之后应出这份文档,单板总体设计方案应包含单板版本号,单板在整机中的位置、开发目的及主要功能,单板功能描述、单板逻辑框图及各功能模块说明,单板软件功能描述及功能模块划分、接口简单定义与相关板的关系,主要性能指标、功耗和采用标准。
4、单板硬件详细设计 在单板硬件进入到详细设计阶段,应提交单板硬件详细设计报告。在单板硬件详细设计中应着重体现:单板逻辑框图及各功能模块详细说明,各功能模块实现方式、地址分配、控制方式、接口方式、存贮器空间、中断方式、接口管脚信号详细定义、时序说明、性能指标、指示灯说明、外接线定义、可编程器件图、功能模块说明、原理图、详细物料清单以及单板测试、调试计划。
有时候一块单板的硬件和软件分别由两个开发人员开发,因此这时候单板硬件详细设计便为软件设计者提供了一个详细的指导,因此单板硬件详细设计报告至关重要。尤其是地址分配、控制方式、接口方式、中断方式是编制单板软件的基础,一定要详细写出。
5、单板软件详细设计 在单板软件设计完成后应相应完成单板软件详细设计报告,在报告中应列出完成单板软件的编程语言,编译器的调试环境,硬件描述与功能要求及数据结构等。要特别强调的是:要详细列出详细的设计细节,其中包括中断、主程序、子程序的功能、入口参数、出口参数、局部变量、函数调用和流程图。
在有关通讯协议的描述中,应说明物理层,链路层通讯协议和高层通讯协议由哪些文档定义。6、单板硬件过程调试文档 开发过程中,每次所投PCB板,工程师应提交一份过程文档,以便管理阶层了解进度,进行考评,另外也给其他相关工程师留下一份有参考价值的技术文档。
每次所投PCB板时应制作此文档。这份文档应包括以下内容:单板硬件功能模块划分,单板硬件各模块调试进度,调试中出现的问题及解决方法,原始数据记录、系统方案修改说明、单板方案修改说明、器件改换说明、原理图、PCB图修改说明、可编程器件修改说明、调试工作阶段总结、调试进展说明、下阶段调试计划以及测试方案的修改。
7、单板软件过程调试文档 每月收集一次单板软件过程调试文档,或调试完毕(指不满一月)收集,尽可能清楚,完整列出软件调试修改过程。单板软件过程调试文档应当包括以下内容:单板软件功能模块划分及各功能模块调试进度、单板软件调试出现问题及解决、下阶段的调试计划、测试方案修改。
8、单板系统联调报告 在项目进入单板系统联调阶段,应出单板系统联调报告。单板系统联调报告包括这些内容:系统功能模块划分、系统功能模块调试进展、系统接口信号的测试原始记录及分析、系统联调中出现问题及解决、调试技巧集锦、整机性能评估等。
9、单板硬件测试文档 在单板调试完之后,申请内部验收之前,应先进行自测以确保每个功能都能实现,每项指标都能满足。自测完毕应出单板硬件测试文档,单板硬件测试文档包括以下内容:单板功能模块划分、各功能模块设计输入输出信号及性能参数、各功能模块测试点确定、各测试参考点实测原始记录及分析、板内高速信号线测试原始记录及分析、系统I/O口信号线测试原始记录及分析,整板性能测试结果分析。
10、硬件信息库 为了共享技术资料,我们希望建立一个共享资料库,每一块单板都希望将的最有价值最有特色的资料归入此库。硬件信息库包括以下内容:典型应用电路、特色电路、特色芯片技术介绍、特色芯片的使用说明、驱动程序的流程图、源程序、相关硬件电路说明、PCB布板注意事项、单板调试中出现的典型及解决、软硬件设计及调试技巧。
8.电子开发文档怎么写
没写过,给你个范例。
开发文档范例一.需求规格说明书 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)测试要点:给出测试模块的主要测试要求。