最好的Web開發(fā)人員總是可以寫出帶有好注釋的漂亮代碼，但是，他們一般也不會(huì)編寫專門給非開發(fā)人員閱讀的文檔。最好的工程師愿意瘋狂地開發(fā)應(yīng)用程序，但是不愿意花一點(diǎn)時(shí)間去編寫文檔或向其他人說明應(yīng)用程序。他們認(rèn)為，代碼就是文檔，而且有技術(shù)的人都能夠理解代碼，所以編寫額外的文檔是在浪費(fèi)時(shí)間。
 
然而，現(xiàn)實(shí)情況是，并非所有人都能夠讀懂API或配置管理清單。業(yè)務(wù)用戶、項(xiàng)目經(jīng)理及其他非技術(shù)人員經(jīng)常需要了解應(yīng)用程序的內(nèi)部工作方式，這樣他們才能更好地完成自己的工作，而技術(shù)文檔并不能滿足他們的需求。這些輔助人員是T組織正常運(yùn)行的重要條件，如果沒有這些信息，他們就會(huì)感到被疏遠(yuǎn)，不知道該如何與開發(fā)和運(yùn)維團(tuán)隊(duì)交流，或者也不知道如何將他們的工作傳達(dá)給業(yè)務(wù)部門、項(xiàng)目管理部門或其他非技術(shù)部門。


 
此外，還有一種借口:由于軟件開發(fā)速度越來越快，所以開發(fā)人員和運(yùn)維人員需要進(jìn)一步提高生產(chǎn)力，減少交叉培訓(xùn)、編寫文檔和內(nèi)部培訓(xùn)的時(shí)間。這同樣也是不對(duì)的。如果沒有文檔，我們就無法將遺留系統(tǒng)引入組織中。遺留系統(tǒng)通常是每隔幾年就需要更新一次，因?yàn)橹廊绾尉S護(hù)這些系統(tǒng)的人可能已經(jīng)離開公司，或者根本不記得如何維護(hù)這些系統(tǒng)，也沒有參考資料可以查閱。
 
解決方法:將文檔加到成功條件中，共同分擔(dān)文檔編寫責(zé)任
 
大多數(shù)基于Web的組織都會(huì)使用一種敏捷或精益方法來開發(fā)軟件，而且這個(gè)過程通常需要定期極查已完成的上作和核對(duì)任務(wù)執(zhí)行情況，從而落實(shí)項(xiàng)目的進(jìn)展情況。這樣的話，文檔就可以整合到開發(fā)與運(yùn)維團(tuán)隊(duì)的文化中，而且組織也能夠從中獲益，例如產(chǎn)出質(zhì)量更好的代碼和發(fā)現(xiàn)設(shè)計(jì)問題等。
 
這個(gè)過程需要管理層的參與才能取得成功。如果管理層只關(guān)注于完成進(jìn)度，而不注意形成文檔編寫文化，那么這種過程是不可能成功的。只是認(rèn)同文檔屬于軟件開發(fā)生命周期的一部分，但不使用必要的文檔工具，也不投入時(shí)間，那么形成文檔編寫文化的目標(biāo)就不可能實(shí)現(xiàn)。
 
而且，開發(fā)與運(yùn)維團(tuán)隊(duì)都必須參與到文檔編寫文化的創(chuàng)建過程中，他們必須共同協(xié)作，而不能各自為政。在一些超大型組織中，最好配備一位有開發(fā)或運(yùn)維背景的全職技術(shù)文檔工程師。因?yàn)檫@個(gè)人有技術(shù)背景，從而也就不容易讓人懷疑他的專業(yè)性。
 
好處:培養(yǎng)責(zé)任意識(shí)
 
配備一位有技術(shù)背景的文檔編寫人員(技術(shù)文檔工程師)有利于鼓勵(lì)開發(fā)與運(yùn)維團(tuán)隊(duì)主動(dòng)承擔(dān)起編寫代碼文檔、應(yīng)用文檔和流程文檔的責(zé)任。一位經(jīng)驗(yàn)豐富的技術(shù)文檔工程師可以指導(dǎo)他人編寫出有效的文檔，或者幫助他們養(yǎng)成編寫文檔的習(xí)慣。這樣可以幫助反對(duì)編寫文檔的工程師開始接受文檔編寫工作。
 
一旦每位網(wǎng)站制作工程師都愿意編寫自己的文檔，那么技術(shù)文檔工程師就可以將角色從布道師和寫手，轉(zhuǎn)變?yōu)榫庉嫼椭笇?dǎo)者，專職負(fù)責(zé)保證文檔的正確組織和發(fā)布，以及幫助工程師改進(jìn)技術(shù)文檔的質(zhì)量。當(dāng)然，不同部門的技術(shù)文檔工程師有不同的職責(zé)，這取決于Web業(yè)務(wù)的組織方式，但是作為文檔編寫的關(guān)鍵人物，他可以保證文檔真正編寫完成。