实验六 软件工程标准与文档

合集下载

软件工程实验

软件工程实验

软件工程实验软件工程实验实验目的本文档旨在介绍软件工程实验的目的和实验内容,帮助读者了解实验的目标以及实施过程。

实验背景软件工程实验是一门重要的课程,通过实践操作使学生能够运用所学的软件工程知识,提升实际问题解决能力。

通过实验,学生能够深入了解软件开发过程、软件测试方法和软件质量管理等方面的知识。

实验目标本次软件工程实验的目标是使学生掌握以下技能和知识:1. 理解软件开发的流程和方法,包括需求分析、设计、编码、测试和维护等阶段。

2. 掌握常用的软件开发工具和技术,如项目管理工具、代码版本控制工具、集成开发环境等。

3. 能够进行软件需求分析和系统设计,具备编写软件设计文档的能力。

4. 能够进行软件测试,包括单元测试、集成测试、系统测试等,并能够编写测试用例和测试报告。

5. 熟悉软件质量管理的基本概念和方法。

实验内容本次软件工程实验的内容包括以下几个方面:1. 需求分析和系统设计首先,学生需要选择一个实际的软件项目作为实验对象,并进行需求分析。

需求分析包括搜集用户需求、定义软件功能和性能要求。

在需求分析的基础上,学生需要进行系统设计,确定软件系统的整体结构和各个模块之间的关系。

2. 编码和测试学生需要按照需求分析和系统设计的结果,进行编码工作。

在编码过程中,应该遵循良好的编码规范和编码风格,保证代码的可读性和可维护性。

编码完成后,学生需要进行软件测试,包括单元测试、集成测试和系统测试等。

3. 软件质量管理学生需要学习软件质量管理的基本概念和方法,并在实验过程中进行质量管理工作。

包括制定软件质量计划、执行质量控制、进行质量评审等。

4. 实验报告撰写最后,学生需要编写实验报告,详细记录实验过程、实验结果和实验感想等,并对实验中遇到的问题和解决方法进行总结和分析。

实验要求在进行软件工程实验时,学生需要按照以下要求进行操作:1. 需要根据实验目标和实验内容,提前准备好所需要的工具和资料。

2. 实验过程中,需遵循软件工程的基本原则和方法,保证实验结果的准确性和可靠性。

软件工程项目标准化文档5篇

软件工程项目标准化文档5篇

软件工程项目标准化文档5篇第一篇:软件工程项目标准化文档文档编写标准化文档编写标准化在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。

◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。

◇项目开发计划:为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

◇软件需求说明书(软件规格说明书):对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。

◇概要设计说明书:该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。

◇详细设计说明书:着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

◇用户操作手册:本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。

◇测试计划:为做好集成测试和验收测试,需为如何组织测试制订实施计划。

计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

◇测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。

◇开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

◇项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。

软件工程实验文档(精选五篇)

软件工程实验文档(精选五篇)

软件工程实验文档(精选五篇)第一篇:软件工程实验文档《软件工程课程设计》一、提交实验报告文挡及要求序报告名目的要求号称以全面、系统的分析为主要方法,经济效益为核心,围绕影响项目的可行性各种因素,运用大量的数据资料论证拟建项目是否可行,给出项目可1分析行性分析报告。

2 3 项目需根据给定的的题目或自选题目进行需求分析工作;进行功能需求、非求分析功能需求分析得出需求规格说明书。

项目概建立初始结构图,对初始结构构图进行改进、优化得出概要设计说明要设计书。

项目详进行详细设计工作,得出详细设计说明书。

细设计项目编本次实习不需编码码 5进行黑盒、白盒测试试用例设计形成测试用例表;项目测进行黑盒测试,得出测试记录; 6试进行白盒测试,得出测试记录;形成测试报告。

7 项目管利用Project进行项目计划、进度、协调等管理材料。

理二、课程实践选题(课程设计题目)题目一:电子商务网站建设是一个集客户购物、下订单、订单处理、销售统计等功能于一体的系统。

通过浏览器,让客户可以查询货物,把货物放入购物车,创建账户/登陆账户,创建订单,通过信用卡支付等。

