学校教材订购系统软件,软件需求分析说明书
教材购销系统软件需求说明书

实验报告(三)课程名称_ 软件工程 __ 共页系别_计算机学院_____________________ 实验日期 2012年 3月 23日专业班级__09计算机科学与技术1班 __ 实验报告日期年月日实验名称: 实验三软件需求规格说明书一.实验目的在软件系统数据流图和数据字典的基础上,学习软件需求说明书SRS的编写。
二.实验任务编写教材购销系统的软件需求说明书SRS。
三.实验要求按需求规格说明书格式编写:1.引言(1)编写目的:说明编写需求规格说明书的目的.(2)背景说明:软件产品的名称,项目的提出者、开发者及用户,软件产品能作什么。
(3)术语定义:列出文档中所用的专门术语的定义等.(4)参考资料:列出文档所引用的全部资料.2.概述(1)功能概述:列出待开发软件产品将完成的主要功能.(2)约束:叙述对系统设计产生影响的限制条件或特殊需求的理由,如管理模式、硬件限制、与其它应用系统的接口、安全保密等。
3.数据流图与数据字典(1)数据流图:加工说明(编号、加工名、输入流、输出流、加工逻辑)、数据流说明;(2)数据字典:文件说明(文件的成分及组织形式)、数据项说明。
4.接口(1)用户接口:屏幕格式、报表或菜单的页面格式及内容、功能键等;(2)硬件接口:软件产品与硬件各接口特点、运行软件的硬件设备等;(3)软件接口:该软件与其它软件之间的接口。
5.性能需求:精度、时间特征、灵活性等。
6.属性:可使用性、保密性、可维护性和可移植性。
7.其它需求:数据库、操作及故障处理。
四.实验内容教材购销系统软件需求说明书一、引言1.编写目的详细介绍教材购销系统的需求说明,为用户描述出一个具体的产品模型,为软件设计、开发及测试人员提供下步工作的依据。
此文档说明了系统的设计考虑,包括系统的功能概述、数据流图、数据字典、接口设计、性能需求、属性设计和故障处理设计等,为详细设计提供基础。
并控制系统进化过程,项目开发的目标是否完成根据需求规格说明书中确立的可测试标准决定。
学校教材订购系统需求规格说明书(新)

目录1.引言 (2)1.1编写目的 (2)1.2项目背景 (2)1.3定义........................................................................................................ 错误!未定义书签。
1.4参考资料 (3)2.任务概述 (4)2.1目标 (4)2.2用户的特点 (4)2.3条件与限制 (4)3.功能需求 (5)3.1系统功能 (5)3.2功能划分 (5)4需求规定 (6)4.1对性能的规定 (6)4.1.1精度 (6)4.1.2时间特性要求 (6)4.1.3可靠性 (6)4.1.4灵活性 (6)4.2数据管理能力要求 (6)4.3故障处理要求 (6)4.4其他专门要求 (7)5.数据描述 (8)5.1数据录入和处理的准确性和实时性 (8)5.2数据的一致性与完整性 (8)5.3实体—联系图 (8)5.4数据库描述 (9)5.5数据字典 (9)6.运行需求 (11)6.1设备 (11)6.2支持软件 (11)6.3接口 (11)6.4控制 (11)学校教材订购系统需求规格说明书1.引言1.1 编写目的随着生活节奏的加快和网络的发展,教师、学生对教材的订购越来越重视,希望获取教材的过程简单,方便,快速。
因而,做一个好的学校教材订购系统是十分重要的。
在本小组成员对系统进行了全面细致的分析后明确了该系统“做什么”,编写这份说明书的目的是将小组分析结果条理清晰的展示出来,它说明了本产品实现的各种功能以及各种功能的适用范围。
使小组成员充分认识本系统的情况,方便以后更好的开展具体工作。
本说明书主要提交给老师,小组成员和其他同学参考,以达到最终满足用户的要求,让用户满意。
1.2 项目背景项目名称:学校教材订购系统用户:学校教务科,教师,学生运行环境:计算机系机房开发平台:Eclipse、MySQL、JDK 1.6系统与其他软件,系统的关系:本系统可细化为两个子系统:销售系统和采购系统。
需求规格说明书(教材定购系统)

