实时更新网站文档
发布日期:2023-03-24浏览量:138
即便在一些有着持重和安康的文档编写文明的组织中,应用的进化和修改速率也会远远快于文档编写速率。现实情况是软件变革速率远远快于文档编写速率,即便有自动化文档零碎,有时辰咱们依然需求人工编写一些文档。这类文档需求经由过程必然的手艺转换,方能提供应在特殊浏览环境中的读者浏览,因而没法经由过程自动化要领维护。
api参考文档以及其余高度手艺化的文档,则很能够经由过程编程言语平台的自动化文档编写机制完成(如java的 javadoc、ruby的rdoc python的 pydoc等)。然而,有些需求人类表达(这是最贵重的交流体式格局)的文档,则不像手艺文档同样与应用程序和根蒂根基架构有严密关系。为此,手艺文档能够在一个月内(或更短的时间内)就会过时,而有一些文档能够几年时间都不曾更新过逐个不外,这类情况理论上比没有手艺文档还要槽,由于会进上程帅以为不需求从别处获失信息,而误以为这些过时文档就是正确的信息。
除此以外,当文档创立后,许多工程师就不会再更新文档了。按期检查文档才气让文档连结最新状况。
解决要领:告诉工程师更新文档
在整个组织范畴内,人们不太能够具体浏览文档管理零碎(如wi) 中的一切文档,但在一个部门级别上,却能够会泛起一些文档修改和编纂。可是,运用随机要领的效力是远远不敷的,咱们必需经由过程某种机制,让文档管理零碎能够告诉文档一切人或管理员,让他们在一段时间后更新文档。开源wiki零碎 twiki提出了一种解决计划,它的页面像报纸同样在时间长了之后会变黄。并且,在零碎以为文档能够需求更新时,它会向文档一切人发送一封告诉邮件。
但只要工具还不敷,运维与开发团队还必需转变认识,他们必需将运用文档视为一种软件改良伎俩。比方,需求更新的页面会酿成黄色但这其实不料味着有人会去更新它。必需有人去相应这个告诉,若是接管者不睬解创立及维护文档对付代码和零碎的代价,那末这个相应能够就不会泛起。若是手艺职员知道当文档需求更新时,零碎才会告诉他们,那末当他们接管到一个告诉时,他们就很能够会跟进处置这个告诉。这仿佛有一些噜苏,可是对手艺职员予以奉告可以鼓舞他们当真看待文档。
益处:将文档整合到通常勾当中
当网页设计开发职员习气了接管更新告诉并相应这些告诉之后,他们就会看到文档在改良软件方面的代价,如许将进一步激励他们实时相应告诉。组成大型网站根蒂根基架构的软硬件通常由必然数目的位于数据中心内的服务器组成。今朝,这些根蒂根基架构的装置及维护在必然水平上依然经由过程人工体式格局完成。咱们将引见跟着计较领域内的突破性进展,虚拟化根蒂根基架构是怎样削减人工需求的,以及怎样实现此中一些流程的自动化。不外,在思索施行自动化以前,最佳先理解一下当前的事情流程。
相关文章: