软件项目程序与文档合一管理工作浅析.doc

软件项目程序与文档合一管理工作浅析 0 引言 文档存在于软件项目的整个生命周期之中，是软件项目的组成部分，文档管理是软件项目质量的控制方式之一，也是软件项目管理不可忽视的一部分内容。然而，“重结果，轻过程”一直是软件项目中存在的最大弊病，轻视文档管理就是一个典型的例子，不习惯及时整理归档，总觉得不重要，每每需要什么文档的时候，要么习惯问别人，要么会从杂乱无章信息中查询，花费了大量时间和精力。为了提高软件项目的成功率，文档管理必须要引起高度重视，即使对于即兴讨论、邮件、网上聊天及传阅资料等文档，也尽量定期备份整理，应该做到每天都要回顾信息，及时进行文 档归类，最好还要建立信息索引，提高查询速度和效率。 1 程序与文档合一基本概念的提出 规范的文档系统应当包括的属性是：能够准确地描述软件，并且简单易懂 ;能够迅速进行错误定位和影响分析，及时修正设计 ;能够提高软件维护质量，方便程序修改时理解程序。可以看出，在软件项目中，文档与程序密不可分，紧密结合。程序与文档合一的概念就是基于此提出的。这一概念的提出使得软件项目的最终产品 —— 软件成为真正意义上的软件，即程序 +文档，程序包含文档，文档集成在程序中，文档成为程序基本的表现形式。 2 软件项目程序与文档合一 的基本要求及流程 2.1 基本要求 在软件项目的管理过程中，要顺利开展程序与文档合一的管理，应满足以下基本要求： ①在选择开发环境时不仅要考虑环境对设计、开发的完美支持，而且要考虑对维护文档的支持 ;②软件人员在设计、开发过程中要考虑到便于维护和文档检索，程序与文档存储在同一位置、同一系统中 ;③使用相同工具进行程序与文档的书写、检索，在编写和维护程序的同时形成文档，在书写文档时编写、维护程序 ;④程序与文档合一的管理工作，不仅存在于系统的设计、开发阶段，而且存在于系统的维护阶段，它贯穿于软件项目的整个 生命周期。 2.2 技术流程 (1)文档即时嵌入存储到程序中。根据程序与文档合一的概念和文档从程序中提取的要求，文档必须存放在程序中，甚至可以将文档作为固有源代码的一部分。正常情况下，程序与文档应当分别存放在编程对象的不同表或不同的字段中，在编译与运行时分离。文档即时嵌入存储到程序中，实际可以看做程序与文档结合在一个编程对象中，结合在统一的开发环境中。同时，保证在修改代码时，可以同时修改文档 ;修改文档时，可以同时