康路晨,康路晨講師,康路晨聯(lián)系方式,康路晨培訓(xùn)師-【中華講師網(wǎng)】
項(xiàng)目管理與網(wǎng)絡(luò)營銷管理實(shí)戰(zhàn)專家
52
鮮花排名
0
鮮花數(shù)量
康路晨:項(xiàng)目管理 : 軟件文檔的必備要素
2016-01-20 48951
大多數(shù)同行一樣,我明白軟件文檔的重要性。不幸的是,在任務(wù)開始前我很少閱讀文檔。相反,我常常像視線不清的父母一樣,在裝配好他們孩子的自行車之后,還落下一兩個零部件沒裝上。 如果我們明白文檔的重要性,那為什么我們不更經(jīng)常用它呢?然而,許多軟件文檔存在以下問題:
 
  · 錯誤的語法和/或拼錯的詞語
 
  · 不完整
 
  · 過時或不準(zhǔn)確
 
  · 過于冗長
 
  · 未經(jīng)解釋的縮略語或?qū)S眯g(shù)語
 
  · 查找信息困難
 
  存在這些問題的主要原因是軟件文檔常常被退居次位。工程預(yù)算迫使我們優(yōu)先考慮開發(fā)過程中的主要活動,也就是那些可以看得到利潤的地方。編寫文檔需要成本,因而它常常成為一項(xiàng)主觀上的活動,而且通常被認(rèn)為沒有重要作用,應(yīng)該盡量避免。許多項(xiàng)目經(jīng)理認(rèn)為客戶不需要文檔,它只是用來裝點(diǎn)門面的。
 
  軟件文檔質(zhì)量差的另外一個原因在于文檔撰寫者。許多應(yīng)用程序開發(fā)經(jīng)理認(rèn)為軟件文檔的編寫是軟件開發(fā)過程的一個標(biāo)準(zhǔn)組成部分,因此要求開發(fā)人員在編碼的過程中產(chǎn)出文檔。
 
  盡管這種做法在理論上行得通,但它沒有考慮開發(fā)人員編寫文檔的能力。簡單來說,技術(shù)人員是用來開發(fā)軟件而不是編寫文檔的。為了解決這個問題,許多應(yīng)用程序開發(fā)經(jīng)理雇傭?qū)I(yè)技術(shù)文檔編寫者或業(yè)務(wù)分析師,以期改進(jìn)軟件文檔的質(zhì)量。但這又遇到了另一個難題:專業(yè)編寫者及業(yè)務(wù)分析師的技術(shù)水平有限。
 
  解決這個問題要考慮需要編寫的文檔以及文檔的預(yù)期讀者。一般的規(guī)則是,寫文檔需要團(tuán)隊(duì)協(xié)作,這樣就允許開發(fā)人員和文檔編寫者利用彼此的長處,取長補(bǔ)短。例如,如果預(yù)期讀者是系統(tǒng)設(shè)計(jì)師,開發(fā)人員需要提供技術(shù)細(xì)節(jié),然后文檔編寫者按照正確語法組織和編輯內(nèi)容。不考慮預(yù)期讀者或?qū)iT編寫者,軟件文檔的質(zhì)量取決于其可用性,可從以下6個方面去評價(jià)其可用性:
 
  · 應(yīng)用性:文檔是否提供相關(guān)信息?
 
  · 及時性:信息是否及時?
 
  · 準(zhǔn)確性:信息是否正確?
 
  · 完整性:文檔是否足夠詳細(xì)而又不會太過拘泥細(xì)節(jié)?
 
  · 可得性:文檔是否隨時可得?
 
  · 可用性:你能否很快憑直覺就找到所需信息?
 
  軟件文檔的最主要目標(biāo)是傳達(dá)一個系統(tǒng)的技術(shù)要素和使用方法。第二個目標(biāo)是提供軟件開發(fā)過程中的需求,決策,行為,角色和責(zé)任的書面記錄。只有實(shí)現(xiàn)了這兩個目標(biāo),軟件文檔才真正提供了有意義的信息。
全部評論 (0)

Copyright©2008-2024 版權(quán)所有 浙ICP備06026258號-1 浙公網(wǎng)安備 33010802003509號 杭州講師網(wǎng)絡(luò)科技有限公司
講師網(wǎng) 3969a.com 直接對接10000多名優(yōu)秀講師-省時省力省錢
講師網(wǎng)常年法律顧問:浙江麥迪律師事務(wù)所 梁俊景律師 李小平律師