计算机软件开发文档的编写

一、可行性研究报告
二、项目开发计划
三、需求规格说明书
四、概要设计说明书
五、详细设计说明书
六、用户操作手册
七、测试计划
八、测试分析报告
九、开发进度月报
十、项目开发总结报告
十一、程序维护手册
十二、软件问题报告
十三、软件修改报告

一、可行性研究报告
1. 引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2. 可行性研究的前提
2.1要求
2.2目标
2.3条件
2.4可行性研究方法
2.5决定可行性的主要因素
3．对现有系统的分析
3.1处理流程和数据流程
3.2工作负荷
3.3费用支出
3.4人员
3.5设备
3.6局限性
4．所建议技术可靠性分析
4.1对系统的简要描述
4.2处理流程和数据流程
4.3与现有系统比较的优越性
4.4采用建议系统可能带来的影响
4.5技术可行性评价
5．所建议系统经济可行性分析
5.1支出
5.2效益
5.3收益/投资比
5.4投资回收周期
5.5敏感性分析
6．社会因素可行性分析
6.1法律因素
6.2用户使用可行性
7．其他可供选择的方案
8．结论意见

二、项目开发计划
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．项目概述
2.1工作内容
2.2条件与限制
2.3产品
2.4运行环境
2.5服务
3．实施计划
3.1任务分解
3.2进度
3.3预算
3.4关键问题
4．人员组织及分工
5．交付期限
6．专题计划要点

三、需求规格说明书
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．任务概述
2.1目标
2.2运行环境
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．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．任务概述
2.1目标
2.2运行环境
2.3需求概述
2.4条件与限制
3．总体设计
3.1处理流程
3.2总体结构和模块外部设计
3.3功能分配
4．接口设计
4.1外部接口
4.2内部接口
5．数据结构设计
5.1逻辑结构设计
5.2物理结构设计
5.3数据结构与程序的关系
6． 运行设计
6.1运行模块的组合
6.2运行控制
6.3运行时间
7．出错处理设计
7.1出错输出信息
7.2出错处理对策
8．安全保密设计
9．维护设计

五、详细设计说明书
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．总体设计
2.1需求概述
2.2软件结构
3．程序描述
3.1功能
3.2性能
3.3输入项目
3.4输出项目
3.5算法
3.6程序逻辑
3.7接口
3.8存储分配
3.9限制条件
3.10测试要点

六、用户操作手册
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．软件概述
2.1目标
2.2功能
2.3性能
3．运行环境
3.1硬件
3.2支持软件
4．使用说明
4.1安装和初始化
4.2输入
4.3输出
4.4出错和恢复
4.5求助查询
5．运行说明
5.1运行表
5.2运行步骤
6．非常规过程
7． 操作命令一览表
8． 程序文件（或命令文件）和数据文件一览表
9． 用户操作举例

七、测试计划
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．任务概述
2.1目标
2.2运行环境
2.3需求概述
2.4条件与限制
3．计划
3.1测试方案
3.2测试项目
3.3测试准备
3.4测试机构及人员

4.1测试项目名称及测试项目说明
4.2测试用例
4.3进度
4.4条件
4.5测试资料
5. 评价
5.1范围
5.2准则

八、测试分析报告
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2．测试计划执行情况
2.1测试项目
2.2测试机构和人员
2.3测试结果
3．软件需求测试结论

4.1软件能力
4.2缺陷和限制
4.3建议
4.4测试结论

九、开发进度月报
1．报告时间及所处的开发阶段
2．工程进度
2.1本月内的主要活动
2.2实际进展与计划比较
3．所用工时
4．所用机时
5．经费支出
6．工作遇到的问题及采取的对策
7．本月完成的成果
8．下月的工作计划
9．特殊问题

十、项目开发总结报告
1．引言
1.1编写目的
1.1项目背景
1.3定义
1.4参考资料
2．开发结果
2.1产品
2.2主要功能及性能
2.3所用工时
2.4所用机时
2.5进度
2.6费用
3．评价
3.1生产率评价
3.2技术方案评价
3.3产品质量评价
4．经验与教训

十一、程序维护手册
1．引言
1.1编写目的
1.2开发单位
1.3定义
1.4参考资料
2．系统说明
2.1 系统用途
2.2安全保密
2.3总体说明
2.4程序说明
3．操作环境
3.1设备
3.2支持软件
3.3数据库
4．维护过程
4.1约定
4.2验证过程
4.3出错及纠错方法
4.4专门维护过程
4.5专用维护程序
十二. 软件问题报告
1． 登记号
2． 登记日期
3． 问题发现日期
4． 活动
5． 状态
6． 报告人
7． 问题属于什么方面
8． 模块/子系统
9． 修订版本号
10． 磁带