




版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
1、在软件行业有一句话:一个软件能否顺利的完成并且功能是否完善,重要是看 这个软件有多少文档,软件开发文档是一个软件的支柱,如果你的开发文档漏 洞百出,那么你所开发出来的软件也不可能会好;开发文档的好坏可以直接影 响到所开发岀来软件的成功与否。一、软件开发设计文档:软件开发文档包括软件需求说明书、数据要求说有 书、概要设计说明书、详细设计说明书。1、软件需求说明书:也称为软件规格说明。该说明书对所开发软件的功能、 性能、用户 界面及运行环境等做岀详细的说明。它是用户与开发人员双方对 软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。软件 需求说明书的编制目的的就是 为了使用户和软件开发
2、者双方对该软件的初始 规定有一个共同的理解、并使之面成为整个开发工作的基础。其格式要求如下:1引言1. 1编写目的。1. 2背景1. 3定义2任务概述2. 1冃标2. 2用户的特点2. 3假定和约束3需求规定3. 1对功能的规定3. 2对性能的规定3. 2. 1 m3. 2. 2时间特性的需求3. 2. 3灵活性3. 33. 43. 53. 6输入输出要求数据管理能力要求故障处理要求 其他专门要求4运行环境规定4. 1设备4. 2支持软件4. 3 接口4. 4控制2、概要设计说明书:又称系统设计说明书,这里所说的系统是指程序系统。编 制的目的是说明对程序系统的设计考虑,包括程序系统的基本处理。
3、流程、程 序系统的组织 结构、模块划分、功能分配、接口设计。运河行设计、数据结 构设计和岀错处理设计等,为程序的详细设计提供基础。其格式要求如下:编写目的 背景 定义参考资料1引言1. 11. 21. 32总体设计2. 12. 22、32. 42. 52. 62. 71. 4需求规定运行环境基本设计概念和处理流程 结构功能需求与程序的关系 人工处理过程尚未解决的问题3接口设计3. 1用户接口3. 2外部接口3, 3内部接口4运行设计4. 1运行模块的组合42运行控制4. 3运行时间5系统数据结构设计5. 1逻辑结构设计要点5. 2物理结构设计要求5. 3数据结构与程序的关系 6系统岀错处理设计
4、6. 1出错信息6. 2补救措施6. 3系统维护设计。3. 详细设计文档:主要是把我们每个小模块,小功能的业务逻辑处理用文字的 方式表达岀来,让程序员在编码的时候有一个依据和参照;同时,在进行详细 文档设计的时候,有的软件公司也会根据不同的项目作岀相应的软件开发代 码规范性文档,以保障我们所做工作的统一性。如果一个软件系比较简单, 层次很少,本文件可以不单独编写,有关内容合并入概要设计说明书。 其格式要求如下:的目写景义考 编背定参 亠吕12 3 42程庠设计系统的结构3程序1设计说明3.1程序描述3.2功能3.3性能3.4输入项3.5输出项3.6算法3.7流程逻辑3.8接口3.9存储分配3.
5、10注释设计3.11限制条件3.12测试计划3.13尚未解决的问题4程序2设计说明.二、软件开发管理文档:可行性研究报告、项目开发计划、开发进度月报、项 目开发总结、模块开发卷宗。1可行性研究报告:编写目的是,说明该软件开发项目的实现在技术、经济和 社会条件方面的可行性:评述为了合理达到开发目标而可能选择的各种方案; 说明并论证所选定的方案。其格式要求如下:1引言12 3 4写景义考 编背定参2可行性研究的前提2.1要求2.2目标2.3条件、假定和限制2.4进行可行性研究的方法2.5评价尺度3对现有系统的分析3.1处理流程和数据流程3.2工作负荷3.3费用开支3.4人员3.5设备w限性3. 6
6、4所建议的系统对所建议系统的说明 处理流程和数据流程 改进之处影响4. 14. 24. 34. 44.4. 1结设备的影响4.4. 2对软件的影响4.4. 3对用户单位机构的影响4.4. 4对系统运行过程的影响4.4. 5对开发的影响4.4. 6对地点和设备的影响4.4. 7对经费开支的影响4. 5W限性4. 6技术条件方而的可行性 5可选择的其他系统的可行性5. 1可选择的系统方案15. 2可选择的系统方案26投资及效益分析6. 1支出6. 1. 1基本建设投资6. 1. 2其他一次性支出6. 1. 3非一次性支出6. 2收益6. 2. 1 一次性收益6. 2. 2非一次性收益6. 2. 3
7、不可定量的收益6. 3收益投资比6. 4投资回收周期6. 5敬感性分析7社会因素方面的可行性7. 1法律方面的可行性7. 2使用方面的可行性8结论2. 项目开发计划:是为软件项目实施方案制定岀的具体计划。项目开发计划应 提前给管理部门,并作为开发阶段评审的基础。编制项目开发计划的止的是用 文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费 预算、所需的软硬条件等问题做出的安排记载下来,以便根据本计划开展和检 查项目的开发工作。其格式要求如下:1引言1. 1编写目的1. 2定义1. 3参考资料2项目概述2. 1工作内容2. 2主要参加人员2. 3产品程序方件服务非移交的产品2.
8、 3. 12. 3. 22. 3. 32. 3. 42. 4验收标准2. 5完成项目的最迟期限工作任务的分配与人员分工 接口人员进度预算关键问题2. 6本计划的批准者和批准n期 3实施计划3. 13. 23. 33. 43. 5 4支持条件4. 1计算机系统支持4. 2需收用户承担的工作4. 3由外单位提供的条件5专题计划要点3. 开发进度月报:开发进度月报的编制目的是及时向有关部门汇报项目开发的 进度和情况,以便及时 发现和处理开发过程中岀现的问题,一般开发进度月 报是以项目组单位每月编写的。如果被开发的软件系统规模比较大,整个工程 项目被划分给若干个分项目辑承担,开发进度月报将以分项目为单
9、位搂月编 写。其格式要求如下:1标题2工程进度与状态2. 1进度2. 2状态3资源耗用与状态3. 1资源耗用3. 1. 1工时3. 1. 3机时3. 2状态4经费支出与状态4. 1经费支出4. 1. 1支持性费用4. 1. 2设备购置费4. 2状态5下一个月的工作计划6建议4项目开发总结:软件项目开发完成之后,应当与项目实施计划对照,总结实 际执行的情况,如进度、 成果、资源利用、成本和投入的人力。此外,还需 对开发工作做岀评价,总结经验和教训。项目开发总结报告的编制是为了总结 本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个 方面的评价。其格式要求如下:1引言编写目的 背
10、景 定义12实际开以结果22222参考资料产品2345主要功能和性能 基本流程进度费用对生产效率的评价 对产品质最的评价 对技术方法的评价 出错原因的分析3开发工作评价33331234 4经验与教训5模块开发卷宗:模块开发卷宗是在模块开发过程中逐步编写出来的,每完成 一个模块或一组密切相关的模块的复制进编写一份,应该把所有的模块开发卷 宗汇集在一起。编写的目的是记录和汇意低层次开发的进度和结果,经便于对 整个模块开发工作的管理和复审,并为将来的维护提供非常有用的技术信息。1标题2模块开发情况表:其中模块开发情况表的格式如下表:横块标识符模块的描述性名称代码设计(计划开始日期实际开始日期)模块测
11、试(计划开始日期 实际开始日期组装测试(计划开始日期 实际开始日期)代码复杳(日期/签字)源代码行数 预计/实际目际模块大小(预计实际)项目负责人批准(日期/签字)34567功能说明 设计说明 源代码清单测试说明 复市的结论三、软件开发测试文档:概要测试计划、详细测试计划、测试实施计划、测试 分析报告。1概要测试计划:是软件项目实施计划中的一项重要的内容,应当在软件开发 初期、即需求分析阶段制订。项计划应当定义被测试对象和测试目标,确定测 试阶段和测试周期的划分;制订测试人员、软硬件资源和测试进度等方面的 计划,规定软件测试方法,测试标准以及支持坏境和测试工具。2. 详细测试计划:是针对子系统
12、在特定的测试阶段所要进行的测试工作制订详 细计划,它详细说明规定了测试小组的各项测试任务,测试策略、任务分配和 进度安排等。3. 测试实施计划:测试人员的测试实施计划是根据详细计划制订的测试者的测 试具体实施计划。它规定了测试者在每一轮测试中负责测试的内容,测试强度 和工作进度等。测试实施计划是整个软件测试的组成部分,是检查测试实际执 行情况的重要依据。其格式要求如下:1引言1. 1编写目的背景定义参考资料1. 21. 31. 42计划2. 1软件说明2. 2测试内容2. 3测试2. 3. 12. 3. 22. 3. 32. 3. 42. 4测试3测试设计说明3. 1测试3. 1. 1控制进度
13、安排 条件测试资料 测试培训3. 1. 2输入3. 1. 3输出3. 1. 4过程3. 2测试4评价准则4. 1范围4. 2数据整理4. 3尺度 4测试分析报告:测试工作完成以后,应当提交测试计划情况说明书,对测试 结果加以分析,并提出测试的结论性意见。其格式要求如下:编写目的背景 定义参考资料1引言1. 21. 31. 42测试概要3测试结果及发现3. 1测试13. 2测试24对软件功能的结论4. 1功能14. 1. 1能力4. 1. 2限制4. 2功能25分析摘要能力缺陷和限制建议评价5. 15. 25. 35. 4 6测试资源消耗四、用户文档:用户手册、操作手册。1用户手册:用户手册的编
14、制是要使用非专门术语的语言,充分地描述该软件 系统所具有的功能及基本的使用方法,使用户(或潜在用户)通过本手册能够 了解该软件的用途,并且能够确定在什么情况下,如何使用它。其格式要求如下:编写目的 背景 定义参考资料1引言1. 11. 21. 31. 42用途2. 1功能2. 2性能221箱度2. 2. 2时间特性2. 2. 3灵活性2. 3安全保密3运行环境3. 1硬设备3. 2支持软件3. 3数据结构4使用过程4. 1安装与初始化4. 2输入4. 2. 1输入数据的现实背景4. 2. 2输入格式4. 2. 3输入举例4. 3输出4. 3. 1输出数据的现实背景4. 3. 2输出格式4. 3
15、. 3输出举例4. 4文卷査询4. 5出错处理和恢复4. 6终端操作2. 操作手册:操作手册的编制是为了向操作人员提供该软件每一个运行的具体 过程和有关知识,包括操作方法的细节。其格式要求如下:编写目的背景 定义参考资料1引言1. 11. 21. 31. 4 2软件征述2. 1软件的结构2. 2程序表2. 3文卷表 3安装与初始化 4运行说明4. 1运行表4. 2运行步骤4. 3运行1运行控制 操作控制 输入输出文卷输出文段 输岀文段的S制 恢复过程4. 3. 14. 3. 24. 3. 34. 3. 44. 3. 54 3. 64. 4运行2 5非常规过程 6远程操作3. 维护建议:软件产品投入运行之后,可能有修改、更正等问题。应当对存在 的问题、修改的考虑以及修改的影响估
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 车展端午节活动策划方案
- 管工进场考试题及答案
- 歌剧赏析考试题及答案
- 高考试题及答案物理
- 技术转移成效见证承诺书(3篇)
- 员工绩效考核评估报告标准化模板
- 费县中考试题及答案
- 班主任老师演讲稿:感恩的心(8篇)
- 环保话题的讨论与思考议文周记7篇
- (正式版)DB15∕T 3404.4-2024 《全民所有自然资源资产清查技术指南 第4部分:草原资源》
- 仓库货物运送管理制度
- 《思想道德与法治》课件-第一节 人生观是对人生的总的看法
- 颈深间隙感染诊疗与管理
- 安徽科技馆笔试题目及答案
- 厂房分割租赁协议书
- 会计中级职称《财务管理》电子书
- 无人机教员聘用协议书
- 足球教练员的职业素养与道德规范
- 产地证培训讲义
- 《南京理工大学化工》课件
- 养殖场远程视频监控解决方案
评论
0/150
提交评论