系统划分成了多个模块,松耦合的设计架构,允许可以和多个数据源,EIS(企业信息系统)进行交互。

功能如下: 1.用户注册/登陆/忘记密码/管理个人信息查询货物购物车管理提交订单信用卡支付查询历史购物记录 2.货物商店接受/处理订单消息手工接受/拒绝订单用E-mail来通知客户发订单给供应商销售统计 3.供应商接受订单派送货物给用户提供一个基于web的库存管理维护库存数据库题目二:外文图书采购系统 1.问题概述某图书馆外文采购有两个组--征订组和验收登记组。

分别承担书籍订购和进书验收任务。

为了减轻劳动强度和提高工作效率,打算采用计算机进行管理。

为此,系统分析员在进行了调查研究,描述出外文采购室现行系流程。

1)订书组从供书单价收到订书目录,根据各单位的需要选择出要订购的书目。

2)为了避免浪费,对于已进入过或已订过的图书和订单留底。

软件工程标准化文档

软件工程标准化文档

实验一软件工程标准化文档1、实验目的与要求(1) 熟悉软件工程标准化的概念、国家标准规范和意义;⑵了解支持国家标准和行业标准信息的网站;(3)深入学习和掌握软件产品开发文件的基本内容;(4)结合软件工程课程,学习和掌握软件产品开发文件的基本内容。

2、实验内容(1) 上网搜索和浏览:了解国家标准咨询服务的专业网站、了解信息技术标准、软件工程国家标准;(2) 软件工程标准化的概念:查阅资料了解国内外标准状况和代号及说明;⑶了解软件工程国家标准制单位、情况、内容;⑷熟悉和掌握国家标准GB/T8567-2006;⑸完成表1-表3的内容。

3、实验步骤(1)请查阅相关网站或资料,了解软件工程标准一般分为哪5个层次,完成表1的内容。

表1软件工程标准的5个层次(2)查阅相关网站了解GB、GJB、ISO、ANSI、IEEE的含义,完成表格2-2 的内容。

表2缩写术语解释(3)请参阅有关资料(教科书、背景知识或专业网站等),了解就一个软件而言, 其生存周期各阶段与各种文件编写的关系,并在表3中适当的位置填上“^”表3软件生存周期各阶段中的文件编制4、实验结果⑴查阅了相关网站或资料,了解了软件工程标准的5个层次,即国际标准ISO、国家标准GB/ANSI/FIPS/BS/JIS、行业标准IEEE、企业规范、项目规范,完成了表1的内容。

⑵查阅了相关网站,了解了GB、GJB、ISO、ANSI、IEEE的含义(或全称)和定义(或解释),完成了表2的内容(3)软件文件是在软件开发过程中产生的,与软件生存周期有着密切关系。

参阅了有关资料(教科书、背景知识或专业网站等),了解了就一个软件而言,其生存周期各阶段与各种文件编写的关系,完成了表3的内容。

软件工程标准化文档

软件工程标准化文档

软件工程标准化文档引言本文档旨在对软件工程中的标准化进行详细规定和说明,以确保软件开发过程中的高质量和良好的工程实践。

标准化主要包括代码规范、文档规范、测试规范、发布规范等方面,以确保软件开发的可维护性、可测试性和可扩展性。

代码规范1. 代码命名规范使用有意义且符合语义的变量、函数和类名。

遵循驼峰命名法。

避免使用缩写和简写。

2. 代码风格规范使用一致的缩进风格,推荐使用4个空格缩进。

使用一致的代码注释风格,包括函数注释、类注释和代码块注释。

避免代码冗余和过长的代码行。

3. 代码结构规范按照模块化原则进行代码组织,确保代码的可重用性和易维护性。

使用适当的设计模式和架构风格。

避免过度耦合和代码分散。

文档规范1. 文档结构规范文档应包括标题、引言、目录、和参考文献等部分。

应按照合适的章节划分,以清晰表达内容层次。

使用合适的标题和编号,以便于查阅和引用。

2. 文档风格规范使用简洁明了的语言,避免使用复杂的术语和专业名词。

表达清晰、准确,避免歧义和模糊性。

使用合适的排版和格式,以增强可读性。

3. 文档内容规范文档应包括对软件需求、设计、实现和测试等方面的详细描述。

