最新：网站建设中编写文档的点

笑谈人生

一旦在W组织中逐步培养起编写文档的文化，那么员工就会越来越依赖于这种践方法。这种文化还有一个十分重要的点，即如果出现人员流失和变动，那么良好的文档可以缩短新人的“交接”时间。此外，除了构成一般软件开发过程的标准代码注释、跟踪和源代码控制过程，编写文档也是一种审查方法。在一些开发专用软件的中，文档显得尤为重要，因为新员工一般很难理解复杂的定制应用程序，以及各个应用又是如何组成客户所访问的。如果文档成为这一过程的组成部分，人们就一定会对软件构建方式进行交流，工程师也会习惯于向其他团队成员介绍软件的工作方式。建设为了理解这种方法的践应用，我们可以设想一下比较成功的开源软件，它们都有一些共同点:有一个能够自由协作与交流的活跃开发者社区，以及秀的文档。当开发者协作编写出面向各种用户的秀文档时，软件的开发和管理也会变得更容易。这个道理适用于任何组织，而且对于大型组织而言尤其重要。



将介绍各种标准文档模板，它们将帮助我们理解如何管理组织内部开发的软件。有些信息，用来理解复杂的W与应用程序架构的时间就将大大减少。如果没有一组能从不同角度说明指定技术的文档，那么W开发者和运维工程师就只能自己去理解各个方面。



比较重要的是，在不同的利益相关者共同编写文档的过程中，他们会发现一些深层次问题和改进软件的机会。



通过编写和使用文档，能够激发反馈、发现代码问题，形成对程序和过程设计的新理念。这际上也是一种测试代码和W应用的手段。