软件文档

软件承包方通常需要提供的软件配置内容

• 可执行程序、源程序、配置脚本、测试程序或脚本。

 

• 主要的开发类文档：

《需求分析说明书》《概要设计说明书》《详细设计说明书》《数据库设计说明书》

《测试计划》《测试报告》《用户操作手册》《程序维护手册》《程序员开发手册》

《项目总结报告》

 

• 主要的管理类文档：

《项目计划书》《质量控制计划》《配置管理计划》《用户培训计划》

《质量总结报告》《评审报告》《会议记录》《开发进度月报》

 

说明：

     《软件功能规格说明书》：需要确定用户对软件的需求,要作到明确、无歧义。不涉及具体实现方法。用户能看得明白，开发人员也可据此进行下面的工作（概要设计）
     《软件概要设计说明书》：说明系统模块划分、选择的技术路线等，整体说明软件的实现思路。并且需要指出关键技术难点等。
     《软件详细设计说明书》：对概要设计的进一步细化，一般由各部分的担当人员依据概要设计分别完成，然后在集成，是具体的实现细节。理论上要求可以照此编码。

《程序维护手册》的主要内容包括：系统说明(包括程序说明)、操作环境、维护过程、源代码清单等，编写目的是为将来的维护、修改和再次开发工作提供有用的技术信息。

《程序员开发手册》的主要内容包括：系统目标、开发环境使用说明、测试环境使用说明、编码规范及相应的流程等，实际上就是程序员的培训手册。

 

按阶段划分

• 市场调研：《可行性分析》《项目开发计划》

• 需求分析：《软件需求规格说明书》

• 概要设计：《概要设计说明书》

• 详细设计：《详细设计说明书》《数据库设计说明书》《接口设计说明书》

• 编码：《编码规范》

• 测试：《测试计划》《测试用例》《软件测试报告》

• 发布与维护：《项目开发总结报告》《用户手册》《应用软件清单》《源代码清单》《维护文档》