说明软件的功能、性能、安全、可靠性等关键特性。

提供关于软件的使用说明和操作手册。

测试规范1. 测试计划规范编写详细的测试计划,包括测试范围、测试目标和测试资源等。

制定合理的测试策略和测试方法。

2. 测试用例规范编写清晰、可执行的测试用例。

确保测试用例能够涵盖软件的各个功能和边界条件。

3. 测试执行规范按照测试计划执行测试用例。

记录并报告测试结果,包括测试通过的用例和发现的缺陷。

4. 测试评估规范对测试结果进行评估和分析,以确定软件的质量和稳定性。

根据测试结果进行软件的优化和修复。

发布规范1. 版本管理规范使用版本控制工具管理软件的版本。

确保每个发布版本都有唯一的版本号。

记录每个版本的发布日期和变更内容。

2. 发布过程规范定义清晰的发布流程和步骤。

软件工程实验实验内容及格式_软件工程的内容

软件工程实验实验内容及格式_软件工程的内容

《软件工程》实验内容及格式A .实验报告格式实验名称实验序号实验名称例如实验二用Visio 设计程序流程图、系统流程图和软件结构图一.实验目的二.实验类型(基本型、应用型、综合型)三.实验步骤简述实验成功(或失败)的过程,对于较为复杂的或带有综合性的实验需要写实验步骤,简述关键性过程即可。

四.实验结果截图形式,每个图要有标题。

有些不易看懂的结果,还应有适当的注解。

五.结果分析对于有一定难度的实验,无论成功与失败,适当做一些简要的分析与说明。

六.结束语对本实验的总结和感受。

例如,可对各个实验的成功所获得的经验及技巧进行适当的总结,还可谈谈你的一些感受。

B .实验课题名称(基本型、应用型、综合型)(一)基本型(带”*”为自由选作,其余为必做)用Visio 设计数据流图、ER 图和状态图。

Visio CodeWFDWY-XQXJF-RHRYG-BG7RQ-BBDHM用Visio 设计程序流程图、系统流程图和软件结构图程序流程图绘制参照右图和下图一元二次方程求根程序流程图和三角形类别判定程序流程图用Visio 进行UML(类图、用例图等) 设计完成软件白盒测试技术中的逻辑覆盖测试应用设计实验。

(理论考试重点内容实践)要求1)自备C 语言程序(可从C 语言程序设计的教科书上摘录若干典型程序, 其他C++、C#、Java 程序均可);2)根据该程序绘制对应的程序流程图;3)分别根据程序流程图给出符合语句覆盖、判定覆盖、条件覆盖、路径覆盖以及判定/条件覆盖和条件组合覆盖的的测试用例以及预期的运行结果;4)根据上述测试用例执行程序, 对比实际运行结果和预期运行结果, 结果比对最好采用表格的形式。

5)对以上实验结果进行适当地分析与总结。

完成软件白盒测试技术中的基本路径测试应用设计实验。

