网站建设中编写文档的优点
一旦在Web组织中慢慢造就起编写文档的文化,那么员工就会越来越依附于这种实践办法。这种文化还有一个十分主要的长处,即假如涌现人员流掉和更改,那么优越的文档可以缩短新人的“交代”时光。此外,除了组成一般软件开辟进程的尺度代码注释、跟踪和源代码掌握进程,编写文档也是一种审查办法。在一些开辟专用软件的公司中,文档显得尤为主要,因为新员工一般很难懂得庞杂的定制运用法式,以及各个运用又是若何构成客户所拜访的网站。假如文档成为这一进程的构成部门,人们就必定会对软件构建方法进行交换,工程师也会习惯于向其他团队成员介绍软件的工作方法。
为了懂得这种办法的实践运用,我们可以假想一下最胜利的开源软件,它们都有一些配合点:有一个可以或许自由协作与交换的活泼开辟者社区,以及优良的文档。当开辟者协作编写出头具名向各类用户的优良文档时,软件的开辟和治理也会变得更轻易。这个事理实用于任何组织,并且对于年夜型组织而言尤其主要。
将介绍各类尺度文档模板,它们将赞助我们懂得若何治理组织内部开辟的软件。例如,一位高等软件开辟者可能只会应用API规范与参考文档,然后就开辟实现一个运用法式,完整不会去浏览其他的文档。另一方面,人门指南则以一种简略方法归纳综合介绍更多信息,它将赞助一些软件开辟新手快速入门并懂得他们将要接触的运用法式、平台或库。用例( Use Case)文档则可以向非技巧人员说明一个运用法式的用处。我们稍后将具体介绍这些模板。
有了这些信息,用来懂得庞杂的Web与运用法式架构的时光就将年夜年夜削减。假如没有一组能从分歧角度解释指定技巧的文档,那么Web开辟者和运维工程师就只能本身去懂得各个方面。
最主要的是,在分歧的好处相干者配合编写文档的进程中,他们会发明一些深条理问题和改良软件的机遇。例如,当一位工程师开端在纸上或设计模子上介绍一个Web运用法式时,其他人就很轻易懂得他所要表达的概念,是以可以更好地获得关于运用法式的技巧机能和设计等方面的反馈信息。此外,针对分歧读者编写的文档也有必定的利益。有时,营业用户可能无法读懂一个AP规范,然则画一个简略图形来解释API的庞杂关系或运用法式之间的交互,就可以赞助非技巧人员懂得运用法式。这种文档还可以赞助初级工程师懂得庞杂的软件架构。
在这一方面,文档就是一种鲜活的反馈机制。将运用酿成文字与可视化内容,要比经由过程网站扶植代码或实现运用更轻易让人懂得。经由过程编写和应用文档,可以或许激发反馈、发明代码问题,形成对法式和进程设计的新理念。这现实上也是一种测试代码和Web运用的手腕。