软件文档管理

主要分为以下几类：

技术文件、设计文件、版本说明文件以及产品说明文件

每个文件都使用版本号做标识

1）大的文档编制及文档列表，然后详细到每个文档中

2）文档等级，在一个项目中需要哪些文档，哪些不需要，根据级别讨论清楚，因为项目大小本身是不定的，所以文档的多少也不能确定，甚至需要和不需要的文档内容都是不确定的。

3）在确定每个文档等级之后，到最终，项目实施完成，需要有产品说明文件，产品只是一个概念，软件最终是要产品化，谁都想有自己的品牌，然而阶段性的目标不可少，在版本说明文档及产品说明文件中要详细描述清楚现有软件实现的功能，还有什么功能不完善，以对市场人员及管理人员有一个严格的控制及执行的说明书，可以了解整个软件的架构及体系。

 

接着说管理依据

开发文档规定若干个检查点和进度表，使管理者可以评定项目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。项目到了之后首先做到心中有数，调研和详细的分析必不可少，其间与客户的沟通尤为重要。

接着是各任务之间的交流与沟通

如果是大公司可以是通过正规的文档，如果是小公司可以通过交流，但最终交流的结果一定的有证可依，有会议文档这样的内容。

然后是质量，

质量需要通过各个层次之间的执行力度来保证，需要严格控制

培训参考与软件的维护

在软件做完之后，包括公司内部人员培训和客户培训，需要有针对不同人员的文档及资料

最终最重要的就是控制版本，包括所有文件的版本说明，改到计划等。

 

软件文档归入如下三种类别：

a) 开发文档——描述开发过程本身；

b) 产品文档——描述开发过程的产物；

c) 管理文档——记录项目管理的信息。

 

基本的开发文档是：

——可行性研究和项目任务书；

——需求规格说明；

——功能规格说明；

——设计规格说明，包括程序和数据规格说明；

——开发计划；

——软件集成和测试计划；

——质量保证计划、标准、进度；

安全和测试信息。

 

产品的文档起到如下三种作用：

a) 为使用和运行软件产品的任何人规定培训和参考信息；

b) 使得那些未参加开发本软件的程序员维护它；

c) 促进软件产品的市场流通或提高可接受性。

 

基本的产品文档包括：

——培训手册；

——参考手册和用户指南；

——软件支持手册；

——产品手册和信息广告。

 

这种文档建立在项目管理信息的基础上，诸如：

——开发过程的每个阶段的进度和进度变更的记录；

——软件变更情况的记录；

——相对于开发的判定记录；

——职责定义。