(理论考试重点内容实践)要求1)自备C 语言程序(可从C 语言程序设计的教科书上摘录若干典型程序, 其他C++、C#、Java 程序均可);2)根据该程序绘制对应的程序流程图;3)根据程序流程图画出流图,并确定线性独立路径的基本集合,然后给出符合各集合的测试用例;4)根据上述测试用例执行程序, 对比实际运行结果和预期运行结果, 结果比对最好采用表格的形式。

《软件工程实用教程》第10章 软件工程标准与文档

《软件工程实用教程》第10章 软件工程标准与文档

《软件工程实用教程》第10章软件工程标准与文档软件工程实用教程第10章软件工程标准与文档10.1 软件工程标准10.1.1 软件工程标准的定义软件工程标准是指为了规范和统一软件工程领域的活动、产品和过程而制定的一系列规范和指南。

10.1.2 软件工程标准的分类根据ISO/IEC 12207标准,软件工程标准可以分为四个主要类别:1、过程标准:定义软件工程过程的基本原则和规范,如ISO/IEC 12207标准;2、产品标准:定义软件工程产品的开发、评审和验证要求,如ISO/IEC 9126标准;3、测试标准:定义软件测试的方法、技术和规范,如ISO/IEC 25000标准;4、文档标准:定义软件工程文档的编写和管理规范,如ISO/IEC/IEEE 26515标准。

10.2 软件工程文档10.2.1 软件工程文档的定义软件工程文档是为了记录和传递软件开发过程中各种信息而编写的文件。

10.2.2 软件工程文档的目的主要目的是促进软件工程的沟通、交流和合作,确保软件开发过程能够明确、有序地进行。

10.2.3 软件工程文档的分类根据软件工程过程的不同阶段和功能,软件工程文档可以分为以下几种类型:1、需求文档:描述用户需求、系统规范和功能需求;2、设计文档:描述系统的总体设计、模块划分和接口定义;3、编码文档:描述程序的逻辑结构、算法和源代码;4、测试文档:描述测试计划、测试用例和测试结果;5、用户手册:描述系统的安装、配置和使用方法;6、运维手册:描述系统的运行、监控和维护方法。

10.3 软件工程文档编写规范10.3.1 文档命名规范为了方便管理和查找,软件工程文档应该采用统一的命名规范,一般包括项目名称、文档类型和版本号等信息。

10.3.2 文档格式规范软件工程文档应该采用标准的文档格式,一般包括标题、目录、正文、参考文献和附录等部分。

10.3.3 文档内容规范软件工程文档应该包含清晰、准确、完整的信息,能够满足用户的需求,并且需要经过严格的审核和审查。

软件工程标准化文档

软件工程标准化文档

软件工程标准化文档软件工程标准化文档1、引言1.1 文档目的1.2 文档范围1.3 参考文献1.4 定义术语2、背景2.1 发展背景2.2 目标与原则2.3 应用范围2.4 相关标准3、管理范围3.1 项目概述3.2 项目目标和约束3.3 项目计划和进度安排3.4 资源分配和管理4、需求分析4.1 功能需求4.2 非功能需求4.3 用户需求4.4 系统需求5、设计文档5.1 架构设计5.2 模块设计5.3 数据库设计5.4 用户界面设计5.5 接口设计6、编码规范6.1 命名规范6.2 代码格式规范 6.3 注释规范6.4 异常处理规范6.5 版本控制规范7、测试计划7.1 测试目标和策略7.2 测试环境和工具7.3 测试用例设计7.4 测试执行结果7.5 缺陷管理8、质量保证8.1 质量目标和控制措施 8.2 验证方法和技术8.3 缺陷修复和预防措施8.4 结果评估和优化9、部署与维护9.1 部署计划和流程9.2 上线和发布控制9.3 系统维护和支持9.4 用户培训和文档10、变更管理10.1 变更控制流程 10.2 变更评估和审核 10.3 变更实施和验证10.4 变更记录和报告11、问题追踪和解决11.1 问题定义和分类 11.2 问题跟踪和分析11.3 问题解决和关闭12、文档管理12.1 文档库管理12.2 文档命名和编号 12.3 文档审查和批准 12.4 文档更新和发布本文档涉及附件:附件1:项目计划表附件2:需求规格说明书附件3:设计文档附件4:测试报告附件5:用户手册本文所涉及的法律名词及注释:1、版权法:保护著作物的创作权和相关权益的法律法规。

2、商标法:保护商标所有人的商标权益和市场竞争秩序的法律法规。

3、隐私法:保护个人隐私权和个人信息安全的法律法规。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

实验六软件工程标准与文档一、实验目的了解软件工程软件标准化的概念、内容及其意义;了解与软件工程相关的国家标准;了解和熟悉软件工程国家标准GB/T 8567-2006;熟悉和掌握与软件工程相关文档的编写。

二、实验原理(一)软件工程标准软件危机的出路在于软件开发的工程化和标准化。

程序设计语言的标准化:为某一程序设计语言规定若干个标准子集,对于语言的实现者和用户都带来了很大方便。

软件过程的标准化:软件生存期各个阶段的工作建立标准或规范。

1、软件工程标准的类型国家标准GB/T 15538-1995《软件工程标准分类法》给出软件工程标准的分类。

涉及过程管理、产品管理、资源管理,以及确认与验证。

过程标准:方法、技术、度量产品标准:需求、设计、部件、描述、计划、报告专业标准:职别、道德准则、认证、特许、课程记法标准:术语、表示法、语言2、软件工程标准化的作用可提高软件的可靠性、可维护性和可移植性;可提高软件人员的技术水平,减少差错和误解;可提高软件人员之间的通信效率,提高软件的生产率;有利于软件管理;有利于降低软件产品的成本和运行维护成本;有利于缩短软件开发周期。

3、软件工程标准的层次(1) 国际标准:由国际联合机构制定和公布,提供各国参考的标准。

国际标准化组织ISO (International Standards Organization)这一国际机构有着广泛的代表性和权威性,它所公布的标准也有较大的影响。

ISO建立了“计算机与信息处理技术委员会”, 简称ISO/TC97,专门负责与计算机有关的标准化工作。

(2) 国家标准:由政府或国家级的机构制定或批准,适用于全国范围的标准,如:GB:中华人民共和国国家技术监督局公布实施的标准,简称“国标”。

现已批准了若干软件工程标准。

ANSI (American National Standards Institute):美国国家标准协会。

这是美国一些民间标准化组织的领导机构FIPS (NBS){Federal Information Processing Standards (National Bureau of Standards)}:美国商务部国家标准局联邦信息处理标准。

BS (British Standard):英国国家标准。

DIN (DeutschesInstitut für Nor- mung ):德国标准协会JIS (Japanese Industrial Standard) 日本工业标准(3) 行业标准:由行业机构、学术团体或国防机构制定,适用于某个业务领域的标准。

IEEE ( Institute of Electrical and Electronics Engineers ) :美国电气与电子工程师学会。

该学会有一个软件标准分技术委员会(SESS),负责软件标准化。

IEEE标准常冠有ANSI的字头。

例如,ANSI/IEEE Str 828-1983《软件配置管理计划标准》。

GJB:中国国家军用标准。

这是由中国国防科学技术工业委员会批准,适合于国防部门和军队使用的标准。

例如,GJB 437-88《军用软件开发规范》。

DOD_STD ( Department Of Defense _STanDards):美国国防部标准,适用于美国国防部门。

MIL_S ( MILitary_Standard):美国军用标准,适用于美军内部。

(4) 企业规范:一些大型企业或公司,由于软件工程工作的需要,制定适用于本部门的规范。

例如,美国IBM公司通用产品部1984年制定的《程序设计开发指南》,仅供该公司内部使用。

(5) 项目规范:由某一科研生产项目组织制定,为该项任务专用的软件工程规范。

4、中国的软件标准:从1983年起,中国已陆续制定和发布了20项国家标准。

这些标准可分为4类:①基础标准GB/T 11457-89 软件工程术语GB 1526-891(ISO 5807-1985)信息处理--数据流程图、程序流程图、系统结构图、程序网络图和系统资源图的文件编制符号及约定GB/T 15538-1995 软件工程标准分类法GB 13502-92(ISO 8631)信息处理--程序构造及其表示法的约定GB/T 15535-1995(ISO 5806)信息处理--单命中判定表规范GB/T 14085-93(ISO 8790)信息处理系统计算机系统配置图符号及其约定②开发标准GB 8566-88 软件开发规范GB 计算机软件单元测试GB 软件支持环境GB(ISO 6593-1985)信息处理--按记录组处理顺序文卷的程序流程GB/T 14079-93 软件维护指南③文档标准GB 8567-88 计算机软件产品开发文件编制指南GB 9385-88 计算机软件需求说明编制指南GB 9386-88 计算机软件测试文件编制规范GB 软件文档管理指南④管理标准GB/T 12505-90 计算机软件配置管理计划规范GB 信息技术软件产品评价--质量特性及其使用指南GB 12504-90 计算机软件质量保证计划规范GB/T 14394-93 计算机软件可靠性和可维护性管理GB/T 19000-3-94 质量管理和质量保证标准第三部分:在软件开发、供应和维护中的使用指南。

(二)、软件文档的作用与分类1、软件文档文档(document)是指某种数据媒体和其中所记录的数据。

文档它具有永久性,并可以由人或机器阅读,通常仅用于描述人工可读的东西。

在软件工程中,文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。

2、软件文档的作用提高软件开发过程的能见度。

把开发过程中发生的事件以某种可阅读的形式记录在文档中。

管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。

作用:提高开发效率。

软件文档的编制,使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、减少返工。

并且可在开发早期发现错误和不一致性,便于及时加以纠正。

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

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

提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间协作、交流和了解。

使软件开发活动更科学、更有成效。

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

从某种意义上文档是软件开发规范的体现和指南。

按规范要求生成一整套文档的过程,就是按照软件开发规范完成一个软件开发的过程。

3、文档的分类1)从形式分两类:开发过程中填写的各种图表(工作表格)编制的技术资料或技术管理资料(文档或文件)软件文档可以用自然语言,形式语言,半形式语言(结构化语言),各类图形表示、表格来编制文档。

