• <ruby id="5koa6"></ruby>
    <ruby id="5koa6"><option id="5koa6"><thead id="5koa6"></thead></option></ruby>

    <progress id="5koa6"></progress>

  • <strong id="5koa6"></strong>
    • 軟件測試技術
    • 軟件測試博客
    • 軟件測試視頻
    • 開源軟件測試技術
    • 軟件測試論壇
    • 軟件測試沙龍
    • 軟件測試資料下載
    • 軟件測試雜志
    • 軟件測試人才招聘
      暫時沒有公告

    字號: | 推薦給好友 上一篇 | 下一篇

    軟件開發文檔編制的質量要求

    發布: 2008-2-03 12:25 | 作者: 51CTO  | 來源: 51CTO  | 查看: 149次 | 進入軟件測試論壇討論

    領測軟件測試網

     為了使軟件文檔能起到前節所提到的多種橋梁作用,使它有助于程序員編制程序,有助于管理人員監督和管理軟件開發,有助于用戶了解軟件的工作和應做的操作,有助于維護人員進行有效 的修改和擴充,文檔的編制必須保證一定的質量。質量差的軟件文檔不僅使讀者難于理解,給使用者造成許多不便,而且會削弱對 軟件的管理(管理人員難以確認和評價開發工作的進展),增高軟件的成本(一些工作可能被迫返工),甚至造成更加有害的后果 (如誤操作等)。  

      造成軟件文檔質量不高的原因可能是: 

      · 缺乏實踐經驗,缺乏評價文檔質量的標準。  

      · 不重視文檔編寫工作或是對文檔編寫工作的安排不恰當。  

      最常見到的情況是,軟件開發過程中不能按給出的進度, 分階段及時完成文檔的編制工作,而是在開發工作接近完成時集中人力和時間專門編寫文檔。另一方面,和程序工作相比,許多 人對編制文檔不感興趣。于是在程序工作完成以后,不得不應付一下,把要求提供的文檔趕寫出來。這樣的做法不可能得到高質量的文檔。實際上,要得到真正高質量的文檔并不容易,除去應在認識上對文檔工作給予足夠的重視外,常常需要經過編寫初稿,聽取意見進行修改,甚至要經過重新改寫的過程。 

      高質量的文檔應當體現在以下一些方面: 

     、籴槍π  

      文檔編制以前應分清讀者對象,按不同的類型、不同層次的讀者,決定怎樣適應他們的需要。例如,管理文檔主要是面 向管理人員的,用戶文檔主要是面向用戶的,這兩類文檔不應像開發 文檔(面向軟件開發人員)那樣過多地使用軟件的專業術語。 

     、诰_性  

      文檔的行文應當十分確切,不能出現多義性的描 述。同一課題若干文檔內容應該協調一致,應是沒矛盾的。 

     、矍逦  

      文檔編寫應力求簡明,如有可能,配以適當的圖 表,以增強其清晰性。 

     、芡暾  

      任何一個文檔都應當是完整的、獨立的,它應自成體系 。例如,前言部分應作一般性介紹,正文給出中心內容 ,必要時還有附錄,列出參考資料等。同一課題的幾個文檔之間可能 有些部分相同,這些重復是必要的。例如,同一項目的用戶手冊和操 作 
    冊中關于本項目功能、性能、實現環境等方面的描述是沒有差別 的。特別要避免在文檔中出現轉引其它文檔內容的情況。比如,一 
    些段落并未具體描述,而用"見××文檔××節"的方式,這將給 讀者帶來許多不便。 

     、蒽`活性  

      各個不同的軟件項目,其規模和復雜程度有著許 多實際差別,不能一律看待。圖6所列文檔是針對中等規模的軟件而言的。對于較小的或比較簡單的項目,可做適當調整或合 并。比如,可將用戶手冊和操作手冊合并成用戶操作手冊;軟件需求說明書可包括對數據的要求,從而去掉數據要求說明書;概要設 計說明書與詳細設計說明書合并成軟件設計說明書等。 

     、蘅勺匪菪  

      由于各開發階段編制的文檔與各階段完成的工作有著緊密的關系,前后兩個階段生成的文檔,隨著開發工作的逐步 擴展,具有一定的繼承關系。在一個項目各開發階段之間提供文檔 必定存在著可追溯的關系。例如,某一項軟件需求,必定在設計說明 書,測試計劃以至用戶手冊中有所體現。必要時應能做到跟蹤追查。

    延伸閱讀

    文章來源于領測軟件測試網 http://www.kjueaiud.com/

    TAG: 軟件開發 文檔編制 質量要求


    關于領測軟件測試網 | 領測軟件測試網合作伙伴 | 廣告服務 | 投稿指南 | 聯系我們 | 網站地圖 | 友情鏈接
    版權所有(C) 2003-2010 TestAge(領測軟件測試網)|領測國際科技(北京)有限公司|軟件測試工程師培訓網 All Rights Reserved
    北京市海淀區中關村南大街9號北京理工科技大廈1402室 京ICP備10010545號-5
    技術支持和業務聯系:info@testage.com.cn 電話:010-51297073

    軟件測試 | 領測國際ISTQBISTQB官網TMMiTMMi認證國際軟件測試工程師認證領測軟件測試網

    老湿亚洲永久精品ww47香蕉图片_日韩欧美中文字幕北美法律_国产AV永久无码天堂影院_久久婷婷综合色丁香五月

  • <ruby id="5koa6"></ruby>
    <ruby id="5koa6"><option id="5koa6"><thead id="5koa6"></thead></option></ruby>

    <progress id="5koa6"></progress>

  • <strong id="5koa6"></strong>