软件产品开发文档编写指南.docx

《软件产品开发文档编写指南.docx》由会员分享，可在线阅读，更多相关《软件产品开发文档编写指南.docx（48页珍藏版）》请在课桌文档上搜索。

1、段e/晶邪鹿2陷编图:前-己8+三+e*+三*+,f+三*+f+，+*+n+三n+三*+三*+fH*三+i*三+e*,+e*3+i*三+i*s+e*,+e*3+三+n?&fc!O、技术仃性研报-口*借!未定乂书1、引言错误!未定义书签。1.1编写目的错误!未定义书签.1. 2项目背景错误!未定义书签。3定义错误!未定义书签。1.4参考资料错误!未定义书签。2、可行性研究的前提错误!未定义书签。21开发要求错误!未定义书签。1. 2开发目标错误!未定义书签。2. 3开发条件、假定和限制错误!未定义书签。2. 4可行性研究方法错误!未定义书签。2. 5决定可行性的主要因素错误!未定义书签。3、对现

2、有系统的分析错误!未定义书签。3. I处理流程和数据流程错误!未定义书签。4. 2工作负荷错误!未定义书签。5. 3费用支出错误!未定义书签。6. 4人员错误!未定义书签。7. 5设备错误!未定义书签。8. 6局限性错误!未定义书签。4、所建议技术可行性分析错误!未定义书签。9. 1对系统的简要描述错误!未定义书签。10. 2处理流程和数据流程错误!未定义书签。11. 3与现有系统比较的优越性错误!未定义书签。12. 4采用建议系统可能带来的影响错误!未定义书签。13. 5技术可行性评价，包括：错误!未定义书签。14. 其它口J供选择的方案.错误!未定义书签。15. 论/良、见.借未定乂书签、

3、项目开发I十划,.借!未定乂书签1. 1编写目111BEH+*“+1H定乂f5。2. 2项目景*i+i*i+sJt+nn+三n+三+i+三+nn*an*三+e*+e*iin*三n*n+e*+e*iin*n三I!未定乂签O3. 4参料借未定乂书签2、目概述n*i+ns+i*s+i*t+si+ns+i*s+i*t+si+ns+a+i*ia+三*3+e*a+e+3+i+s+三*3+e*n+e*ia+!定乂签O4. 2条件-限制,借!未定乂书签5. 31J宇+三*s+i*t+snCESI4参考料未定乂书签O2、彳土+1*l+,l+ll+,f+H*l+,l+,l+,f+H*l+,fH+l-+R*l+RH

4、I4-tH+R*l+-II。4 1目标-未定书餐Q5 .3求概述未定乂书O2. 4条件与限制3、总体设计3. 1处理流程.4. 2总体结构和模块外部设计.3. 3功能分配4、11.I.+*.+*.+*.+.*.+*.+*.+*.*.*.+*4. 1外部接口.+.5. 2内部接口*5、数据结构设计.+.I.+*.*-.*.+.51逻辑结构设计5. 2物理结构设计6. 3数据结构与程序的关系61运行模块的组合7. 2运行控制.7、出错处理设计.*8. 1出错输出信息9. 2出错处理对策8、安全保密设计10. 维护设计+*六、详细设计说明书*1 .弓I言1 .1编写目的12目2 3.1. 4参考资料

5、2. I需求概述+3. 2软件结构31目匕e+nn+1+三三+SJ+nn+三n+三+SJ+32目匕+3. 3输.入项目,+，*,+“*+，*,+，*,+3. 4输出项目一353. 6程序逻辑+*+,*+“*,+，*,+，*+3. 8存储分配+,3. 9限制条件4. 10测试要点1II-JI1目1l+,f+l,l+Hff+Hf+Hf+Hf+h.错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签。 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签.

6、 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未定义书签. .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未

7、定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。12目1. 4参考资料2.壬2. 2运行环境2. 3需求概述2. 4条件与限制3. 1测试方案4. 2测试项目5. 3测试准备3. 4测试机构及人员4、测试项目说明4. 1测试项目名称及测试内容.4. 2测试用例4. 3测试进度4. 4测试条件6. 5测试资料5、评价51lA+*r+4*r+4*+*r+4r+4r+*52八、测试分析报告1 .弓I言II目白J12I31. 4参考资料2 .测试计划执行情况2- 1测咸项目,2. 2测试机构和人员2. 3测试结果3. 4软件需求测试结论4. 1车欠彳牛

8、直匕3. 2缺陷和限制3. 4测试结论，“,1、报告时间及所作的开发阶段2. 1本月内的主要活动“3. 2实际进展与计划比较4、所用机时.错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签。 .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未定义书签. .错误!未定义书签. .错误!未定义书签. 错误!未定义书签. .错误!未

