《软件产品开发文档编写指南.doc》由会员分享，可在线阅读，更多相关《软件产品开发文档编写指南.doc（39页珍藏版）》请在三一办公上搜索。
1、附录A软件产品开发文档编写指南前言7一、文档封二格式8二、技术可行性研究报告91、引言911编写目的912 项目背景913定义914参考资料92、可行性研究的前提921开发要求922开发目标1023开发条件、假定和限制1024可行性研究方法1125决定可行性的主要因素113、对现有系统的分析1131处理流程和数据流程1132工作负荷1133费用支出1134人员1135设备1136局限性114、所建议技术可行性分析1241对系统的简要描述1242处理流程和数据流程1243与现有系统比较的优越性1244采用建议系统可能带来的影响1245技术可行性评价，包括：125、其它可供选择的方案126、结论意
2、见12三、项目开发计划141、引言1411编写目的1412项目背景1413定义1414参考资料142、项目概述1421工作内容1422条件与限制1523产品15231程序15232文档1524运行环境1525服务1526验收标准153、实施计划1531任务分解1532进度1633预算1634关键问题164、人员组织及分工165、交付期限166、专题计划要点16四、需求规格说明书171、引言1711编写目的1712项目背景1713定义1714参考资料172、任务概述1821开发目标1822运行环境1823条件与限制183、数据描述1831静态数据1832动态数据1833数据库描述1834数据词典
3、1935数据采集194、功能需求1941功能划分1942功能描述195、性能需求1951数据精确度1952时间特性1953适应性196、运行需求1961用户界面1962硬件接口2063软件接口2064故障处理207、其它需求20五、概要设计说明书211引言2111编写目的2112项目背景2113定义2114参考资料212、任务概述2221目标2222运行环境2223需求概述2224条件与限制223、总体设计2231处理流程2232总体结构和模块外部设计2233功能分配224、接口设计2241外部接口2242内部接口235、数据结构设计2351逻辑结构设计2352物理结构设计2353数据结构与程
4、序的关系236、运行设计2361运行模块的组合2362运行控制237、出错处理设计2371出错输出信息2372出错处理对策238、安全保密设计249、维护设计24六、详细设计说明书251引言2511编写目的2512项目背景2513定义2514参考资料252、总体设计2621需求概述2622软件结构2631功能2632性能2633输入项目2634输出项目2635算法2636程序逻辑2637接口2738存储分配2739限制条件27310测试要点27七、测试计划281引言2811编写目的2812项目背景2813定义2814参考资料282任务概述2921目标2922运行环境2923需求概述2924条件
5、与限制293计划2931测试方案2932测试项目2933测试准备2934测试机构及人员294、测试项目说明2941测试项目名称及测试内容3042测试用例3043测试进度3044测试条件3045测试资料305、评价3051范围3052准则30八、测试分析报告311引言3111编写目的3112项目背景3113定义3114参考资料312测试计划执行情况3221测试项目3222测试机构和人员3223测试结果3224软件需求测试结论323评价3231软件能力3232缺陷和限制3233建议3334测试结论33九、开发进度月报341、报告时间及所作的开发阶段342、工程进度3421本月内的主要活动3422实
6、际进展与计划比较343、所用工时344、所用机时345、经费支出346、工作遇到的问题及采取的对策357、本月完成的成果358、下月的工作计划359、特殊问题35十、项目开发总结报告361引言3611编写目的3612项目背景3613定义3614参考资料362开发结果3621产品3623所用工时3724所用机时3725进度3726费用373、评价3731生产率评价3732技术方案评价3733产品质量评价374、经验与教训37十一、软件问题报告381、登记号382、登记日期383、问题发现日期384、活动385、状态386、报告人387、问题属于什么方面388、模块/子系统399、修订版本号391
7、0、测试用例3911、硬件3912、问题描述/影响3913、问题症兆的详细描述。3914、附注39前言为使读者具体了解怎样编写文档，这里列出了11种文档的内容要求及其简要说明。这些文档包括：可行性研究报告、项目开发计划、需求规格说明书、概要设计说明书、详细设计说明书、测试计划、测试分析报告、开发进度月报、项目开发总结报告和软件问题报告。各文档内容大纲由带编号的标题构成，标题后文字为其说明。一、文档封二格式 文档编号 版 本 号 文档名称： 项目名称： 项目负责人： 编写 年 月 日校对 年 月 日审核 年 月 日批准 年 月 日 开发单位 二、技术可行性研究报告1、引言11编写目的阐明编写本可
8、行性报告的目的，指出读者对象。12 项目背景A) 所建议开发软件的名称；B) 本项目的任务提出者、 开发者、用户及实现软件的单位；C) 本项目与其它系统的关系；13定义列出本文档中用到的专门术语的定义和缩写词的原文。14参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A) 本项目经核准的计划书、合同或上级机关的批文；B) 与本项目有关的已发表的资料；C) 本文档中所引用的资料，所采用的软件标准或规范；2、可行性研究的前提21开发要求列出并说明建议开发软件的基本要求，如：A) 功能；B) 性能；C) 输出；D) 输入；E) 基本的数据流程和处理流程；F) 安全与保密
9、要求；G) 与本软件相关的其它系统；H) 完成期限；22开发目标可包括：A) 人力与设备费用的节省；B) 处理速度的提高；C) 控制精度或生产能力的提高；D) 管理信息服务的改进；E) 决策系统的改进；F) 人员工作效率的提高等等；23开发条件、假定和限制可包括：A) 建议开发软件运行的最短寿命；B) 进行系统方案选择比较的期限；C) 经费来源和使用限制；D) 法律和政策方面的限制；E) 硬件、软件、运行环境和开发环境的条件和限制；F) 可利用的信息和资源；G) 建议开发软件投入使用的最迟时间；24可行性研究方法25决定可行性的主要因素3、对现有系统的分析 31处理流程和数据流程 32工作负荷
10、 33费用支出如人力、设备、空间、支持性服务、材料等项开支。 34人员列出所需人员的专业技术类别和数量。 35设备 36局限性说明现有系统存在的问题以及为什么需要开发新的系统。4、所建议技术可行性分析41对系统的简要描述42处理流程和数据流程43与现有系统比较的优越性44采用建议系统可能带来的影响A) 对设备的影响；B) 对现有软件的影响；C) 对用户的影响；D) 对系统运行的影响；E) 对开发环境的影响；F) 对运行环境的影响；G) 对经费支出的影响；45技术可行性评价，包括：A) 在限制条件下，功能目标能否达到；B) 利用现有技术，功能目标能否达到；C) 对开发人员数量和质量的要求，并说明
11、能否满足；D) 在规定的期限内，开发能否完成；5、其它可供选择的方案逐个阐明其它可供选择的方案，并重点说明末被推荐的理由。6、结论意见A) 结论意见可能是：B) 可着手组织开发；C) 需待若干条件（如资金、人力、设备等）具备才能开发；D) 需对开发目标进行某些修改；E) 不能进行或不必进行（如技术不成熟，经济上不合算等）；F) 其它；三、项目开发计划1、引言11编写目的阐明编写本开发计划的目的，指出读者对象。 12项目背景可包括：A) 本项目的委托单位、开发单位和主管部门；B) 该软件系统与其它系统的关系； 13定义列出本文档中用到的专门术语的定义和缩写词的原文； 14参考资料可包括：A) 本
12、项目经核准的计划任务书、合同或上级机关的批文；B) 本文档所引用的资料、规范等；列出这些资料的作者、标题、编号、 发表日期、出版单位或资料来源；2、项目概述21工作内容简要说明本项目的各项主要工作，介绍所开发软件的功能、性能等。若不编写可行性研究报告，则应在本节给出较详细的介绍。22条件与限制阐明为完成本项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承包者承担的工作、完成期限及其它条件与限制。23产品231程序列出应交付的程序名称、使用的语言及存储形式。232文档列出应交付的文档。24运行环境应包括硬件环境、软件环境。25服务阐明开发单位可向用户提供的服务
13、。如人员培训、安装、保修、维护和其它运行支持。26验收标准3、实施计划31任务分解任务的划分及各项任务的负责人。32进度按阶段完成的项目，用图表说明开始时间、完成时间。33预算34关键问题说明可能影响项目的关键问题，如设备条件、技术难点或其它风险因素，并说明对策。4、人员组织及分工5、交付期限6、专题计划要点如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。四、需求规格说明书1、引言11编写目的阐明编写本需求说明书的目的，指明读者对象。12项目背景应包括：A) 本项目的委托单位、开发单位和主管部门；B) 该软件系统与其它系统的关系。13定义列出本文档中所用到的专门术语的定义
14、和缩写词的原文。14参考资料可包括：A) 本项目经核准的计划任务书、合同或上级机关的批文；B) 项目开发计划；C) 本文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源；2、任务概述21开发目标22运行环境23条件与限制3、数据描述31静态数据32动态数据包括输入数据和输出数据。33数据库描述给出使用数据库的名称和类型。34数据词典35数据采集4、功能需求41功能划分42功能描述5、性能需求51数据精确度52时间特性如响应时间、更新处理时间、数据转换与传输时间、运行时间等。53适应性在操作方式、运行环境、与其它软件的接口以及开发计划等发生变化时，应具有的
15、适应能力。6、运行需求61用户界面如屏幕格式、报表格式、菜单格式、输入输出时间等。62硬件接口63软件接口64故障处理7、其它需求如可使用性、安全保密、可维护性、可移植性等。五、概要设计说明书1引言11编写目的阐明编写本概要说明书的目的，指明读者对象。12项目背景应包括：A) 本项目的委托单位、开发单位和主管部门；B) 该软件系统与其它系统的关系。13定义列出本文档中所用到的专门术语的定义和缩写词的原文。14参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A) 本项目经核准的计划任务书、合同或上级机关的批文；B) 项目开发计划；C) 需求规格说明书；D) 测试计划
16、（初稿）；E) 用户操作手册（初稿）；F) 本文档所引用的资料、标准和规范。2、任务概述21目标22运行环境23需求概述24条件与限制3、总体设计31处理流程32总体结构和模块外部设计33功能分配表明各项功能与程序结构的关系。4、接口设计41外部接口包括用户界面、软件接口与硬件接口。42内部接口模块之间的接口。5、数据结构设计51逻辑结构设计52物理结构设计53数据结构与程序的关系6、运行设计61运行模块的组合62运行控制7、出错处理设计71出错输出信息72出错处理对策如设置后备、性能降级、恢复及再启动等。8、安全保密设计9、维护设计说明为方便维护工作的设施，如维护模块等。六、详细设计说明书1
17、引言11编写目的阐明编写本详细说明书的目的，指明读者对象。12项目背景应包括项目的来源和主管部门等。13定义列出本文档中所用到的专门术语的定义和缩写词的原文。14参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A) 本项目的计划任务书、合同或批文；B) 项目开发计划；C) 需求规格说明书；D) 概要设计说明书；E) 测试计划（初稿）；F) 用户操作手册（初稿）；G) 本文档中所引用的其它资料、软件开发标准或规范；2、总体设计 21需求概述 22软件结构如给出软件系统的结构图。3程序描述逐个模块给出以下的说明： 31功能 32性能 33输入项目 34输出项目 35算
18、法本模块所选用的算法。 36程序逻辑详细描述本模块实现的算法，可采用：A) 标准流程图；B) PDL语言；C) N-S图；D) PAD；E) 判定表描述算法的图表。 37接口 38存储分配 39限制条件 310测试要点给出测试本模块的主要测试要求。七、测试计划1引言11编写目的阐明编写本手册的目的并指明读者对象。12项目背景说明项目来源、委托单位及主管部门。13定义列出本测试计划中所用到的专门术语的定义和缩写词的原意。14参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A) 本项目的计划任务书、合同或批文；B) 项目开发计划；C) 需求规格说明书；D) 概要设计说
19、明书；E) 详细设计说明书；F) 用户操作手册；G) 本测试计划中引用的其它资料、采用的软件开发标准或规范。2任务概述 21目标 22运行环境 23需求概述 24条件与限制3计划 31测试方案说明确定测试方法和选取测试用例的原则。 32测试项目列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。 33测试准备 34测试机构及人员测试机构名称、负责人和职责。4、测试项目说明按顺序逐个对测试项目作出说明： 41测试项目名称及测试内容 42测试用例A) 输入，输入的数据和输入命令；B) 输出预期的输出数据；C) 步骤及操作；D) 允许偏差，给出实测结果与预期结果之间允许偏差的范围； 43测试
20、进度 44测试条件给出本项测试对资源的特殊要求，如设备、软件、人员等。 45测试资料说明本项测试所需的资料。5、评价 51范围说明所完成的各项测试说明问题的范围及其局限性。 52准则说明评价测试结果的准则。八、测试分析报告1引言11编写目的阐明编写本测试分析报告的目的并指明读者对象。12项目背景说明项目的来源、委托单位及主管部门。13定义列出本测试分析报告中所用到的专门术语的定义和缩写词的原意。 14参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A) 本项目的计划任务书、合同或批文；B) 项目开发计划；C) 需求规格说明书；D) 概要设计说明书；E) 详细设计说
21、明书；F) 用户操作手册；G) 测试计划；H) 本测试分析报告所引用的其它资料、采用的软件工程标准或软件工程规范。2测试计划执行情况 21测试项目列出每一测试项目的名称、内容和目的。 22测试机构和人员给出测试机构名称、负责人和参与测试人员名单。 23测试结果按顺序给出每一测试项目的：A) 实测结果数据；B) 与预期结果数据的偏差；C) 该项测试表明的事实；D) 该项测试发现的问题。 24软件需求测试结论按顺序给出每一项需求测试的结论。包括：A) 证实的软件能力；B) 局限性（即本项需求未得到充分测试的情况及原因）。3评价 31软件能力经过测试所表明的软件能力。 32缺陷和限制说明测试所揭露的
22、软件缺陷和不足，以及可能给软件运行带来的影响。 33建议 提出为弥补上述缺陷的建议。 34测试结论说明能否通过。九、开发进度月报1、报告时间及所作的开发阶段2、工程进度 21本月内的主要活动 22实际进展与计划比较3、所用工时按不同层次人员分别计时。4、所用机时按所用计算机机型分别计时。5、经费支出分类列出本月经费支出项目，给出支出总额，并与计划比较。6、工作遇到的问题及采取的对策7、本月完成的成果8、下月的工作计划9、特殊问题十、项目开发总结报告1引言11编写目的阐明编写本总结报告的目的并指明读者对象。12项目背景说明项目的来源、委托单位、开发单位及主管部门。13定义列出本报告中用到的专门术
23、语的定义和缩写词的原意。14参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A) 本项目经核准的计划任务书、合同或上级机关的批文；B) 项目开发计划；C) 需求规格说明书；D) 概要设计说明书；E) 详细设计说明书；F) 用户操作手册；G) 测试计划；H) 测试分析报告；I) 本报告引用的其它资料、采用的开发标准或开发规范。2开发结果 21产品可包括：A) 列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；B) 产品文档名称等。 22主要功能及性能 23所用工时按人员的不同层次分别计时。 24所用机时按所用计算机机型分别计时。
24、 25进度给出计划进度与实际进度的对比。 26费用3、评价 31生产率评价如平均每人每月生产的源程序行数、文档的字数。 32技术方案评价 33产品质量评价4、经验与教训十一、软件问题报告1、登记号由软件配置管理部门为该报告规定一个唯一的、顺序的编号。2、登记日期软件配置管理部门登记该报告的日期。3、问题发现日期发现该问题的日期和时间。4、活动在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。5、状态在软件配置记录中维护的动态指示，状态表示有：A) 正在复查：“软件问题报告”，以确定将采取什么行动；B) “软件问题报告”已由指定的人进行处理；C) 修改已完成，并经过测试，正准备交
25、给主程序厍；D) 主程序厍已经更新，主程序厍修改的重新测试尚未完成；E) 作了重新测试，问题再现；F) 作了重新测试，所作的修改无故障，“软件问题报告”被关闭；G) 留待以后关闭。6、报告人填写“软件问题报告”人员的姓名、地址、电话。7、问题属于什么方面区分是程序的问题，还是模块的问题，或是数据厍的问题，文件的问题。也可能是它们的某种组合。8、模块/子系统出现的模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。9、修订版本号出现问题的模块版本。10、测试用例发现错误时所使用测试用例的标识符。11、硬件发现错误时使用的计算机系统的标识。12、问题描述/影响13、问题症兆的详细描述。如果可能，则写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等的影响。14、附注记载补充信息。
