
其次,你要确定你采用的周期模型和开发方法。不同的模型或方法会有不同的文档需求,这需要你自己裁剪直到适合你的开发团队,别忘了,文档也是为了提高开发效率、质量用的,让开发人员过多的写一些无味的文档,反而会降低效率。
再次,你要作出一些文档模板,模板中对文档的用途和结构做出明确的说明。
最后,就可以填充啦。
附一个RUP的需求描述文档模板
10 简 介
[介绍本文档的整体结构。]
11 目的
[说明本软件需求规格说明书的目的。软件需求规格说明书不仅需要完整的描述系统的行为,还需要说明非功能性的需求、设计约束以及其它相关的因素。]
12 范围
[简要介绍本需求规格文档适用的项目/应用程序及其主要特性或其它子系统、相关的用例模型和受其影响的其它任何事物。]
13 定义、术语和缩写
[详细定义正确地理解本文档的相关术语,包括定义、首字母缩写词和缩略语。可以通过引用术语表说明。]
14 参考资料
[说明本文档引用的任何其它相关文档。要列出文档的标题、文档编号、日期、和出版单位并说明文档的来源。]
15 概要
[说明本文档余下部分包含的内容及组织方式。]
20 说 明
[本节列出影响产品和需求的一般因素,但不需列出具体的需求,只需描述将在第3节中详细描述的需求的背景,以便于理解需求。这包括:产品总体效果,产品功能,用户特征,约束、假设和依赖,以及需求子集等。特别关键的是除了需要说明产品是或说解决什么,还要说明产品不是或不是解决什么。]
21 用例模型
[如果使用了用例模型,本小节概述适用于本系统的用例模型或子模型,包括所有用例和角色的名称和简要说明及用例图和关系。可将用例报告作为附件在此引用。]
22 假设与依赖
[说明所有重要的技术可行性、子系统或组件的可用性或可作为此说明书所描述的软件的基础的其它相关假设。]
30 需求描述
[详细描述软件的需求。其详细程度能够使设计人员设计出满足这些需求的系统;测试人员能够测试此系统是否真的满足这些需求。 在使用用例建模时,这些需求采用用例和可用的其它补充文档捕获 。]
31 用例报告
[用例模型通常定义了系统的主要功能性需求和一些非功能性需求。对用例模型中的每个用例都需要在此引用或附上用例报告。保证清晰的标明每个需求。]
32 补充说明
[描述没有包含在用例中的其它需求。此处应包含补充需求说明中适用于此系统的具体需求说明或特征,并重新提炼以足够详细地说明此系统。这些信息可直接记录在此文档中,也可以作为附件引用到单独的补充说明文档。同样要保证需求被清晰的定义。]
40 辅助信息
[辅助信息使此文档更容易使用。这可以是目录、索引、附录、用例示意图、用户界面原型等。如果包含附录,要明确说明此附录是否是需求的一部分。]嗯,这公司用的9000质量体系
1,器件清单就是你要的元器件的明细表,你用到的每一个原件都要有,包括电路板和电子原件,格式就是用excel表格写上编号,名称,型号,供方等,保证采购部门能根据这个清单买到所有需要的原件。
2,生产指导就是现在说怎么加工这个产品,也就是工艺流程,第一步做什么……保证制造部门能根据你的文件生产出达到设计要求的产品。
3,测试指导,就是测试方法,你要详细说明需要测试的点和测试条件,比如原件的耐压,温度变化的可靠性,极端条件下的寿命,保证检验部门能按照你的文件进行测试。
4,测试报告,就是测试结果,根据测试方法测试后得到的数据,用表格
5,说明书,说明本产品的性能和使用方法和注意事项,包括安全 *** 作等,这是给用户看的
6,测试软件,你用什么软件测试的,顺便截图做个word文档
7,市场报告,就是你做的市场调查,比如需求人群和情况,使用的营销策略。额……~肯定是有相关标准的吧~
话说我们每次做项目的文档也都不太一样~
我大概描述下我两年前的一个文档吧~(在邮箱里找到的)
1项目概述:
项目名称:
项目用途:
2需求分析
业务需求
用户需求
功能需求
性能需求
3
系统功能模型
4系统设计
41
总体设计
42
详细设计
421
系统的结构模型
422
系统的动态模型
423
主要程序说明
5主要代码实现
其他描述:
6测试:
黑盒测试:
白盒测试:
7系统维护
8参考文献
9结束语
中国版权保护中心接收登记的文档包含两种: *** 作说明书或设计说明书。
设计说明书适合没有界面的嵌入式软件,插件软件,后台运行软件以及游戏软件。一般包含结构图,软件流程图,函数说明,模块说明,数据接口,出错设计等。
*** 作说明书适合管理类软件,有 *** 作界面,一般应包含登录界面,主界面,功能界面截图,截图之间有相应的文字说明,能全面展示软件的主要功能。
格式要求:
一、说明书应提交前、后各连续30页,不足60页的,应当全部提交。
二、说明书页眉应标注软件的名称和版本号,应当与申请表中名称完全一致,页眉右上应标注页码,说明书每页不少于30行,有图除外,另外截图应该清晰完整。
(1)引言
①编写目的:阐明编写手册的目的,指明读者对象。
②项目背景:说明项目的来源、委托单位、开发单位及主管部门。
③定义:列出手册中用到的专门术语定义和缩写词的原意。
④
参考资料:
包括项目的计划任务书,合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;测试计划;手册中引用的其他资料、采用的软件工程标准或软件工程规范。
(2)软件概述
①目标。
②功能。
③性能。包括数据精确度(包括输入、输出及处理数据的精度),时间特性(如响应时间、处理时间、数据传输时问等),灵活性(在 *** 作方式、运行环境需做某些变更时软件的适应能力)。
(3)运行环境
①硬件:列出软件系统运行时所需的硬件最小配置,如计算机型号、主存容量;外存储器、媒体、记录格式、设备型号及数量;输入、输出设备;数据传输设备及数据转换设备的型号及数量。
②支持软件: *** 作系统名称及版本号;语言编译系统的名称及版本号;数据库管理系统的名称及版本号;其他必要的支持软件。
(4)使用说明
①安装和初始化:给出程序的存储形式、 *** 作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件开发工具等。
②输入:给出输入数据或参数的要求。
③输出:给出每项输出数据的说明。
④出错和恢复:出错信息及其含义、用户应采取的措施,如修改、恢复、再启动等。
⑤求助查询:说明如何 *** 作。
(5)运行说明
①运行表:列出每种可能的运行情况,说明其运行目的。
②运行步骤:按顺序说明每种运行的步骤,应包括运行控制; *** 作信息(运行目的、 *** 作要求、启动方法、预计运行时间、 *** 作命令格式及说明、其他事项);输入/输出文件(给出建立和更新文件的有关信息。
如文件的名称及编号、记录媒体、存留的目录、文件的支配[说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先级及保密控制等]);启动或恢复过程。
(6)非常规过程:提供应急或非常规 *** 作的必要信息及 *** 作步骤,如出错处理 *** 作、向后备系统切换 *** 作以及维护人员须知的 *** 作和注意事项。
(7) *** 作命令一览表:按字母顺序逐个列出全部 *** 作命令的格式、功能及参数说明。
(8)程序文件(或命令文件)和数据文件一览表:按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。
(9)用户 *** 作举例。
欢迎分享,转载请注明来源:内存溢出
微信扫一扫
支付宝扫一扫
评论列表(0条)