需求规格说明书(教材定购系统)第一篇:需求规格说明书(教材定购系统)《需求规格说明书》1.引言1.1编写目的对学校教材定购系统进行简单的分析,将该系统分为销售系统和采购系统。
方便教师与采购人员的使用,加深与用户间的交流,需求规格说明书力求在功能上满足用户的需要,在系统界面上使用户满意。
读者对象学生,教师,教材工作人员1.2项目背景本系统以学校为背景,在认真调研和分析了学校订购教材的现状之后,根据学生,教师和教材工作人员的需求和各个功能的关系,做出了积极的设计方案。
1.3定义数据流图(DFD):数据流图描绘信息流和数据从输入到输出的过程中所经受的变换,图中没有任何具体的物理元素,只是描绘信息在系统中流动和处理的情况。
系统的流程图:系统流程图是描绘物理系统的传统工具。
它的基本思想是用图形符号以黑盒子的形式描绘系统里的每个部件(程序,文件,数据库,表格,人工过程等)。
1.4参考资料《软件工程》张海藩编著人民邮电出版社2.任务概述2.1目标学校教材定购系统是为高等院校开发的,用于日常的教材管理,包括销售与采购。
提供数字化的管理,在新的管理资源和管理模式上,力争能使工作质量、工作效率等得到提高,推动学校发展的步伐。
2.2运行环境硬件要求:内存:1G以上;CPU:IntelCore21.80GHz系统要求:MyEclipse 集成开发工具,SQL数据库,画图工具以及windows word文档工具。
2.3条件与限制(1)当书库中的各种书籍数量发生变化(包括进书和出书)时,都应修改相关的书库记录。
(2)在实现上述销售和采购的工作过程时,需考虑有关的合法性验证。
(3)系统的外部项至少包括:教师、学生和教材工作人员。
(4)系统的相关数据存储至少包括:购书表、库存表、缺书登记表、待购教材表、进库表和出库表。
(5)系统方案选择时间需要2周,系统开发经费不少于3万。
3.数据描述3.1静态数据3.2动态数据【包括输入数据和输出数据。
学校教材订购系统详细设计说明书

学校教材订购系统详细设计说明书目录1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3基线 (2)1。
4特殊名词定义 (2)1.5参考资料 (2)2模块命名规则 (3)3程序系统的结构 (3)4程序的描述 (7)4.1教材销售系统模块 (7)4.1。
1功能的描述 (7)4.1。
2模块的IPO表 (7)4.1.3界面的设计 (8)4。
1.4主要算法 (10)4。
1.5流程逻辑 (10)4.1。
6接口 (11)4.1.7存储分配 (11)4.1。
8注释设计 (12)4.1.9限制条件 (14)4.1.10测试计划 (14)4.1。
11尚未解决的问题 (14)4.2教材采购系统模块 (14)1引言1.1编写目的本说明书目的在于明确说明系统各功能的实现方式,指导各成员进行编码。
本说明书的预期读者为:项目经理、程序开发人员、测试经理及测试人员等。
1。
2背景待开发软件系统的名称:学校教材订购系统此软件系统任务提出者:学校此软件系统任务开发者:12信管专业此软件系统任务用户:学校教材订购处1。
3基线学校教材订购系统需求分析说明书v1.1学校教材订购系统概要设计说明书v1。
11.4特殊名词定义1.5参考资料学校教材订购系统需求分析说明书学校教材订购系统概要分析说明书所用到的相关资料,文件以及标准如下:2模块命名规则3 程序系统的结构本系统的软件结构图如下所示:说明:学校教材订购系统包括教材销售模块和教材采购模块、退出系统模块,教材销售模块包含如下功能:教材浏览、填写订单、订单结账、新书通知;教材采购模块包含教材入库和缺书通知。
销售系统的用例图如下所示:采购系统模块的时序图如下:教材入库的时序图:说明:当教材采购人员输入教材名称时,系统会通过查询数据库,检查教材是否存在,当查询结果存在时,接着就是要填入教材入库的数量,系统就会在数据库中更新教材的数量。
查看缺书通知的时序图:说明:教材采购人员通过客户端查询缺书通知,系统会通过数据库查找缺书信息,接着系统会返回缺书的信息,然后打印缺书信息的列表,其他相关人员就会根据这个列表进行相关的处理。
学校教材购销系统需求分析报告书.