9、定义书签. .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。 .错误!未定义书签。5. 、Ml：lYL-Lll+,l+ll+l,l+ll+,l+ll+l,l+6、工作遇到的问题及采取的对策

10、.7、本月完成的成果8、下月的工作计划9、特殊问题十、项目开发总结报告1 .弓I言1. 1编写目的1.2项目背景I.4参考资料2.2.2.2.2.1产品3所用工时.4所用机时.5进度6费用3.1生产率评价.3.2技术方案评价.3.3产品质量评价.4、经验与教训十一、软件问题报告2、3、4、5、6、7.8、9、登记日期问题发现日期.LJ-I-ltl+ftl+ltl+ltl+4问题属于什么方面模块/子系统.修订版本号10、测试用例It、硬件-12,13.14.问题描述/影响问题症兆的详细描述。i+*+,+,+n+错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签。错误!未定义书

11、签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签.错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。前百为使读者具体了解怎样编写文档，这里

12、列出了11种文档的内容要求及其简要说明。这些文档包括：可行性研究报告、项目开发计划、需求规格说明书、概要设计说明书、详细设计说明书、测试计划、测试分析报告、开发进度月报、项目开发总结报告和软件问题报告。各文档内容大纲由带编号的标题构成，标题后文字为其说明。一、文档封二格式文档编号版本号文档名称：项目名称：项目负责人：编写年月_日校对年_月_S审核年月_日批准年_月日开发单位二、技术可行性研究报告1、引言1. 1编写目的阐明编写本可行性报告的目的，指出读者对象。2. 2项目背景A）所建议开发软件的名称；B）本项目的任务提出者、开发者、用户及实现软件的单位;C）本项目与其它系统的关系；1.3定义列

13、出本文档中用到的专门术语的定义和缩写词的原文。1. 4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括：A）本项目经核准的计划书、合同或上级机关的批文；B）与本项目有关的己发表的资料；C）本文档中所引用的资料，所采用的软件标准或规范；2、可行性研究的前提2. 1开发要求列出并说明建议开发软件的基本要求，如:A）功能:B）性能；C）输出；D）输入；E）基本的数据流程和处理流程；F）安全与保密要求；G）与本软件相关的其它系统；H）完成期限；2. 2开发目标可包括：J / / ABCDEF人力与设备费用的节省：处理速度的提高：控制精度或生产能力的提高；管理信息服务的改进：

14、决策系统的改进：人员工作效率的提高等等：2. 3开发条件、假定和限制可包括：A）建议开发软件运行的最短寿命；B）进行系统方案选择比较的期限；C）经费来源和使用限制；D）法律和政策方面的限制；E）硬件、软件、运行环境和开发环境的条件和限制;F）可利用的信息和资源；G）建议开发软件投入使用的最迟时间；2. 4可行性研究方法3. 5决定可行性的主要因素3、对现有系统的分析4. 1处理流程和数据流程5. 2工作负荷6. 3费用支出如人力、设备、空间、支持性服务、材料等项开支。7. 4人员列出所需人员的专业技术类别和数量。8. 5设备3.6局限性说明现有系统存在的问题以及为什么需要开发新的系统。4、所建

15、议技术可行性分析4. 1对系统的简要描述4. 2处理流程和数据流程4. 3与现有系统比较的优越性4. 4采用建议系统可能带来的影响ab)c)de)f)g对设备的影响；对现有软件的影响;对用户的影响；对系统运行的影响;对开发环境的影响;对运行环境的影响;对经费支出的影响;9. 5技术可行性评价，包括:ABCD在限制条件下，功能目标能否达到；利用现有技术，功能目标能否达到：对开发人员数量和质量的要求，并说明能否满足;在规定的期限内，开发能否完成；5、其它可供选择的方案逐个阐明其它可供选择的方案，并重点说明末被推荐的理由。6、结论意见A）结论意见可能是：B）可着手组织开发；C）需待若干条件（如资金、

16、人力、设备等）具备才能开发；D）需对开发目标进行某些修改；E）不能进行或不必进行（如技术不成熟，经济上不合算等）；F）其它；三、项目开发计划1、引言1.1 编写目的阐明编写本开发计划的目的，指出读者对象。1. 2项目背景可包括：A）本项目的委托单位、开发单位和主管部门；B）该软件系统与其它系统的关系；2. 3定义列出本文档中用到的专门术语的定义和缩写词的原文：1. 4参考资料可包括：A）本项目经核准的计划任务书、合同或上级机关的批文；B）本文档所引用的资料、规范等；列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源；2、项目概述3. 1工作内容简要说明本项目的各项主要工作，介绍所开发

