第三章 软件技术文档下

UESTC白金平技术报告编写第三章软件开发文档编写(下)1第三章软件开发文档编写1软件工程基础.2软件策划的文档编写3软件开发的文档编写4软件过程的文档管理。23.2软件策划的文档编写3.2.1软件策划的基本概念1)计划：组织为实现一定目标而科学地预测并确定未来地行动方案。2)软件策划：软件项目组织根据项目目标地规定，对项目实施工作进行地各项活动作出地周密安排。33.2软件策划的文档编写3.2.1软件策划的基本概念3)可行性研究报告可行性研究报告是从事一种经济活动（投资）之前，双方要从经济、技术、生产、供销直到社会各种环境、法律等各种因素进行具体调查、研究、分析，确定有利和不利的因素、项目是否可行，估计成功率大小、经济效益和社会效果程度，为决策者和主管机关审批的上报文件。43.2软件策划的文档编写3.2.1软件策划的基本概念如何进行软件策划？——回答五个问题：做什么、如何做、谁去做、何时做、花费多少？WhatHowWhoWhenHowmuch技术目标工作分解结构人员使用计划进度表费用预算4)软件策划的思考53.2软件策划的文档编写3.2.1软件策划的基本概念5)软件策划的过程软件策划的结果=可行性研究报告+市场需求报告63.2软件策划的文档编写3.2.2可行性研究报告1)对可行性研究报告的写作要求主要包括以下四个方面：A。设计方案。可行性研究报告的主要任务是对预先设计的方案进行论证，所以必须设计研究方案，才能明确研究对象。73.2软件策划的文档编写3.2.2可行性研究报告B。内容真实。可行性研究报告涉及的内容以及反映情况的数据，必须绝对真实可靠，不许有任何偏差及失误。可行性研究报告中所运用资料、数据，都要经过反复核实，以确保内容的真实性。83.2软件策划的文档编写3.2.2可行性研究报告C。预测准确。可行性研究是投资决策前的活动。它是在事件没有发生之前的研究，是对事物未来发展的情况、可能遇到的问题和结果的估计，具有预测性。因此，必须进行深入地调查研究，充分地占有资料，运用切合实际的预测方法，科学地预测未来前景。93.2软件策划的文档编写3.2.2可行性研究报告D。论证严密。论证性是可行性研究报告的一个显著特点。要使其有论证性，必须做到运用系统的分析方法，围绕影响项目的各种因素进行全面、系统的分析，既要作宏观的分析，又要作微观的分析。103.2软件策划的文档编写2)可行性研究报告基本构架第一章：项目总论；第二章：项目环境分析；第三章：行业投资分析；第四章：市场分析；第五章：企业竞争分析与项目规模选择；第六章：项目组织与实施；第七章：投资估算与资金筹措；第八章：项目经济可行性分析；第九章：风险分析及规避；第十章：结论与建议；第十一章：附件。113.2软件策划的文档编写3.2.2可行性研究报告3)软件系统可行性研究报告的格式可行性研究报告(GB8567——88)XXX公司技术可行性报告XXX公司市场需求报告123.3软件开发的文档编写3.3.1软件开发文档类型1)软件开发管理文档*2)软件研发过程文档3)软件测试文档4)软件用户文档*一般分成：软件研发文档（管理＋过程＋用户）软件测试文档13表1软件开发文档143.3软件开发的文档编写3.3.1软件开发文档类型1)软件研发文档在软件开发过程中，根据软件研制任务书、软件关键等级和软件规模等级的不同，有选择地产生下表中的26种文档，15No文档名称No文档名称1软件系统设计说明14软件详细设计说明（面向对象方法）2软件研制任务书15数据库设计说明3软件评测任务书16测试计划4软件开发计划17测试说明5软件质量保证计划18测试记录6软件配置管理计划19问题报告7软件需求规格说明（结构化方法）20测试报告8软件需求规格说明（面向对象方法）21版本说明9软件接口需求规格说明22计算机系统操作员手册10软件接口设计说明23软件用户手册11软件概要设计说明（结构化方法）24软件程序员手册12软件概要设计说明（面向对象方法）25固件保障手册13软件详细设计说明（结构化方法）26软件产品规格说明表1软件研发文档163.3软件开发的文档编写3.3.1软件开发文档类型2)软件测试文档在软件测试过程中，软件测试方根据软件测试任务书、软件关键等级和软件规模等级的不同，有选择地产生下表中的9种文档.17表2软件测试文档序号文档名称1评测项目管理计划2评测质量保证计划3评测配置管理计划4测试需求规格说明5测试计划6测试说明7测试记录8问题报告9测试报告183.3软件开发的文档编写3.3.2软件研发文档的编写规范1)软件开发计划193.3软件开发的文档编写3.3.2软件开发文档的编写指南1)软件开发计划201)软件开发计划211)软件开发计划221)软件开发计划231）软件开发计划241）软件开发计划253.3软件开发的文档编写3.3.2软件研发文档的编写规范2)软件系统设计说明262)软件系统设计说明272)软件系统设计说明282)软件系统设计说明292)软件系统设计说明302)软件系统设计说明312)软件系统设计说明322)软件系统设计说明333.3软件开发的文档编写3.3.2软件研发文档的编写规范3)软件研制任务书343)软件研制任务书353)软件研制任务书363)软件研制任务书373)软件研制任务书383)软件研制任务书393)软件研制任务书403.3软件开发的文档编写3.3.2软件研发文档的编写规范4)软件测试任务书414)软件测试任务书424)软件测试任务书434)软件测试任务书444)软件测试任务书454)软件测试任务书463.3软件开发的文档编写3.3.2软件研发文档的编写规范5)软件质量保证计划475)软件质量保证计划485)软件质量保证计划495)软件质量保证计划505)软件质量保证计划515)软件质量保证计划525)软件质量保证计划533.3软件开发的文档编写3.3.2软件研发文档的编写规范6)软件配置管理计划546)软件配置管理计划556)软件配置管理计划566)软件配置管理计划576)软件配置管理计划586)软件配置管理计划596)软件配置管理计划603.3软件开发的文档编写3.3.2软件研发文档的编写规范7)软件需求规格说明（结构化方法）617)软件需求规格说明（结构)627)软件需求规格说明（结构)637)软件需求规格说明（结构)647)软件需求规格说明（结构)657)软件需求规格说明（结构)667)软件需求规格说明（结构)677)软件需求规格说明（结构)687)软件需求规格说明（结构)697)软件需求规格说明（结构)707)软件需求规格说明（结构)717)软件需求规格说明（结构)723.3软件开发的文档编写3.3.2软件研发文档的编写规范8)软件接口需求规格说明738)软件接口需求规格说明748)软件接口需求规格说明HardWareConfigurationItem硬件配置项758)软件接口需求规格说明768)软件接口需求规格说明773.3软件开发的文档编写3.3.2软件研发文档的编写规范9)软件接口设计说明789)软件接口设计说明799)软件接口设计说明809)软件接口设计说明819)软件接口设计说明829)软件接口设计说明833.3软件开发的文档编写3.3.2软件研发文档的编写规范10)软件概要设计说明（结构）8410)软件概要设计说明（结构）8510)软件概要设计说明（结构）8610)软件概要设计说明（结构）8710)软件概要设计说明（结构）8810)软件概要设计说明（结构）8910)软件概要设计说明（结构）9010)软件概要设计说明（结构）9110)软件概要设计说明（结构）929)软件接口设计说明9310)软件概要设计说明（结构）9410)软件概要设计说明（结构）9510)软件概要设计说明（结构）963.3软件开发的文档编写3.3.2软件研发文档的编写规范11)软件详细设计说明（结构化方法）9711)软件详细设计说明（结构)9811)软件详细设计说明（结构)9911)软件详细设计说明（结构)mccabe方法是一种软件质量度量方法,它是基于对程序拓扑结构复杂度的分析。10011)软件详细设计说明（结构)1013.3软件开发的文档编写3.3.2软件研发文档的编写规范12)数据库设计说明10212)数据库设计说明10312)数据库设计说明10412)数据库设计说明10512)数据库设计说明10612)数据库设计说明10712)数据库设计说明10812)数据库设计说明10912)数据库设计说明1103.3软件开发的文档编写3.3.2软件研发文档的编写规范13)计算机系统操作员手册11113)计算机系统操作员手册11213)计算机系统操作员手册11313)计算机系统操作员手册11413)计算机系统操作员手册11513)计算机系统操作员手册116休息一下1173.3软件开发的文档编写3.3.3软件测试文档的编写规范1)评测项目管理计划1181)评测项目管理计划1191)评测项目管理计划1201)评测项目管理计划1211)评测项目管理计划1221)评测项目管理计划1231)评测项目管理计划1243.3软件开发的文档编写3.3.3软件测试文档的编写规范2)评测配置管理计划1252)评测配置管理计划1262)评测配置管理计划1272)评测配置管理计划1282)评测配置管理计划1292)评测配置管理计划1302)评测配置管理计划1312)评测配置管理计划1323.3软件开发的文档编写3.3.3软件测试文档的编写规范3)测试需求规格说明1333)测试需求规格说明1343)测试需求规格说明1353)测试需求规格说明1363)测试需求规格说明1373)测试需求规格说明1383.3软件开发的文档编写3.3.3软件测试文档的编写规范4)测试报告1394)测试报告1404)测试报告1414)测试报告1424)测试报告1434)测试报告1444)测试报告1454)测试报告1463.3软件开发的文档编写3.3.3软件测试文档的编写规范5)问题报告1475)问题报告1485)问题报告1495)问题报告1505)问题报告1515)问题报告1523.4软件开发的文档管理3.4.1软件开发过程的文档管理GB/T8567～2006《计算机软件文档编制规范》、GB/T9386-2008《计算机软件测试文件编制规范》。GB/T11457—2006《信息技术软件工程术语》、GB/T16680—1996《软件文档管理指南》153可行性报告项目开发计划对应大规模软件所规定的文件可进一步细分软件需求说明数据要求说明测试计划项目开发计划软件需求说明测试计划软件需求与开发计划概要设计说明详细设计说明数据库设计说明软件设计说明软件设计说明使用说明使用说明用户手册操作手册模块开发卷宗测试分析报告测试分析报告模块开发卷宗测试分析报告开发进度月报项目开发总结开发进度月报项目开发总结项目开发总结小规模软件中规模软件大规模软件超大规模软件软件开发的文档选择1543.4软件开发的文档管理3.4.1软件开发过程的文档管理GB/T8567～2006《计算机软件文档编制规范》、GB/T9386-2008《计算机软件测试文件编制规范》。GB/T11457—2006《信息技术软件工程术语》、GB/T16680—1996《软件文档管理指南》155作业2156本章结束！157