实体:客观世界中存在的且可互相区别的事物。
联系:客观事物中的彼此之间的关系。
属性:实体或者联系所具有的性质。
1.4
<<软件工程>>--------张海藩编著
清华大学出版社
<<数据库系统概论>>--------王珊萨师煊主编
图1教材购销系统概图
2.2
本系统用户的特点:本软件的最终用户可分为操作人员、维护人员。
其中,操作人员要求对计算机有一定了解的企业技术人员。最好能熟练运用计算机所用操作系统,精通所用系统功能,
维护人员要求对本系统有较深的了解,同时对系统相关信息及工作流程有所了解的技术人员。
本系统主要在学期开学发书、学期结束订书时大幅度使用,这时候也是本系统最需要维护的时候,所以在这时候要对本系统进行必要的检修,防止数据出错。
3
3.1
本系统在向学生售书时主要输入学生学号、班级代号、购书数量、购书书名信息,然后打印领书单返回给学生领取书籍。
本系统在查询数据库时主要输入需要查询的相关信息,包括图书编号、图书书名、出版社信息、图书特色等信息方便操作人员把握图书信息。
本系统还兼顾一点财务信息的管理,在发生单人购书时,系统直接向购书者收取现金,内部形成一个小小的财务管理。
组织:
备注:
数据流名称:进书通知
组成:书籍名称+书籍编号+书籍出版社数量+出版时间+单价+总价+书籍信息
组织:
备注:
数据流名称:教学用书单
组成:书籍名称+书籍编号+书籍出版社+出版时间+数量+单价+书籍信息
组织:
备注:
教材订购系统需求说明书

学校教材订购系统软件需求说明书1引言错误!未定义书签。
编写目的................................................... 错误!未定义书签。
背景 ...................................................... 错误!未定义书签。
概念 ...................................................... 错误!未定义书签。
参考资料................................................... 错误!未定义书签。
2任务概述错误!未定义书签。
目标 ...................................................... 错误!未定义书签。
用户的特点................................................. 错误!未定义书签。
假定和约束................................................. 错误!未定义书签。
3需求规定错误!未定义书签。
对功能的规定............................................................................................... 错误!未定义书签。
对性能的规定............................................................................................... 错误!未定义书签。
精度........................................................................................................... 错误!未定义书签。
学校教材订购系统需求分析说明书

学校教材订购系统软件需求规格说明书目录1.引言 (2)1.1 编写目的 (2)1.2 项目背景 (2)2.目标系统概述 (2)2.1 目标 (2)2.2 用户的特点 (2)2.3 假定和约束 (2)3.需求规定 (2)3.1 软件功能的规定 (2)3.1.1 系统功能 (2)3.1.2 数据流图 (3)3.1.3 数据字典 (5)3.1.4 E-R图 (7)3.2 对性能的规定 (7)3.2.1 精度 (7)3.2.2 时间特性要求 (7)3.2.3 可靠性 (7)3.2.4 灵活性 (7)3.2.5 数据管理能力要求 (8)3.2.6 故障处理要求 (8)3.2.7 其他专门要求 (8)4.运行环境规定 (8)4.1 设备 (8)4.2 支持软件 (8)4.3 接口 (8)4.4 控制 (8)1.引言1.1 编写目的随着生活节奏的加快和网络的发展,教师、学生对教材的订购越来越重视,希望获取教材的过程简单,方便,快速。
因而,做一个好的学校教材订购系统是十分重要的。
在本小组成员对系统进行了全面细致的分析后明确了该系统“做什么”,编写这份说明书的目的是将小组分析结果条理清晰的展示出来,它说明了本产品实现的各种功能以及各种功能的适用范围。
使小组成员充分认识本系统的情况,方便以后更好的开展具体工作。
本说明书主要提交给老师,小组成员和其他同学参考,以达到最终满足用户的要求,让用户满意。
1.2 项目背景项目名称:学校教材订购系统用户:学校教务科,教师,学生2.目标系统概述2.1 目标本系统可细化为两个子系统:销售系统和采购系统。
销售系统的工作过程为:首先由教师或学生提交购书单,经教材科发行人员审核是有效购书单后,开发票、登记并返给教师或学生领书单,教师或学生即可去书库领书。
若是脱销教材则生成缺书单。
采购系统的主要工作过程为:汇总缺书单,发采购单给书库采购人员;一旦新书入库后,即发到货通知。
2.2 用户的特点本软件的最终用户可分为操作人员、维护人员。
学校教材购销系统需求分析报告书.