17、软件的功能、性能等。若不编写可行性研究报告，则应在本节给出较详细的介绍。阐明为完成本项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承包者承担的工作、完成期限及其它条件与限制。2. 3产品3. 3.1程序列出应交付的程序名称、使用的语言及存储形式。4. 3.2文档列出应交付的文档。5. 4运行环境应包括硬件环境、软件环境。6. 5服务阐明开发单位可向用户提供的服务。如人员培训、安装、保修、维护和其它运行支持。2. 6验收标准3、实施计划3.1任务分解任务的划分及各项任务的负责人。3. 2进度按阶段完成的项目，用图表说明开始时间、完成时间。3. 3预算3. 4

18、关键问题说明可能影响项目的关键问题，如设备条件、技术难点或其它风险因素，并说明对策。4、人员组织及分工5、交付期限6、专题计划要点如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。四、需求规格说明书1、引言1. 1编写目的阐明编写本需求说明书的目的，指明读者对象。2. 2项目背景应包括：A）本项目的委托单位、开发单位和主管部门；B）该软件系统与其它系统的关系。3. 3定义列出本文档中所用到的专门术语的定义和缩写词的原文。1. 4参考资料可包括：A）本项目经核准的计划任务书、合同或上级机关的批文；B）项目开发计划；C）本文档所引用的资料、标准和规范。列出这些资料的作者、标题、

19、编号、发表日期、出版单位或资料来源；2、任务概述2. 1开发目标2. 2运行环境4. 3条件与限制3、数据描述3. 1静态数据3. 2动态数据包括输入数据和输出数据。3. 3数据库描述给出使用数据库的名称和类型。3. 4数据词典5. 5数据采集4、功能需求6. 1功能划分4. 2功能描述5、性能需求5. 1数据精确度5. 2时间特性如响应时间、更新处理时间、数据转换与传输时间、运行时间等。7. 3适应性在操作方式、运行环境、与其它软件的接口以及开发计划等发生变化时，应具有的适应能力。6、运行需求8. 1用户界面如屏幕格式、报表格式、菜单格式、输入输出时间等。9. 2硬件接口10. 3软件接口1

20、1. 4故障处理7、其它需求如可使用性、安全保密、可维护性、可移植性等。五、概要设计说明书1 .引言1. 1编写目的阐明编写本概要说明书的目的，指明读者对象。2. 2项目背景应包括：A）本项目的委托单位、开发单位和主管部门；B）该软件系统与其它系统的关系。1. 3定义列出本文档中所用到的专门术语的定义和缩写词的原文。2. 4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括：ab)c)de)w本项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册（初稿）；本文档所引用的资料、标准和规范。2、任务概述2.1 目标2.

21、2 运行环境2. 3需求概述3. 4条件与限制3、总体设计4. 1处理流程5. 2总体结构和模块外部设计6. 3功能分配表明各项功能与程序结构的关系。4、接口设计6.1 外部接口包括用户界面、软件接口与硬件接口。7. 2内部接口模块之间的接口。5、数据结构设计8. 1逻辑结构设计9. 2物理结构设计10. 3数据结构与程序的关系6、运行设计61运行模块的组合11. 2运行控制7、出错处理设计12. 1出错输出信息13. 2出错处理对策如设置后备、性能降级、恢复及再启动等。8、安全保密设计9、维护设计说明为方便维护工作的设施，如维护模块等。六、详细设计说明书1 .引言1. 1编写目的阐明编写本详

22、细说明书的目的，指明读者对象。1. 2项目背景应包括项目的来源和主管部门等。2. 3定义列出本文档中所用到的专门术语的定义和缩写词的原文。3. 4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括：A）本项目的计划任务书、合同或批文；B）项目开发计划；C）需求规格说明书；D）概要设计说明书；E）测试计划（初稿）；F）用户操作手册（初稿）；G）本文档中所引用的其它资料、软件开发标准或规范；2、总体设计4. 1需求概述5. 2软件结构如给出软件系统的结构图。3.程序描述逐个模块给出以下的说明:3. 1功能3. 2性能3. 3输入项目3. 4输出项目3. 5算法本模块所选用

23、的算法。3. 6程序逻辑详细描述本模块实现的算法，可采用:)/ l / ABCDE标准流程图：PDL语言：N-S图:PAD；判定表描述算法的图表。6. 7接口3.8存储分配3. 9限制条件4. 10测试要点给出测试本模块的主要测试要求。七、测试计划1.引言1. 1编写目的阐明编写本手册的目的并指明读者对象。2. 2项目背景说明项目来源、委托单位及主管部门。3. 3定义列出本测试计划中所用到的专门术语的定义和缩写词的原意。4. 4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括：A）本项目的计划任务书、合同或批文；B）项目开发计划；C）需求规格说明书；D）概要设计说明

