API參考文檔以及其他高度技術(shù)化的文檔,則很可能通過編程語言平臺的自動化文檔編寫機制完成(如Java的 Javadoc、Ruby的RDoc Python的 Pydoc等)。然而,有些需要人類表達(這是最寶貴的交流方式)的文檔,則不像技術(shù)文檔一樣與應(yīng)用程序和基礎(chǔ)架構(gòu)有緊密關(guān)系。為此,技術(shù)文檔可能在一個月內(nèi)(或更短的時間內(nèi))就會過期,而有一些文檔可能幾年時間都未曾更新過一一不過,這種情況實際上比沒有技術(shù)文檔還要槽,因為會進上程帥以為不需要從別處獲取信息,而誤認(rèn)為這些過期文檔就是正確的信息。
除此之外,當(dāng)文檔創(chuàng)建后,許多工程師就不會再更新文檔了。定期檢查文檔才能讓文檔保持最新狀態(tài)。
解決方法:通知工程師更新文檔
在整個組織范圍內(nèi),人們不太可能詳細閱讀文檔管理系統(tǒng)(如Wi) 中的所有文檔,但在一個部門級別上,卻可能會出現(xiàn)一些文檔修改和編輯。但是,使用隨機方法的效率是遠遠不夠的,我們必須通過某種機制,讓文檔管理系統(tǒng)能夠通知文檔所有人或管理員,讓他們在一段時間后更新文檔。開源Wiki系統(tǒng) Twiki提出了一種解決方案,它的頁面像報紙一樣在時間長了之后會變黃。而且,在系統(tǒng)認(rèn)為文檔可能需要更新時,它會向文檔所有人發(fā)送一封通知郵件。
但只有工具還不夠,運維與開發(fā)團隊還必須轉(zhuǎn)變認(rèn)識,他們必須將使用文檔視為一種軟件改進手段。例如,需要更新的頁面會變成黃色但這并不意味著有人會去更新它。必須有人去響應(yīng)這個通知,如果接收者不理解創(chuàng)建及維護文檔對于代碼和系統(tǒng)的價值,那么這個響應(yīng)可能就不會出現(xiàn)。如果技術(shù)人員知道當(dāng)文檔需要更新時,系統(tǒng)才會通知他們,那么當(dāng)他們接收到一個通知時,他們就很可能會跟進處理這個通知。這似乎有一些瑣碎,但是對技術(shù)人員予以告知可以鼓勵他們認(rèn)真對待文檔。
好處:將文檔整合到常規(guī)活動中
當(dāng)網(wǎng)站設(shè)計開發(fā)人員習(xí)慣了接收更新通知并響應(yīng)這些通知之后,他們就會看到文檔在改進軟件方面的價值,這樣將進一步激勵他們及時響應(yīng)通知。構(gòu)成大型網(wǎng)站基礎(chǔ)架構(gòu)的軟硬件通常由一定數(shù)量的位于數(shù)據(jù)中心內(nèi)的服務(wù)器組成。目前,這些基礎(chǔ)架構(gòu)的安裝及維護在一定程度上仍然通過人工方式完成。我們將介紹隨著計算領(lǐng)域內(nèi)的突破性進展,虛擬化基礎(chǔ)架構(gòu)是如何減少人工需求的,以及如何實現(xiàn)其中一些流程的自動化。不過,在考慮實施自動化之前,最好先了解一下當(dāng)前的工作流程。
本文地址:http://m.cdrpkj.cn//article/4502.html