當(dāng)前位置:工程項目OA系統(tǒng) > 房地產(chǎn)OA系統(tǒng) > 相關(guān)系統(tǒng) > 房地產(chǎn)項目管理軟件
軟件開發(fā)文檔編制的質(zhì)量要求
造成軟件文檔質(zhì)量不高的原因可能是:
· 缺乏實踐經(jīng)驗,缺乏評價文檔質(zhì)量的標(biāo)準(zhǔn)。
· 不重視文檔編寫工作或是對文檔編寫工作的安排不恰當(dāng)。
最常見到的情況是,軟件開發(fā)過程中不能按給出的進(jìn)度, 分階段及時完成文檔的編制工作,而是在開發(fā)工作接近完成時集中人力和時間專門編寫文檔。另一方面,和程序工作相比,許多 人對編制文檔不感興趣。于是在程序工作完成以后,不得不應(yīng)付一下,把要求提供的文檔趕寫出來。這樣的做法不可能得到高質(zhì)量的文檔。實際上,要得到真正高質(zhì)量的文檔并不容易,除去應(yīng)在認(rèn)識上對文檔工作給予足夠的重視外,常常需要經(jīng)過編寫初稿,聽取意見進(jìn)行修改,甚至要經(jīng)過重新改寫的過程。
高質(zhì)量的文檔應(yīng)當(dāng)體現(xiàn)在以下一些方面:
①針對性
文檔編制以前應(yīng)分清讀者對象,按不同的類型、不同層次的讀者,決定怎樣適應(yīng)他們的需要。例如,管理文檔主要是面 向管理人員的,用戶文檔主要是面向用戶的,這兩類文檔不應(yīng)像開發(fā) 文檔(面向軟件開發(fā)人員)那樣過多地使用軟件的專業(yè)術(shù)語。
?、诰_性
文檔的行文應(yīng)當(dāng)十分確切,不能出現(xiàn)多義性的描 述。同一課題若干文檔內(nèi)容應(yīng)該協(xié)調(diào)一致,應(yīng)是沒矛盾的。
?、矍逦?nbsp;
文檔編寫應(yīng)力求簡明,如有可能,配以適當(dāng)?shù)膱D 表,以增強其清晰性。
?、芡暾?nbsp;
任何一個文檔都應(yīng)當(dāng)是完整的、獨立的,它應(yīng)自成體系 。例如,前言部分應(yīng)作一般性介紹,正文給出中心內(nèi)容 ,必要時還有附錄,列出參考資料等。同一課題的幾個文檔之間可能 有些部分相同,這些重復(fù)是必要的。例如,同一項目的用戶手冊和操 作
冊中關(guān)于本項目功能、性能、實現(xiàn)環(huán)境等方面的描述是沒有差別 的。特別要避免在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況。比如,一
些段落并未具體描述,而用"見××文檔××節(jié)"的方式,這將給 讀者帶來許多不便。
?、蒽`活性
各個不同的軟件項目,其規(guī)模和復(fù)雜程度有著許 多實際差別,不能一律看待。圖6所列文檔是針對中等規(guī)模的軟件而言的。對于較小的或比較簡單的項目,可做適當(dāng)調(diào)整或合 并。比如,可將用戶手冊和操作手冊合并成用戶操作手冊;軟件需求說明書可包括對數(shù)據(jù)的要求,從而去掉數(shù)據(jù)要求說明書;概要設(shè) 計說明書與詳細(xì)設(shè)計說明書合并成軟件設(shè)計說明書等。
?、蘅勺匪菪?nbsp;
由于各開發(fā)階段編制的文檔與各階段完成的工作有著緊密的關(guān)系,前后兩個階段生成的文檔,隨著開發(fā)工作的逐步 擴展,具有一定的繼承關(guān)系。在一個項目各開發(fā)階段之間提供文檔 必定存在著可追溯的關(guān)系。例如,某一項軟件需求,必定在設(shè)計說明 書,測試計劃以至用戶手冊中有所體現(xiàn)。必要時應(yīng)能做到跟蹤追查。
- 1王坤:違規(guī)建筑插上國旗是在與法治叫板?
- 2軟件項目質(zhì)量管理責(zé)任分配
- 3斯蒂文·霍爾:多孔滲透式建筑設(shè)計理念
- 42015年安全工程師考試《生產(chǎn)管理知識》習(xí)題(15)
- 5張彥峰:建筑行業(yè)如同古代行軍打仗牽一發(fā)動全身
- 62015年安全工程師考試《生產(chǎn)管理知識》習(xí)題(9)
- 7孫鴻新:醫(yī)療建筑選址很重要
- 8水泥砂漿保護(hù)層報驗用表及范例
- 92015年安全工程師《安全生產(chǎn)技術(shù)》試題16
- 10安全工程師考試《安全生產(chǎn)管理知識》全真試題(1)
- 11時評:古建是否“戴帽”,折射理念之爭
- 122015年安全工程師考試《安全產(chǎn)生技術(shù)》模擬題(53)
- 13項目管理改進(jìn)系列四:管理改進(jìn)需要工具,還需要大量的咨詢實施工作
- 142015年安全工程師《安全產(chǎn)生法》模擬題(33)
- 15PMP常用術(shù)語.doc
- 16李揚:中國房地產(chǎn)市場面臨四個重要問題
- 17江西某醫(yī)院綜合樓質(zhì)量與文明施工創(chuàng)優(yōu)策劃(杜鵑花杯)
- 18項目成功:由項目類型和項目經(jīng)理特征引起的差異
- 19為何BIM技術(shù)在市政工程中應(yīng)用難?
- 20通病防治措施情況檢查表(空白表格)
- 21曹剛:通過深入的研究來解決客戶的問題并增加附加值
- 22仇保興:中國走以大城市為主城鎮(zhèn)化道路是危險陷阱
- 23[河北]住宅小區(qū)工程創(chuàng)優(yōu)施工方案(安濟(jì)杯)
- 24霍兵:拒絕任性,有約束才能做出好建筑
- 252015年安全工程師《安全產(chǎn)生技術(shù)》模擬題(44)
- 262015年安全工程師《安全生產(chǎn)法及相關(guān)法律知識》試題9
- 27老板怎樣做才能讓員工說真話
- 28軟件項目策劃成功進(jìn)行的九個基本要點
- 29矩陣式的項目經(jīng)理請你強勢起來!
- 302015年安全工程師《安全產(chǎn)生法》練習(xí)題(36)
成都公司:成都市成華區(qū)建設(shè)南路160號1層9號
重慶公司:重慶市江北區(qū)紅旗河溝華創(chuàng)商務(wù)大廈18樓