软件开发中管理的探索与实践.pdfVIP

·光盘数据库与信息系统· 软件开发中文档管理的探索与实践 赵丙秀 （武汉软件工程职业学院，湖北 武汉 430205） 摘 要：文档管理是软件开发管理过程中不可或缺的一部分，是软件配置管理的基础。目前许多中小型软件企业都存在文档管理 混乱，而导致软件开发随心所欲、进度延期、维护困难等问题。作者分析了这些问题产生的原因，提出了基本解决办法，最后通过实践 验证了这些方法的有效性。 关键词： 文档管理；目录检索；文档制度；文档模板 中图分类号： 文献标识码： TP311 A Explorat ion and Pract ice on Document Management in Soft ware Development ZHAO Bing-xiu （Wuhan Vocational College of Software and Engineering, Hube i Wuhan 430205） Key words: Document Management ；Document retrieval ；Documentation System ；Document Template 在企业，软件开发过程中所产生的一系列技术文档，在软件质量 文档检索目录管理是文档管理的另一个核心，如果没有一 保证和软件可维护性等方面起到了无可替代的作用, 使得高质量技术 个良好的目录检索体系，用不了多久，软件的实施者就不知道他 文档的生成成为软件开发过程中的一个核心环节,这也就使得技 们所写的文档应当放在哪个地方，而软件的风险承担者就更不 术文档的管理成为软件开发管理过程中不可缺少的一部分。 清楚到哪个地方去寻找他们所各自关心的文档。 文档管理是软件配置管理的基础，因为软件配置管理要求 文档制度管理主要对文档的规范、代码的规范命名、文档书 一切产品和过程均文档化，只有文档化了才有了软件产品记录 写者和管理者的角色定位，都有明确的规定，从而形成文档制 和配置项，才可能对生产过程进行管理和改进。 度。使用文档的人必须要符合一定的规范，如果每个书写使用文 1 现实工作中存在的问题 档的人都不遵照制度办事，那么用不了多久，各种千奇百怪的不 现在许多中小型软件企业忽视了文档管理，因而产生了这 同风格的文档就会让软件管理者无所适从。因此如何让文档使 样那样的问题，其中有如下问题与文档管理有关。 用者真正遵从文档制度管理，是项目管理者的一个难点课题，他 （1）没有统一的编码风格，每个人读别人的代码如同读天书 需要沟通、行政、绩效等多种手段。文档制度有很多，在软件企业 一般，程序员很讨厌维护他人的代码。由于代码帮助和辅助文档 中文档制度中使用最多的是《代码规范指南》、《测试计划指南》、 19 很少，程序员过了一段时间之后连自己的代码都看不懂了，因此 《配置管理指南》。 极大的挫伤了程序员维护工作的积极性。 3 文档管理的基本方法 （2）没有统一的文档风格，每个人读别人的文档很吃力，经 3．1 制定标准的开发和管理模板 常不知所云，影响项目开发流程的文档写作心情。 制定各种文档的标准化模板，例如 《软件需求规格说明》、 （3）没有统一的文档检索体系，查找某个人的文档经常要把 《概要设计说明书》、《需求检视报告》、《概要设计审查表》等。一 当事人找来，满硬盘的寻找，还不见得能寻找到。 般要求做到，只要出现了一种新的文档，就必须要有一个标准模 （4）因为离职人员的机要备份不力而丢失重要的源代码。经 板与之对应，这样可以大大降低员工间文档交流的学习成本。 常因查不到该备