及時(shí)更新網(wǎng)站文檔

發(fā)布：2018-12-11 21:10:16 瀏覽：4979

即使在一些有著穩(wěn)健和健康的文檔編寫(xiě)文化的組織中，應(yīng)用的進(jìn)化和修改速度也會(huì)遠(yuǎn)遠(yuǎn)快于文檔編寫(xiě)速度?，F(xiàn)實(shí)情況是軟件變化速度遠(yuǎn)遠(yuǎn)快于文檔編寫(xiě)速度，即使有自動(dòng)化文檔系統(tǒng)，有時(shí)候我們?nèi)匀恍枰斯ぞ帉?xiě)一些文檔。這種文檔需要通過(guò)一定的技術(shù)轉(zhuǎn)換，方能提供給在特殊閱讀環(huán)境中的讀者閱讀，因此無(wú)法通過(guò)自動(dòng)化方法維護(hù)。

API參考文檔以及其他高度技術(shù)化的文檔，則很可能通過(guò)編程語(yǔ)言平臺(tái)的自動(dòng)化文檔編寫(xiě)機(jī)制完成(如Java的Javadoc、Ruby的RDocPython的Pydoc等)。然而，有些需要人類(lèi)表達(dá)(這是最寶貴的交流方式)的文檔，則不像技術(shù)文檔一樣與應(yīng)用程序和基礎(chǔ)架構(gòu)有緊密關(guān)系。為此，技術(shù)文檔可能在一個(gè)月內(nèi)(或更短的時(shí)間內(nèi))就會(huì)過(guò)期，而有一些文檔可能幾年時(shí)間都未曾更新過(guò)一一不過(guò)，這種情況實(shí)際上比沒(méi)有技術(shù)文檔還要槽，因?yàn)闀?huì)進(jìn)上程帥以為不需要從別處獲取信息，而誤認(rèn)為這些過(guò)期文檔就是正確的信息。

除此之外，當(dāng)文檔創(chuàng)建后，許多工程師就不會(huì)再更新文檔了。定期檢查文檔才能讓文檔保持最新?tīng)顟B(tài)。

解決方法:通知工程師更新文檔

在整個(gè)組織范圍內(nèi)，人們不太可能詳細(xì)閱讀文檔管理系統(tǒng)(如Wi)中的所有文檔，但在一個(gè)部門(mén)級(jí)別上，卻可能會(huì)出現(xiàn)一些文檔修改和編輯。但是，使用隨機(jī)方法的效率是遠(yuǎn)遠(yuǎn)不夠的，我們必須通過(guò)某種機(jī)制，讓文檔管理系統(tǒng)能夠通知文檔所有人或管理員，讓他們?cè)谝欢螘r(shí)間后更新文檔。開(kāi)源Wiki系統(tǒng)Twiki提出了一種解決方案，它的頁(yè)面像報(bào)紙一樣在時(shí)間長(zhǎng)了之后會(huì)變黃。而且，在系統(tǒng)認(rèn)為文檔可能需要更新時(shí)，它會(huì)向文檔所有人發(fā)送一封通知郵件。

但只有工具還不夠，運(yùn)維與開(kāi)發(fā)團(tuán)隊(duì)還必須轉(zhuǎn)變認(rèn)識(shí)，他們必須將使用文檔視為一種軟件改進(jìn)手段。例如，需要更新的頁(yè)面會(huì)變成黃色但這并不意味著有人會(huì)去更新它。必須有人去響應(yīng)這個(gè)通知，如果接收者不理解創(chuàng)建及維護(hù)文檔對(duì)于代碼和系統(tǒng)的價(jià)值，那么這個(gè)響應(yīng)可能就不會(huì)出現(xiàn)。如果技術(shù)人員知道當(dāng)文檔需要更新時(shí)，系統(tǒng)才會(huì)通知他們，那么當(dāng)他們接收到一個(gè)通知時(shí)，他們就很可能會(huì)跟進(jìn)處理這個(gè)通知。這似乎有一些瑣碎，但是對(duì)技術(shù)人員予以告知可以鼓勵(lì)他們認(rèn)真對(duì)待文檔。

好處:將文檔整合到常規(guī)活動(dòng)中

當(dāng)網(wǎng)站設(shè)計(jì)開(kāi)發(fā)人員習(xí)慣了接收更新通知并響應(yīng)這些通知之后，他們就會(huì)看到文檔在改進(jìn)軟件方面的價(jià)值，這樣將進(jìn)一步激勵(lì)他們及時(shí)響應(yīng)通知。構(gòu)成大型網(wǎng)站基礎(chǔ)架構(gòu)的軟硬件通常由一定數(shù)量的位于數(shù)據(jù)中心內(nèi)的服務(wù)器組成。目前，這些基礎(chǔ)架構(gòu)的安裝及維護(hù)在一定程度上仍然通過(guò)人工方式完成。我們將介紹隨著計(jì)算領(lǐng)域內(nèi)的突破性進(jìn)展，虛擬化基礎(chǔ)架構(gòu)是如何減少人工需求的，以及如何實(shí)現(xiàn)其中一些流程的自動(dòng)化。不過(guò)，在考慮實(shí)施自動(dòng)化之前，最好先了解一下當(dāng)前的工作流程。