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

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

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

2、建议技术可靠性分析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、务分解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

4、编写目的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.

5、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． 程序文

6、件（或命令文件）和数据文件一览表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测试结

7、果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

8、.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．