24、书；E）详细设计说明书；F）用户操作手册；G）本测试计划中引用的其它资料、采用的软件开发标准或规范。5. 任务概述2. 1目标3. 2运行环境4. 3需求概述5. 4条件与限制6. 计划3. 1测试方案说明确定测试方法和选取测试用例的原则。4. 2测试项目列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。5. 3测试准备6. 4测试机构及人员测试机构名称、负责人和职责。4、测试项目说明按顺序逐个对测试项目作出说明:7. 1测试项目名称及测试内容4. 2测试用例A）输入，输入的数据和输入命令；B）输出预期的输出数据；C）步骤及操作；D）允许偏差，给出实测结果与预期结果之间允许偏差的范围

25、；5. 3测试进度6. 4测试条件给出本项测试对资源的特殊要求，如设备、软件、人员等。4. 5测试资料说明本项测试所需的资料。5、评价5. 1范围说明所完成的各项测试说明问题的范围及其局限性。7. 2准则说明评价测试结果的准则。八、测试分析报告1 .引言1.1 编写目的阐明编写本测试分析报告的目的并指明读者对象。1. 2项目背景说明项目的来源、委托单位及主管部门。2. 3定义列出本测试分析报告中所用到的专门术语的定义和缩写词的原意。1. 4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：A）本项目的计划任务书、合同或批文；B）项目开发计划；C）需求规格说明书；D）

26、概要设计说明书；E）详细设计说明书；F）用户操作手册；G）测试计划；H）本测试分析报告所引用的其它资料、采用的软件工程标准或软件工程规范。2.测试计划执行情况2. 1测试项目列出每一测试项目的名称、内容和目的。2. 2测试机构和人员给出测试机构名称、负责人和参与测试人员名单。2. 3测试结果按顺序给出每一测试项目的：A）实测结果数据；B）与预期结果数据的偏差；C）该项测试表明的事实；D）该项测试发现的问题。3. 4软件需求测试结论按顺序给出每一项需求测试的结论。包括：A）证实的软件能力；B）局限性（即本项需求未得到充分测试的情况及原因）。3.评价3. 1软件能力经过测试所表明的软件能力。3.

27、2缺陷和限制说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影响。3. 3建议提出为弥补上述缺陷的建议。4. 4测试结论说明能否通过。九、开发进度月报1、报告时间及所作的开发阶段2、工程进度2. 1本月内的主要活动3. 2实际进展与计划比较3、所用工时按不同层次人员分别计时。4、所用机时按所用计算机机型分别计时。5、经费支出分类列出本月经费支出项目，给出支出总额，并与计划比较。6、工作遇到的问题及采取的对策7、本月完成的成果8、下月的工作计划9、特殊问题十、项目开发总结报告1 .引言1.1 编写目的阐明编写本总结报告的目的并指明读者对象。1.2项目背景说明项目的来源、委托单位、开发单位

28、及主管部门。1.3定义列出本报告中用到的专门术语的定义和缩写词的原意。1.4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括：A）本项目经核准的计划任务书、合同或上级机关的批文；B）项目开发计划；C）需求规格说明书；D）概要设计说明书；E）详细设计说明书；F）用户操作手册；G）测试计划；H）测试分析报告；I）本报告引用的其它资料、采用的开发标准或开发规范。2.开发结果2.1产品可包括:A）列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；B）产品文档名称等。2.2主要功能及性能2.3所用工时按人员的不同层次分别计时。2.4所用机

29、时按所用计算机机型分别计时。2.5进度给出计划进度与实际进度的对比。2.6费用3、评价3.1生产率评价如平均每人每月生产的源程序行数、文档的字数。3.2技术方案评价3.3产品质量评价4、经验与教训卜一、软件问题报告1、登记号由软件配置管理部门为该报告规定一个唯一的、顺序的编号。2、登记日期软件配置管理部门登记该报告的日期。3、问题发现日期发现该问题的日期和时间。4、活动在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。5、状态在软件配置记录中维护的动态指示，状态表示有：A）正在夏查：“软件问题报告，以确定将采取什么行动；B）软件问题报告”已由指定的人进行处理；C）修改已完成，并

30、经过测试，正准备交给主程序库；D）主程序库已经更新，主程序库修改的重新测试尚未完成；E）作了重新测试，问题再现；F）作了重新测试，所作的修改无故障，软件问题报告”被关闭;G）留待以后关闭。6、报告人填写软件问题报告”人员的姓名、地址、电话。7、问题属于什么方面区分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。也可能是它们的某种组合。8、模块/子系统出现的模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。9、修订版本号出现问题的模块版本。10、测试用例发现错误时所使用测试用例的标识符。11v硬件发现错误时使用的计算机系统的标识。12、问题描述/影响13、问题症兆的详细描述。如果可能，则写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等的影响。14、附注记载补充信息。