软件项目文档管理文档管理是项目管理中最关键的部分之一，文档管理的规范与否关系到项目进展状况，关系整个项目工作的效率与效益。

抓住项目规范、文档规范，是推进公司发展的推动力。

一、文档管理的目标文档管理的目标是将软件项目各阶段的各种文档资料（如各种图表、文字说明材料、数据文件、报告等）有效地进行组织、规划、归类，使文档的获得、归类、查找和提取更容易。

最终目的就是使其成为软件项目中的一部分，与其他的项目内容构成完整的知识。

二、文档管理的作用及方法1、文档管理的作用软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。

它和计算机程序共同构成了能完成特定功能的计算机软件。

文档本身就是软件产品，没有文档的软件，不成其为软件，更谈不到软件产品。

软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。

高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。

文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用。

软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。

软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。

管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。

软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。

以上三种文档构成了软件文档的主要部分。

2、文档管理的方法文档管理方法是最好有一套文档管理系统，作用：记录文档的变更、修改、增加、删除等操作情况，有效管理好软件项目各阶段的文档。

为使用文档的人员提供了集中统一、安全的管理文档的渠道，实现了文档管理的电子化。

三、文档管理的任务1、确定文档管理的范围2、确定文档管理的内容和分类3、记录文档的变更情况4、建立编制、更改和维护文档的各种规程5、不断检查已建立起来的过程，以保证符合各种规程并遵守有关标准和指南6、在文档中存在商业秘密或技术秘密的情况下，还应注意保密四、文档管理任务的实现1、确定文档管理的范围在一个软件项目中可能需要管理的文档有：（1）可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

（2）项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

（3）软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

（4）数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

（5）概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

（6）详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

（7）用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

（8）操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

（9）测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。

计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

（10）测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。

对测试结果加以分析，并提出测试的结论意见。

（11）开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。

报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

（12）项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。

此外还需对开发工作作出评价，总结出经验和教训。

（13）维护修改建议，软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审批。

以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制。

其中有的仅反映一个阶段的工作，有的则需跨越多个阶段。

2、确定文档管理的内容和分类软件文档的内容划分成：语义文档、结构文档、过程文档语义文档是对软件的功能、概念、总体设计、流程、规约等用自然语言的描述，是软件人员根据规范在使用CASE工具编写并填入程序的文档，它也是为更全面的解释文档而灵活加入的额外信息。

结构文档是在软件设计工具、开发环境中对象的属性、构件间接口、构件间引用关系、软件的结构等的描述。

利用词法、语法分析程序对整个系统的对象、构件进行识别、分析，获取上述描述并形成表格文件。

过程文档是对软件的设计、编码、维护过程中形成的过程描述和程序注释，如设计目的、设计人、时间等说明，利用开发环境对软件人员在设计、开发、维护过程中操作的记录形成操作跟踪。

3、记录文档的变更情况管理人员在文档管理过程中，要及时有效地记录文档的变更信息，如文档的变更、修改、增加、删除等操作情况。

4、建立编制、更改和维护文档的各种规程（1）编制文档高质量的文档应满足以下特性：①针对性；文档编制以前应分清读者对象，按不同的类型、不同层次的读者，决定怎样适应他们的需要。

例如，管理文档主要是面向管理人员的，用户文档主要是面向用户的，这两类文档不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。

②精确性：文档的行文应当十分确切，不能出现多义性的描述。

同一课题若干文档内容应该协调一致，应是没矛盾的。

⑧清晰性：文档编写应力求简明，如有可能，配以适当的图表，以增强其清晰性。

④完整性：任何一个文档都应当是完整的、独立的，它应自成体系。

例如，前言部分应作一般性介绍，正文给出中心内容，必要时还有附录，列出参考资料等。

同一课题的几个文档之间可能有些部分相同，这些重复是必要的。

例如，同一项目的用户手册和操作手册中关于本项目功能、性能、实现环境等方面的描述是没有差别的。

特别要避免在文档中出现转引其它文档内容的情况。

比如，一些段落并未具体描述，而用“见××文档××节”的方式，这将给读者带来许多不便。

⑤灵活性：各个不同的软件项目，其规模和复杂程度有着许多实际差别，不能一律看待。

对于较小的或比较简单的项目，可做适当调整或合并。

比如，可将用户手册和操作手册合并成用户操作手册；软件需求说明书可包括对数据的要求，从而去掉数据要求说明书；概要设计说明书与详细设计说明书合并成软件设计说明书等。

⑥可追溯性；由于各开发阶段编制的文档与各阶段完成的工作有着紧密的关系，前后两个阶段生成的文档，随着开发工作的逐步扩展，具有一定的继承关系。

在一个项目各开发阶段之间提供的文档必定存在着可追溯的关系。

例如，某一项软件需求，必定在设计说明书，测试计划以至用户手册中有所体现。

必要时应能做到跟踪追查。

（2）更改和维护文档在整个软件生存期中，各种文档作为半成品或是最终成品，会不断地生成、修改或补充。

为了最终得到高质量的产品，必须加强对文档的管理。

以下几个方面是应注意做到的：①软件开发和测试人员在提交相关文档后，自己应有备份。

②软件开发和测试人员可根据工作需要在自己手中保存一些个人文档。

这些一般都应是主文本的复制件，并注意和提交的主文本保持一致，在作必要的修改时，也应及时通知文档管理人员。

③开发和测试人员个人只保存着主文本中与自己工作相关的部分文档。

④在新文档取代了旧文档时，管理人员应及时注销旧文档。

在文档内容有更动时，管理人员应随时修订主文本，使其及时反映更新了的内容。

⑤项目开发结束时，文档管理人员应及时收集开发和测试人员的个人文档。

发现个人文档与主文本有差别时，应立即着手解决。

这常常是未及时修订主文本造成的。

⑥在软件开发过程中，可能发现需要修改已完成的文档，特别是规模较大的项目，主文本的修改必须特别谨慎。

修改以前要充分估计修改可能带来的影响，并且要按照：提议、评议、审核、批准和实施等步骤加以严格的控制。

5、不断检查已建立起的文档管理过程，以保证符合各种规程并遵守有关标准和指南文档管理人员要经常检查已经建立的文档管理过程，监督其他工作人员遵守有关标准和指南，以便保证符合各种章程，实现文档的有效管理和维护，推动软件项目的进展。

6、在文档中存在商业秘密或技术秘密的情况下，还应注意保密文档保密是文档管理中非常重要的一个环节，任何一个项目中都存在有关商业或技术秘密的文档，这些文档关系到整个项目的成败，甚至关系到整个公司的发展前途。

因此，文档管理人员不仅自己要做好文档的保密，还要监督其他人员泄露文档，严格做好保密措施。

五、其他事项文档管理是一项长期性的工作，无论在人力、资金还是在时间投入上都是长期性的，但对于每个项目来说，它又是独立的。

在一个项目中文档管理需求如下：1、需要一人负责文档管理；2、在时间上，软件开发的各阶段都需要对文档进行收集和管理，可以采取定期收集整理方式；3、需要一台电脑存储文档（可用安装BUG系统的电脑）；4、需要一套文档管理系统（待定）。