计算机软件开发文档编写指南.docx
- 文档编号:4606524
- 上传时间:2022-12-07
- 格式:DOCX
- 页数:55
- 大小:31.15KB
计算机软件开发文档编写指南.docx
《计算机软件开发文档编写指南.docx》由会员分享,可在线阅读,更多相关《计算机软件开发文档编写指南.docx(55页珍藏版)》请在冰豆网上搜索。
计算机软件开发文档编写指南
计算机软件开发文档编写指南
一、项目开发计划
1.引言.............................................................................................................................................1
1.1 编写目的.............................................................................................................................1
1.2 项目背景.............................................................................................................................1
1.3 定义.....................................................................................................................................2
1.4 参考资料.............................................................................................................................2
2.项目概述.....................................................................................................................................2
2.1 工作内容.............................................................................................................................2
2.2 条件与限制.........................................................................................................................2
2.3 产品.....................................................................................................................................2
2.4 运行环境.............................................................................................................................2
2.5 服务.....................................................................................................................................3
2.6 验收标准.............................................................................................................................3
3.实施计划.....................................................................................................................................3
3.1 任务分解.............................................................................................................................3
3.2 进度.....................................................................................................................................3
3.3 预算.....................................................................................................................................3
3.4 关键问题.............................................................................................................................3
4.人员组织及分工.........................................................................................................................3
5.交付期限.....................................................................................................................................3
6.专题计划要点.............................................................................................................................3
1.引言
1.1 编写目的
【阐明编写开发计划的目的,指明读者对象。
】
1.2 项目背景
【可包括:
a. 项目的委托单位、开发单位和主管部门;
b.该软件系统与其他系统的关系。
】
计算机软件开发文档编写指南
1.3 定义
【列出本档中用到的专门术语的定义和缩写词的原文。
】
1.4 参考资料
【可包括:
a. 项目经核准的计划任务书、合同或上级机关的批文;
b.文档所引用的资料、规范等;列出这些资料的作者、标题、编号、发表日期、出版单
位或资料来源。
】
2.项目概述
2.1 工作内容
【简要说明项目的各项主要工作,介绍所开发软件的功能、性能等。
若不编写可行性研究
报告,则应在本节给出较详细的介绍。
】
2.2 条件与限制
【阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。
必要时还
应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制。
】
2.3 产品
2.3.1 程序
【列出应交付的程序名称、使用的语言及存储形式。
】
2.3.2 文档
【列出应交付的文档。
】
2.4 运行环境
【应包括硬件环境、软件环境。
】
计算机软件开发文档编写指南
2.5 服务
【阐明开发单位可向用户提供的服务。
如人员培训、安装、保修、维护和其他运行支持。
】
2.6 验收标准
3.实施计划
3.1 任务分解
【任务的划分及各项任务的负责人。
】
3.2 进度
【按阶段完成的项目,用图表说明开始时间、完成时间。
】
3.3 预算
3.4 关键问题
【说明可能影响项目的关键问题,如设备条件、技术焦点或其他风险因素,并说明对策。
】
4.人员组织及分工
5.交付期限
6.专题计划要点
【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。
】
计算机软件开发文档编写指南
二、需求规格说明书
1.引言.............................................................................................................................................1
1.1 编写目的.............................................................................................................................1
1.2 项目背景.............................................................................................................................2
1.3 定义.....................................................................................................................................2
1.4 参考资料.............................................................................................................................2
2.任务概述.....................................................................................................................................2
2.1 目标.....................................................................................................................................2
2.2 运行环境.............................................................................................................................2
2.3 条件与限制.........................................................................................................................2
3.数据描述.....................................................................................................................................3
3.1 静态数据.............................................................................................................................3
3.2 动态数据.............................................................................................................................3
3.3 数据库介绍.........................................................................................................................3
3.4 数据词典.............................................................................................................................3
3.5 数据采集.............................................................................................................................3
4.功能需求.....................................................................................................................................3
4.1 功能划分.............................................................................................................................3
4.2 功能描述.............................................................................................................................3
5.性能需求.....................................................................................................................................3
5.1 数据精确度.........................................................................................................................3
5.2 时间特性.............................................................................................................................3
5.3 适应性.................................................................................................................................3
6.运行需求.....................................................................................................................................3
6.1 用户界面.............................................................................................................................3
6.2 硬件接口.............................................................................................................................3
6.3 软件接口.............................................................................................................................3
6.4 故障处理.............................................................................................................................3
7.其它需求.....................................................................................................................................3
1.引言
1.1 编写目的
【阐明编写需求说明书的目的,指明读者对象。
】
为明确软件需求、安排项目规划与进度、组织软件开发与测试,撰写本文档。
计算机软件开发文档编写指南
本文档供项目经理、设计人员、开发人员参考。
1.2 项目背景
c. 项目的委托单位、开发单位和主管部门
d.该软件系统与其他
1.3 定义
【列出文当中所用到的专门术语的定义和缩写词的原文。
】
1.4 参考资料
c. 项目经核准的计划任务书、合同或上级机关的批文
d.项目开发计划
e. 文档所引用的资料、标准和规范。
列出这些资料的作者、标题、编号、发表日期、出
版单位或资料来源
2.任务概述
2.1 目标
2.2 运行环境
操作系统:
Microsoft Windows 2000 Advanced Server
支持环境:
IIS 5.0
数 据 库:
Microsoft SQL Server 2000
2.3 条件与限制
计算机软件开发文档编写指南
3.数据描述
3.1 静态数据
3.2 动态数据
【包括输入数据和输出数据。
】
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.引言.............................................................................................................................................2
1.1 编写目的.............................................................................................................................2
1.2 项目背景.............................................................................................................................2
1.3 定义.....................................................................................................................................2
1.4 参考资料.............................................................................................................................2
2.任务概述.....................................................................................................................................3
2.1 目标.....................................................................................................................................3
2.2 运行环境.............................................................................................................................3
2.3 需求概述.............................................................................................................................3
2.4 条件与限制.........................................................................................................................3
3.总体设计................................................................................................................
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 计算机软件 开发 文档 编写 指南
![提示](https://static.bdocx.com/images/bang_tan.gif)