`
zhang_xzhi_xjtu
  • 浏览: 536403 次
  • 性别: Icon_minigender_1
  • 来自: 杭州
社区版块
存档分类
最新评论

文档的作用

阅读更多
万事万物总是有其两面性的。
当瀑布模型把文档放在一个很重要的位置之后,随后的敏捷把文档并没有给予同样的重视。
一直都觉得敏捷的适应范围是很广的。但是最近由于所在项目文档的缺乏,让我重新思考了文档的作用。

文档缺乏的好处是,恩,真的是有好处的,因为这个客观上促进了项目组成员的沟通交流,而沟通交流的越多,一个项目组越熟悉,其可能成功的概率越大。同时,项目减少了文档维护的时间。

不好的地方,关于项目的知识是口口相传的,最后时间长了,人员变了,有些事情变成了没有定论的,有些事情(即使很重要)变成了被遗忘的,有些事情在某些人那里得到了改动,但是其他人未必知道,直到这个改动影响到他的时候,他才会更新自己这部分的知识。
结果就是没有人能真正了解这个项目,因为没有地方可以得到这个项目的全景和最新的一个快照。而我的观察是,大部分的程序员都是满足于了解和自己手头相关的事情之后,并不会主动去了解整个项目,更不要说在不知道从何着手的情况下了。

结论是,项目的文档还是很重要的,可以不要一些重型的文档,改进重型的文档维护过程,但是项目应该具有一套简洁,完备,且时时更新的文档。从而使得项目的老人,新手,管理者都有一个地方可以通过文档得到一些重要的信息。
分享到:
评论

相关推荐

    正确理解技术文档的作用

    技术文档是指对某一技术领域内的概念、原理、操作步骤等内容进行系统性记录的文件。这些文档通常包括但不限于用户手册、开发指南、API文档、故障排除指南等。技术文档的主要作用有以下几点: 1. **知识传递**:技术...

    文档的作用与分类.doc

    文档的作用与分类 文档是软件开发中不可或缺的一部分,它记录了软件开发的各个阶段的工作成果和经验,是软件产品的重要组成部分。文档的作用与分类是软件开发中一个重要的环节,它对软件开发的各个阶段都有着重要的...

    CDA 电子病历共享文档共享文档规范-word版

    CDA文档由结构化和非结构化数据组成,包括患者的基本信息、病史、诊断、治疗方案、检查结果、药品使用等。每个部分都有严格的元数据结构,使得数据能够被计算机解析和理解,同时也保持了文档的可读性,方便医生和...

    C++代码文档生成器 根据代码及注释自动生成代码文档.zip

    - **保持良好的注释习惯**:为了生成高质量的文档,代码应该有清晰、详尽的注释,描述类的功能、函数的作用、参数的意义以及返回值等。 - **配置设置**:根据项目需求,可能需要调整工具的配置,例如设定输出格式、...

    软件工程标准化文档.doc

    《软件工程标准化文档》实验报告主要探讨了软件工程标准化的重要性、层次结构以及在软件开发过程中文件编制的角色。软件工程标准化是确保软件质量、提高开发效率和促进协作的关键。以下是实验报告涉及的主要知识点:...

    initrd映像文档的作用和制作

    **initrd映像文档的作用** `initrd`全称是Initial RAM Disk,它是一个临时的根文件系统,用于系统引导期间加载必要的驱动程序和执行早期的初始化任务。在Linux操作系统中,`initrd`是一个非常重要的组件,尤其在...

    各种常用文档文件

    在IT领域,日常工作中我们经常会接触到各种文档文件,这些文件用于记录、传递和管理信息,是组织运营和协作的重要工具。"各种常用文档文件"这一主题涵盖了规章、制度以及表格等多个方面,这些都是企业管理和日常工作...

    程序员项目交接文档

    IT 项目交接文档概要是程序员在项目交接过程中的重要文件,它对项目的开发、测试和维护起着至关重要的作用。本文档概要将对程序员项目交接文档的主要内容进行概要介绍。 人事模块是程序员项目交接文档的重要组成...

    Flask PDF中文文档

    本文档是对Flask框架的详细介绍,涵盖了安装、快速上手、项目布局、应用设置、数据库、蓝图和视图、模板、静态文件、博客蓝图、项目可安装化、测试、部署、产品继续开发等方面的知识点。 一、安装和快速上手 * ...

    腾讯产品需求文档,腾讯PRD文档

    * 产品设计:PRD文档是产品设计的重要依据,对产品的设计和开发具有指导作用。 * 产品开发:PRD文档是产品开发的重要参考,对产品的开发和测试具有指导作用。 * 产品测试:PRD文档是产品测试的重要依据,对产品的...

    软件开发文档模板(最全)

    软件开发文档大全通常包含以上这些核心文件,它们是团队协作的基础,保证了项目的高效、有序进行。对于初学者和经验丰富的开发者来说,拥有一个全面的文档模板集合是非常宝贵的资源,可以快速适应项目规范,提高工作...

    项目文档模版--测试文档

    3. **详细文档**:详细文档通常包括设计规格书、接口文档等,这些文档详细描述了系统的各个组件、它们如何相互作用,以及具体实现的技术细节。它们对于开发和维护工作至关重要,因为它们提供了清晰的蓝图。 4. **...

    PRD产品需求文档经典模板

    * 产品需求文档的作用:指导《架构设计说明书》和《软件需求说明书》,让读者了解产品的外部黑盒概念。 二、 目的 * 产品需求文档的目的:收集、分析和定义产品的需求和特性。 三、 范围 * 产品需求文档的范围:...

    StarUml 输出需求文档或设计文档 的WordTemplates

    在“标签”中,"staruml template 输出需求文档 输出设计文档",强调了模板在文档生成过程中的作用。StarUML的模板功能允许用户将模型数据转换为结构化的Word文档,从而方便地输出需求文档(描述项目需求、功能和...

    014软件开发技术文档管理规范.docx

    《软件开发技术文档管理规范》是依据ISO9001质量体系作业文件的要求,旨在确保软件开发过程中的文档管理工作高效、规范,以便于积累技术知识,提升工作效率,并为未来的项目提供有价值的参考资料。以下是对该规范的...

    Aspose.Words+帮助文档

    在实际开发中,Aspose.Words常被用于自动化报告生成、数据导出、文档转换和电子表格合并等场景。通过与Aspose.Total结合,开发者可以获得对更多文件格式(如Excel、PDF、邮件)的支持,从而实现跨格式的文档处理。 ...

    security文档4.0.pdf

    renren-security项目是一个轻量级的权限管理系统,涵盖了用户管理、角色管理、部门管理、菜单管理、定时任务、参数管理、字典管理、文件上传、登录日志、操作日志、异常日志、文章管理、APP模块等众多功能。...

    软件开发必备文档(包含软件开发所需各种文档需求)

    在软件开发过程中,文档起着至关重要的作用,它们不仅是团队沟通的桥梁,也是项目管理和质量保证的关键工具。本压缩包“软件开发必备文档”包含了软件生命周期中的关键文档,旨在为软件开发团队提供全面的需求分析、...

    投标文件 需求文档 建设方案等文档模板.doc

    投标文件需求文档建设方案模板的知识点解析 本文档模板是用于投标文件、需求文档、项目建设方案等的模板文件,下载后可以根据实际需求修改文档结构、标题编号、页面序号等已调整好,建议不要修改直接使用。 模板的...

    软件工程文档(国家标准)

    本文件聚焦于“软件工程文档(国家标准)”,我们将深入探讨这一主题,了解其核心内容以及对软件开发的意义。 首先,我们需要理解软件工程文档的分类和作用。通常,一个完整的软件工程文档包括以下几类: 1. 需求...

Global site tag (gtag.js) - Google Analytics