即便在一些有著穩健和安康的文檔編寫文化的組織中,應用的進化和修正速度也會遠遠快于文檔編寫速度。理想狀況是軟件變化速度遠遠快于文檔編寫速度,即便有自動化文檔系統,有時分我們依然需求人工編寫一些文檔。這種文檔需求經過一定的技術轉換,方能提供應在特殊閱讀環境中的讀者閱讀,因而無法經過自動化辦法維護。
API參考文檔以及其他高度技術化的文檔,則很可能經過編程言語平臺的自動化文檔編寫機制完成(如Java的 Javadoc、Ruby的RDoc Python的 Pydoc等)。但是,有些需求人類表達(這是最珍貴的交流方式)的文檔,則不像技術文檔一樣與應用程序和根底架構有嚴密關系。為此,技術文檔可能在一個月內(或更短的時間內)就會過時,而有一些文檔可能幾年時間都不曾更新過逐個不過,這種狀況實踐上比沒有技術文檔還要槽,由于會進上程帥以為不需求從別處獲取信息,而誤以為這些過時文檔就是正確的信息。
除此之外,當文檔創立后,許多工程師就不會再更新文檔了。定期檢查文檔才干讓文檔堅持最新狀態。
處理辦法:通知工程師更新文檔
在整個組織范圍內,人們不太可能細致閱讀文檔管理系統(如Wi) 中的一切文檔,但在一個部門級別上,卻可能會呈現一些文檔修正和編輯。但是,運用隨機辦法的效率是遠遠不夠的,我們必需經過某種機制,讓文檔管理系統可以通知文檔一切人或管理員,讓他們在一段時間后更新文檔。開源Wiki系統 Twiki提出了一種處理計劃,它的頁面像報紙一樣在時間長了之后會變黃。而且,在系統以為文檔可能需求更新時,它會向文檔一切人發送一封通知郵件。
但只要工具還不夠,運維與開發團隊還必需轉變認識,他們必需將運用文檔視為一種軟件改良手腕。例如,需求更新的頁面會變成黃色但這并不意味著有人會去更新它。必需有人去響應這個通知,假如接納者不了解創立及維護文檔關于代碼和系統的價值,那么這個響應可能就不會呈現。假如技術人員曉得當文檔需求更新時,系統才會通知他們,那么當他們接納到一個通知時,他們就很可能會跟進處置這個通知。這似乎有一些瑣碎,但是對技術人員予以告知能夠鼓舞他們認真看待文檔。
益處:將文檔整合到常規活動中
當網站設計開發人員習氣了接納更新通知并響應這些通知之后,他們就會看到文檔在改良軟件方面的價值,這樣將進一步鼓勵他們及時響應通知。構成大型網站根底架構的軟硬件通常由一定數量的位于數據中心內的效勞器組成。目前,這些根底架構的裝置及維護在一定水平上依然經過人工方式完成。我們將引見隨著計算范疇內的打破性停頓,虛擬化根底架構是如何減少人工需求的,以及如何完成其中一些流程的自動化。不過,在思索施行自動化之前,最好先理解一下當前的工作流程。
更多精彩請關注:http://www.www25673.cn