软件工程实践文档撰写要点

《软件工程实践文档撰写要点》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、软件工程实践文档的撰写软件工程实践文档的撰写北航软件学院项目开发过程的基本文档集项目开发过程的基本文档集ß可行性分析报告ß测试分析报告ß项目开发计划ß开发进度月报ß软件需求说明书ß项目开发总结报告ß概要设计说明书ß软件维护手册ß详细设计说明书ß软件问题报告ß用户操作手册ß软件修改报告ß测试计划软件工程实践文档要求软件工程实践文档要求软件项目文档：过程跟踪总结文档：ß项目开发计划ß会议/讨论记录ß软件需求说明书ß个人总结ß软件设计说明书ß其它相关文档ß软件测试计划ß测试分析报告ß用户手册提提纲纲ß项目开发计划ß软件需求说明书ß软件设计说

2、明书一、项目开发计划一、项目开发计划¢项目开发计划的目的为软件项目实施方案制定出具体计划，项目开发计划应提供给管理部门，并作为开发阶段评审的参考。¢项目开发计划所必须的要素各部分工作的负责人员、开发的进度、开发经费的预算、所需硬件及软件资源。一、项目开发计划一、项目开发计划ß主要内容1.概述2.项目任务概要3.实施总计划【剪裁内容】¾支持条件：V系统软硬件支持、用户承担的工作、外单位提供的条件¾专题计划要点V分合同、人员培训，质量保证、系统安装…1.1.概概述述ß主要内容1.1编写目的1.2背景1.3参考资料1.4术语和缩写词1.1.

3、概概述述（续（续11））1.1编写目的编写本计划的目的是把在×××××项目的开发过程中对各项工作任务的负责人员、开发进度、经费预算、硬件和软件资源条件等问题所作的安排用文档的形式记载下来，以便根据本计划开展和检查项目开发工作，保证项目开发成功。1.1.概概述述（续（续22））[编写目的——例]编写本计划的目的是把在浏览器设计项目的开发过程中，对各项工作任务的负责人员、开发进度、经费预算、硬件和软件资源条件等问题所作的安排，用文档的形式记载下来，以便根据本计划开展和检查项目开发工作，确保项目开发的成功。1.1.概概述述1.2背景¾项目名

4、称：浏览器设计¾委托单位：北航软件学院¾开发单位(人员)：杜孝平¾项目提出的经过：[项目背景——例1]本项目是按照北航软件学院2003年3月10日发行的《专业实践手册（修订稿）》的要求，从《专业实践题目》中选出的一个要求由杜孝平独立承担的二级专业实践项目。[项目背景——例2]1.1.概概述述1.3参考资料¾项目来源：上级批文、计划任务书、合同¾本文档中引用到的规范和资料等列出这些规范和资料的作者、编号、标题、发表日期、出版单位或资料来源[参考资料——示例]【注意】（1）所参考的教科书不需列出（2）只列本文档中所实际引用的资料1.1.概

5、概述述1.4术语和缩写词¾列出本文档中用到的专门术语的定义和缩写词，缩写词要给出中文译名和英文全称[例]IE：InternetExplorer,浏览器[术语和缩写词——示例]一、项目开发计划一、项目开发计划ß主要内容1.概述2.项目任务概要3.实施总计划2.2.项目任务概要项目任务概要ß主要内容2.1工作内容2.2主要人员2.3产品2.4运行与开发环境2.5验收标准2.6项目完成的最后期限【剪裁内容】本计划的批准者和批准日期2.2.项目任务概要项目任务概要2.1工作内容¾简要说明在本项目的开发过程中须进行的各项主要工作和文档编制计划2

6、.2主要人员*¾简要说明参加本项目开发工作的主要人员，包括他们的姓名、工作时间、工作经验和技术水平2.2.项目任务概要项目任务概要2.3产品2.3.1程序向学院提交该项目编译后的程序及源程序代码2.3.2文档列出须向用户移交的文档清单，至少包含：项目开发计划、需求文档和设计文档2.3.3服务*2.3.4非移交的产品*2.2.项目任务概要项目任务概要2.4运行与开发环境¾软件运行环境¾软件开发环境2.5验收标准对于上述这些产品和服务，按照二级专业实践要求进行验收2.6项目完成的最后期限一、项目开发计划一、项目开发计划ß主要内容1.概述2

7、.项目任务概要3.实施总计划3.3.实施总计划实施总计划ß包含内容3.1进度计划3.2关键问题3.3预算3.3.实施总计划实施总计划3.1进度计划¾主要工作包括项目开发计划、软件需求分析、概要及详细设计说明、编码和测试等¾表示方式：时间表或甘特图(gantt/barchart)¾表示内容：需完成的任务、进度、顺序、起止时间以及完成的标志性事件时间表时间表甘特图甘特图3.1进度计划¢2001.11——2001.12调研，系统分析，提交系统软件分析说明书；¢2001.12——2002.1总体设计，提交系统软件概要设计说明书；¢2002.3

8、——2002.6详细设计，提交系统软件详细设计说明书和系统软件测试计划；¢2002.7——2002.8系统开发实现，开发系统第一版本；¢2002.9——2002.11组装测试，提交系统测试报告；¢2002.12预验收3.