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