
為了理解這種方法的實(shí)踐應用,我們可以設想一下最成功的開(kāi)源軟件,它們都有一些共同點(diǎn):有一個(gè)能夠自由協(xié)作與交流的活躍開(kāi)發(fā)者社區,以及優(yōu)秀的文檔。當開(kāi)發(fā)者協(xié)作編寫(xiě)出面向各種用戶(hù)的優(yōu)秀文檔時(shí),軟件的開(kāi)發(fā)和管理也會(huì )變得更容易。這個(gè)道理適用于任何組織,而且對于大型組織而言尤其重要。
將介紹各種標準文檔模板,它們將幫助我們理解如何管理組織內部開(kāi)發(fā)的軟件。例如,一位高級軟件開(kāi)發(fā)者可能只會(huì )使用API規范與參考文檔,然后就開(kāi)發(fā)實(shí)現一個(gè)應用程序,完全不會(huì )去閱讀其他的文檔。另一方面,人門(mén)指南則以一種簡(jiǎn)單方式概括介紹更多信息,它將幫助一些軟件開(kāi)發(fā)新手快速入門(mén)并了解他們將要接觸的應用程序、平臺或庫。用例( Use Case)文檔則可以向非技術(shù)人員解釋一個(gè)應用程序的用途。我們稍后將詳細介紹這些模板。
有了這些信息,用來(lái)理解復雜的Web與應用程序架構的時(shí)間就將大大減少。如果沒(méi)有一組能從不同角度說(shuō)明指定技術(shù)的文檔,那么Web開(kāi)發(fā)者和運維工程師就只能自己去理解各個(gè)方面。
最重要的是,在不同的利益相關(guān)者共同編寫(xiě)文檔的過(guò)程中,他們會(huì )發(fā)現一些深層次問(wèn)題和改進(jìn)軟件的機會(huì )。例如,當一位工程師開(kāi)始在紙上或設計模型上介紹一個(gè)Web應用程序時(shí),其他人就很容易理解他所要表達的概念,因此可以更好地獲得關(guān)于應用程序的技術(shù)性能和設計等方面的反饋信息。此外,針對不同讀者編寫(xiě)的文檔也有一定的好處。有時(shí),業(yè)務(wù)用戶(hù)可能無(wú)法讀懂一個(gè)AP規范,但是畫(huà)一個(gè)簡(jiǎn)單圖形來(lái)說(shuō)明API的復雜關(guān)系或應用程序之間的交互,就可以幫助非技術(shù)人員理解應用程序。這種文檔還可以幫助初級工程師理解復雜的軟件架構。
在這一方面,文檔就是一種鮮活的反饋機制。將應用變成文字與可視化內容,要比通過(guò)網(wǎng)站建設代碼或實(shí)現應用更容易讓人理解。通過(guò)編寫(xiě)和使用文檔,能夠激發(fā)反饋、發(fā)現代碼問(wèn)題,形成對程序和過(guò)程設計的新理念。這實(shí)際上也是一種測試代碼和Web應用的手段。
本文地址:http://www.havencoinwallet.com//article/4499.html