计算机软件开发文档编写指南

《计算机软件开发文档编写指南》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、计算机软件开发文档编写指南一、项目开发计划1．引言11.1编写目的11.2项目背景11.3定义21.4参考资料22．项目概述22.1工作内容22.2条件与限制22.3产品22.4运行环境22.5服务32.6验收标准33．实施计划33.1任务分解33.2进度33.3预算33.4关键问题34．人员组织及分工35．交付期限36．专题计划要点31．引言1.1编写目的【阐明编写开发计划的目的，指明读者对象。】1.2项目背景【可包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。】计算机软件开发文档编写指南1.3定义【列出本档中用到的专门术语的定义和缩写词的原文。

2、】1.4参考资料【可包括：a.项目经核准的计划任务书、合同或上级机关的批文；b.文档所引用的资料、规范等；列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。】2．项目概述2.1工作内容【简要说明项目的各项主要工作，介绍所开发软件的功能、性能等。若不编写可行性研究报告，则应在本节给出较详细的介绍。】2.2条件与限制【阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制。】2.3产品2.3.1程序【列出应交付的程序名称、使用的语言及存储形式。】2.3.2文档【列出应交付的文档。】2.4运

3、行环境【应包括硬件环境、软件环境。】计算机软件开发文档编写指南2.5服务【阐明开发单位可向用户提供的服务。如人员培训、安装、保修、维护和其他运行支持。】2.6验收标准3．实施计划3.1任务分解【任务的划分及各项任务的负责人。】3.2进度【按阶段完成的项目，用图表说明开始时间、完成时间。】3.3预算3.4关键问题【说明可能影响项目的关键问题，如设备条件、技术焦点或其他风险因素，并说明对策。】4．人员组织及分工5．交付期限6．专题计划要点【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。】计算机软件开发文档编写指南二、需求规格说明书1．引言11.1编写目的11

4、.2项目背景21.3定义21.4参考资料22．任务概述22.1目标22.2运行环境22.3条件与限制23．数据描述33.1静态数据33.2动态数据33.3数据库介绍33.4数据词典33.5数据采集34．功能需求34.1功能划分34.2功能描述35．性能需求35.1数据精确度35.2时间特性35.3适应性36．运行需求36.1用户界面36.2硬件接口36.3软件接口36.4故障处理37．其它需求31．引言1.1编写目的【阐明编写需求说明书的目的，指明读者对象。】为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写本文档。计算机软件开发文档编写指南本文档供项目经理、设计人员

5、、开发人员参考。1.2项目背景a.项目的委托单位、开发单位和主管部门b.该软件系统与其他1.3定义【列出文当中所用到的专门术语的定义和缩写词的原文。】1.4参考资料a.项目经核准的计划任务书、合同或上级机关的批文b.项目开发计划c.文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源2．任务概述2.1目标2.2运行环境操作系统：MicrosoftWindows2000AdvancedServer支持环境：IIS5.0数据库：MicrosoftSQLServer20002.3条件与限制计算机软件开发文档编写指南3．数据描述3.1静态数据3.2

6、动态数据【包括输入数据和输出数据。】3.3数据库介绍【给出使用数据库的名称和类型。】3.4数据词典3.5数据采集4．功能需求4.1功能划分4.2功能描述5．性能需求5.1数据精确度5.2时间特性【如响应时间、更新处理时间、数据转换与传输时间、运行时间等。】计算机软件开发文档编写指南5.3适应性【在操作方式、运行环境、与其它软件的接口以及开发计划等发生变化时，应具有的适应能力。】6．运行需求6.1用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等。】6.2硬件接口6.3软件接口6.4故障处理7．其它需求【如可使用性、安全保密、可维护性、可移植性等。】三、概要设计说明书1．引

7、言21.1编写目的21.2项目背景21.3定义21.4参考资料22．任务概述32.1目标32.2运行环境32.3需求概述32.4条件与限制33．总体设计33.1处理流程3计算机软件开发文档编写指南3.2总体结构和模块外部设计33.3功能分配34．接口设计34.1外部接口34.2内部接口35．数据结构设计35.1逻辑结构设计35.2物理结构设计35.3数据结构与程序的关系36．运行设计36.1运行模块的组合36.2运行控制36.3运行时间37．出错处理设计37.1出错输出信息37.2出错处理对