1
1.1
随着信息时代的高速发展,网络在我们日常生活中已非常普及了,在网上学习,交友已经被广泛使用。尤其是大学生,对知识的需求量越来越大,知识的范围也越来越广,自己一人能力实在有限,为了帮助同学实现学习互动,交友互助,营造良好地学习氛围,决定为我校(西安理工大学)创建一个多功能的网上学习型社区。使学生们可以随时有问题随时问,多种解答互填互补,帮助学生全面理解问题。还可以交友,使学生多了更多学习伙伴,促进自己的学习,帮助自己的生活。
备注:
数据元素名称:书号
取值:数值(书籍特殊编号)
备注:
数据元素名称:年级
取值:入学年份
备注:
数据元素名称:院系
取值:院系编号
备注:
数据元素名称:学号
取值:入学年份+院系代号+班级代号+排序
备注:
数据元素名称:书费合计
取值:000.00~999.99
备注:
根据以上的分析,最终得到了教材购销系统的工作流程图:如图1.8所示
组织:
备注:学号、班级、姓名可为空
数据存储名称:补售书表
组成:学号+姓名+班级+所购书号+书名+数量+书籍信息
组织:
备注:
数据存储名称:教学用书表
组成:书名+书号+出版社+出版时间+数量+书籍信息
组织:
备注:
数据元素描述
数据元素名称:数量
取值:正整数00000~99999
备注:
数据元素名称:书名
取值:字符(满足计算机取值要求)
图1.4第三层DFD-----销售子系统
图1.4中,销售子系统被分解为3个子加工,编号从2.1.到2.3,登记售书和打印领书单时,学生或教师持购书单申请购书,所购书存在就发给领书单到仓库领取所购书籍。若所购书籍暂时没有就登记缺书登记表,打印缺书登记单通知采购子系统购书,并产生补售书单,待书籍到库时通知学生或教师领书。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
学校教材订购系统需求规格说明书1、引言1.1编写目的需求规格说明书是需求分析的产物,它是软件系统生存期中软件定义阶段的最后一个步骤。
本系统在可行性研究的基础上,是为了进一步明确该系统的软件需求,以便安排项目规划与进度,组织软件开发与测试,撰写本文档。
本文档供项目经理、设计人员、开发人员参考。
1.2项目背景开发软件名称:学校教材订购系统项目任务提出者:软件工程老师项目开发者:计科N092用户:学校教材管理部门和全校师生实现该软件的计算机网络:计算机科学实验室项目与其他软件,系统的关系:本项目采用客户机/服务器原理,客户端的程序是建立在Windows NT 系统上以JAVA以及MySql数据库等为开发软件的应用程序。
1.3定义数据流图:数据流图描绘系统的逻辑模型,图中没有任何具体的物理元素,只是描绘信息在系统中流动和处理的情况。
系统的流程图:系统流程图是描绘物理系统的传统工具。
它的基本思想是用图形符号以黑盒子的形式描绘系统里的每个部件(程序,文件,数据库,表格,人工过程等)。
库存表:存放库中存在得书籍数据。
出库表:存放已销售的书籍的数据。
进库表:存放入库书籍的数据。
购书表:存放提交的购书信息。
缺书登记表:存放缺少的书籍的信息。
待购教材表:存放待购书籍信息。
1.4参考资料1.《软件工程导论》(第四版) 张海藩,清华大学出版社,20032.《实用软件工程》(第二版) 郑人杰等,清华大学出版社,19974.《Java语言程序设计》马皓等,清华大学出版社,20063.《Eclipse使用教程》林峰等,东南大学出版社,20084.《MySQL使用手册》2、任务概述2.1目标1)学生和老师能够随时登录订购教材、查看和修改订购单,还可以查看领书单。
2)发行人员能随时登录处理订购单、查看库存和输入初始的库存书籍,还有查看进书通知。
3)采购人员能随时登录系统查看缺书单,填写进书单。
2.2运行环境运行环境:Windows XP,Vista等数据库:Mysql可利用的信息和资源:互联网信息,实验室2.3条件、假定和约束所建议的系统的运行寿命的最小值:3年进行系统方案选择比较的时间为:3周 经费、投资方面的来源和限制:小组筹集硬件条件:CPU 为Pentium4以上,内存为256MB 以上3、需求规定3.1对功能的规定 3.1.1系统功能本系统在向学生售书时主要输入学生学号、班级代号、购书数量、购书书名信息,然后打印领书单返回给学生领取书籍。
本系统在查询数据库时主要输入需要查询的相关信息,包括图书编号、图书书名、出版社信息、图书特色等信息方便操作人员把握图书信息。
教材订购系统的功能可以划分为如下几个部分:1)系统帐户管理:主要是对系统用户进行管理,包括登陆、退出、操作记录等。
2)销售管理:提交购书单、审核购书单、开发票、登记购书纪录、返回领书单、修改和维护数据库中相应的表。
3)采购管理:发缺书单、登记缺书纪录、拟订待购书信息、发进书通知单、修改和维护数据库中相应的表。
3.1.2数据流图 顶层图:学校教材订购系统流程图教材发行人员教师或学生购书单审核信进书通知进书通知缺书单领书单大学教材订购系统采购人员3.1.3数据字典本系统的部分数据字典如下:名字:订购单别名:订书单描述:送给采购员的定书表定义:订购单=购书单号+书号+购书日期+订购者编号+订购者姓名+数量+总额购书单号=以1开头的1--50位数字书号=50位以数字开头的数字与字母的组合购书日期=购书当天的时间格式为:*年*月*日订购者编号=教师工号|学生学号订购者姓名=教师姓名|学生姓名数量=1|2|3|4……|10000000总额=1|2|3|4……|10000000位置:输出到打印机名字:进书单别名:进书信息描述:详细的描述了进书的信息定义:进书单=进书单号+书号+采购人姓名+采购日期+采购总数+采购总额进书单号=以2开头的1--50位数字书号=50位以数字开头的数字与字母的组合采购者姓名=教师姓名采购日期=购书当天的时间格式为:*年*月*日采购总数=1|2|3|4……|10000000采购总额=1|2|3|4……|10000000名字:领书单别名:领书表描述:送给学生或教师的领书报表定义:领书单=领书单号,订购者编号,领书日期,购书单号,购书日期,经办人领书单号=以3开头的1--50位数字订购者编号=教师工号|学生学号领书日期=领书当天的时间格式为:*年*月*日购书单号=以1开头的1--50位数字购书日期=购书当天的时间格式为:*年*月*日经办人=教师姓名位置:输出到打印机别名:缺书表描述:送给相关工作人员的表,用来补充书籍定义:缺书单=缺书单号+书号+总数缺书单号=以4开头的1--50位数字书号=50位以数字开头的数字与字母的组合总数=1|2|3|4……|10000000位置:输出到打印机名字:入库单别名:入库表定义:入库单=入库号+书号+数量+入库时间入库号=以5开头的1--50位数字书号=50位以数字开头的数字与字母的组合数量=1|2|3|4……|10000000入库时间=入库当天的时间格式为:*年*月*日名字:出库表定义:出库表=出库号+书号+数量+出库时间出库号=以6头的1--50位数字书号=50位以数字开头的数字与字母的组合数量=1|2|3|4……|10000000出库时间=出库当天的时间格式为:*年*月*日名字:库存表定义:库存表=记录号+书号+数量记录号=以7头的1--50位数字书号=50位以数字开头的数字与字母的组合数量=1|2|3|4……|10000000名字:教材信息定义:教材信息=书号+书名+编者+出版社+单价书号=50位以数字开头的数字与字母的组合书名=教材的名称编者=教材的作者出版社=出版教材的出版社单价=出售教材的价格格式为:1|2|3|4……|10000000定义:学生信息=学生学号+学生姓名+学生性别+学生班级+电话学生学号=以数字11开头的10为数字学生姓名=订购学生的姓名学生性别=男|女学生年级=大一|大二|大三|大四电话=1|2|3|4……|50名字:教师信息定义:教师信息=教师工号+教师姓名+教师性别+教师部门+电话教师学号=以数字22开头的10为数字教师生姓名=订购教师的姓名教师性别=男|女教师部门=机械|电气|生化|数学|人文|计算机|其他电话=1|2|3|4……|503.2对性能的规定3.2.1精度购书是由需求决定的,只要有缺书现象则会体现出来,但也因为这样,如果需要提前多购相关书籍的话,则需要管理人员的参与。
3.2.2时间特性要求定购需要提前若干天1)系统的更新处理时间应该在可接受的范围内;2)系统的数据查询时间应该在可接受的范围内;3)系统的数据统计时间应该在可接受的范围内。
3.2.3 灵活性在购书单未审核时,可以撤消订购或修改,一旦审核,则不能再修改。
1)操作方式上应该能够满足鼠标和键盘任意切换的需要;2)能够支持Windows95、Windows98、Windows2000、Windows Me、Windows XP运行环境。
3)留有与其他系统的接口。
3.3 输入输出要求输入项目销售子系统模块:需要输入购书单中要求的信息(提交人姓名、书名、书号、数量、身份识别码)。
采购子系统模块:需要输入缺书单中要求的信息(书名、书号、数量)。
输出项目销售子系统模块:需要打印领书单(书名、书号、数量、领书人姓名),发票(书名、书号、开票人姓名、交易金额、交易日期)。
采购子系统模块:需要打印进书通知单(书号、书名、进书日期)。
3.4数据管理能力由于教材管理部门需要对教材的信息进行长期的保存,再加上教材的出库或入库比较频繁,因此对数据的存储有一定的要求。
3.5故障处理要求在输入不符合定义格式的数据时,软件应出现提示信息,而不是死机或是删除已经输入的信息,然后再弹出输入界面重新开始。
其他情形不再一一描述。
4 、运行环境设定4.1 设备运行本软件要求处理器在奔腾Ⅲ以上,内存在256MB以上的计算机。
4.2 支持软件本系统支持的操作系统包括:Windows95 、Windows98 、Windows2000、Windows Me Windows XP .本系统支持的数据库:SQL Server 2000.本软件的开发工具:Java、Eclipse。
实验一编制软件需求分析说明书(学时:6 )一、背景知识软件文件 (document,通常又称为文档) ,是指与软件研制、维护和使用有关的材料,是以人们可读的形式出现的技术数据和信息。
软件文件的作用可概括为:1. 提高软件开发过程的能见度。
把软件开发过程中一些“不可见的”事物转变为“可见的”文字资料,以使管理人员在软件开发各阶段进行进度控制及软件质量管理。
2. 提高开发效率。
软件文件的编制将使开发人员对各个阶段的工作都进行周密思考、全盘权衡,从而减少返工,并可在开发早期发现错误及不一致性,便于及时纠正。
3. 作为开发人员在一定阶段内的工作成果和结束标志。
4. 记录开发过程中的有关技术信息,便于协调以后的软件开发、使用和维护。
5. 提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员和用户之间的协作、交流和了解,使软件开发活动更加科学、更有成效。
6. 便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需求的软件提供依据。
在有关软件工程的各项国家标准中,对软件文件的编制做出了具体而详尽的叙述。
例如,计算机软件产品开发文件编制指南 (GB/T8567-1988) 建议在软件的开发过程中编制下述14种文件,即:可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、数据库设计说明书、用户手册、操作手册、模块开发卷宗、测试计划、测试分析报告、开发进度月报以及项目开发总结报告等;计算机软件需求说明编制指南(GB/T9385-1988) 和计算机软件测试文件编制规范 (GB/T9386-1988) 等则对上述中的一些文件的编制有更为详尽的阐述;软件文档管理指南 (GB/T16680-1996) 为那些对软件或基于软件的产品的开发负有职责的管理者提供了软件文档的管理指南。
计算机软件产品开发文件编制指南 (GB/T8567-1988) 给出的14种软件文件的编制提示,同时也是这14种文件编写质量的检验准则。
高质量的文件应当体现在以下一些方面:1) 针对性:应分清读者对象,按不同类型、不同层次的读者,决定怎样适应他们的需要。
2) 精确性:文件的行文应当十分确切,不能出现多义性的描述。
3) 清晰性:文件编写应力求简明,如有可能,配以适当图表,以增强其清晰性。
4) 完整性:任何一个文件都应是完整的、独立的,它应自成体系。