2)按照文档产生和使用的范围,大致可分为三类:开发文档:软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划管理文档:项目开发计划、测试计划、测试报告开发进度月报、项目开发总结用户文档:用户手册、操作手册、维护修改建议4、常见软件文档国家标准局在1988年1月发布了《计算机软件开发规范》《软件产品开发文件编制指南》作为软件开发人员工作的准则和规程。

它们基于软件生存期方法,把软件产品从形成概念开始,经过开发、使用和不断增补修订,直到最后被淘汰的整个过程应提交的文档归于以下十三种。

1)可行性研究报告说明该软件项目的实现在技术上、经济上和社会因素上的可行性;评述为合理地达到开发目标可供选择的各种可能的实现方案;说明并论证所选定实施方案的理由。

2)项目开发计划:为软件项目实施方案制定出的具体计划。

它包括:各部分工作的负责人员、开发的进度、开发经费的概算、所需的硬件和软件资源等项目开发计划应提供给管理部门,并作为开发阶段评审的基础。

3)软件需求说明书:对目标软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。

4)数据要求说明书:给出数据逻辑描述和数据采集的各项要求, 为生成和维护系统的数据文件做好准备。

5)概要设计说明书:概要设计工作阶段的成果。

应当说明:系统的功能分配、模块划分、程序的总体结构、输入输出及接口设计、运行设计、数据结构设计、出错处理设计等,为详细设计奠定基础。

