浅谈计算机文档的重要性

Author: 中软总公司 肖群 Date: 1994-12-02

        在实际开发工作中,我们应明确建立计算机文档的指导方针:一是文档编制工作应贯穿于整个软件开发的生命周期;二是文档编制工作必须遵循计算机技术人员通行的标准;三是文档编制时应按规定的管理流程办理;四是应明确制定文档管理标准和管理规程,包括为制定文档所需的一套手续,含制定计划、申请资源、编写、更新、发行、促进等。
        同时每个软件开发人员也应认识到文档在实现计算机产业化过程中所起的作用。其一,文档可以实现开发任务与任务之间的协调;其二,文档能为项目开发管理人员提供技术信息;其三,完整、详细的文档是软件开发人员完成阶段任务的标志;其四,文档可以向用户和操作人员提供使用计算机软件的方法;其五,文档能帮助技术人员查询软件错误,并将出现的故障定位排除;其六,文档可以减少企业由于自己的软件技术开发人员流动造成的损失;其七,建立文档便于向有关部门提供关于软件的知识产权证明,为侵犯版权的诉讼提供有力的证据。
        计算机文档可以根据其重要程序分成若干个等级,对不同等级的文档,公司应采取不同的控制策略。对源程序代码、流程图、逻辑图等,这是企业的核心机密,是软件保护的关键,加以重点控制,防止外流;对产品安装指南、操作手册、检测信息等,属于普通的计算机信息,可作一般控制;对概括的技术介绍、程序及其文档的目录、商业广告、培训教材,不仅不必控制,还应促其传播,因为它们是公司推广计算机软件的手段之一。
        总之,有了计算机软件的完整文档,软件开发就具有了延续性,不会发生由于个别软件技术开发人员工作变动造成无人替代其工作的现象,使我国的计算机软件真正向规模化、产业化迈进。