软件开发的文档规范

《软件开发的文档规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、附2:软件文档编写向导文档分类项目包括如下几类文档：项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。产品文档。包括：《用户操作手册》《演示文件》。软件项目计划（SoftwareProjectPlan） 一．引言1．编写目的（阐明编写软件计划的目的，指出读者对象。）2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）3．定义（列出本

2、文档中用到的专门术语的定义和缩略词的原文。）4．参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述1.   工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等.若不编写可行性研究报告,则应在本节给出较详细的介绍。)2.   条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件.必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。）3.   产品  （1）程序（列出应交付的程序名称使用的语言及存

3、储形式。）    （2）文档（列出应交付的文档。）    （3）运行环境（应包括硬件环境软件环境。）4．服务（阐明开发单位可向用户提供的服务.如人员培训安装保修维护和其他运行支持。）5．验收标准三．实施计划1．任务分解（任务的划分及各项任务的负责人。）2．进度（按阶段完成的项目,用图表说明开始时间完成时间。）3．预算4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）四．人员组织及分工五．交付期限六．专题计划要点（如测试计划等。）项目开发进度报告 一．报告时间及所处的开发阶

4、段二．给出进度1． 本周的主要活动2． 实际进展与计划比较三．所用工时（按不同层次人员分别计时。）四．所有机时五．工作遇到的问题及采取的对策六．本周完成的成果七．下周的工作计划八．特殊问题项目开发总结报告 一．引言1．编写目的（阐明编写总结报告的目的,指明读者对象。）2．项目背景（说明项目的来源、委托单位、开发单位及主管部门。）3．定义（列出报告中用到的专门术语定义和缩写词的原意。）4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发计划；（2）需求规格说明书；（3

5、）概要设计说明书；（4）详细设计说明书；（5）用户操作手册；（6）测试计划；（7）测试分析报告（8）本报告引用的其他资料、采用的开发标准或开发规范。）二．开发结果1． 产品（可包括：（1）列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。）2． 主要功能及性能3． 所用工时（按人员的不同层次分别计时。）4． 所用机时5． 进度（给出计划进度与实际进度的对比。）三．评价1．生产率评价（如平均每人每周源程序行数、文档的字数等。）2．技术方案评价3．产品质量评价四

6、．经验与教训 需求规格说明书（RequirementsSpecification） 一．引言1． 编写目的（阐明编写需求说明书的目的,指明读者对象。）2． 项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3． 定义（列出文档中用到的专门术语定义和缩写词的原文。）4． 参考资料（可包括：（1）项目开发计划；（2）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．任务概述1．目标2．运行环境3．条件与限制三．数据描述1．

7、 静态数据2． 动态数据（包括输入数据和输出数据。）3． 数据库描述（给出使用数据库的名称和类型。）4． 数据词典5． 数据采集四．功能需求1．功能划分2．功能描述五．性能需求1．数据精确度2．时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）3．适应性（在操作方式运行环境与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。）六．运行需求1．用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）2．硬件接口3．软件接口4．故障处理七．其他需求（如可使用性、安全保密、可维护性、可

8、移植性等。）概要设计说明书（ArchitecturalDesignSpecification） 一．引言1．编写目的（阐明编写概要设计说明书的目的，指明读者对象。）2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3．定义（列出文档中用到的专门术语定义和缩写词的原意。）4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资