6)详细设计说明书:描述每一个模块是如何实现的,包括实现算法、逻辑流程等。

7)用户手册:详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。

8)操作手册:提供软件各种运行情况的有关知识,特别是操作方法细节。

9)测试计划:针对组装测试和确认测试,为组织测试制定计划。

有测试的内容、进度安排、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等10)测试分析报告:根据提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论性意见11)开发进度月报:软件人员按月向管理部门提交的项目进展情况的报告。

报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

12)项目开发总结报告:软件项目开发完成之后,应当与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力。

还需对开发工作作出评价,总结经验和教训。

13)维护修改建议:软件产品投入运行之后,可能有修正、更改等问题,应当对存在的问题、修改的考虑以及修改的影响估计等做详细的描述,写成维护修改建议,提交审批。

以上软件文档是在软件生存期中,随着各个阶段工作的开展适时编制的。

其中,有的仅反映某一个阶段的工作,有的则需跨越多个阶段。

文档最终要向软件管理部门,或向用户回答下列问题哪些需求要被满足(What);软件在什么环境中实现,所需信息从哪里来(Where);开发时间如何安排(When);开发(或维护)工作打算由谁来做(Who);需求应如何实现(How);为什么要进行这些软件开发或维护修改工作(Why)。

(三)文档编制的质量要求如果不重视文档编写工作,或是对文档编写工作的安排不当,就不可能得到高质量的文档。

1、质量差的文档使读者难于理解,给使用者造成许多不便会削弱对软件的管理(难以确认和评价开发工作的进展情况),提高软件成本(一些工作可能被迫返工)造成误操作2、高质量文档质量要求(1) 针对性文档编制以前应分清读者对象。

按不同的类型、不同层次的读者,决定怎样适应他们的需要。

管理文档面向管理人员,用户文档主要面向用户这两类文档尽量少使用专用术语。

(2) 精确性:文档的行文应当十分确切,不能出现多义性的描述。

同一课题几个文档的内容应当是协调一致,没有矛盾的。

相关文档
最新文档