對文檔編制的質(zhì)量要求

對文檔編制的質(zhì)量要求SoftwareEngineering1、理解對文檔編制要求的概述2、掌握針對性,精確性和清晰性3、掌握完整性,靈活性和可塑造型01目錄文檔編制要求的概述02針對性,精確性和清晰性03完整性,靈活性和可塑造型對文檔編制要求的概述1對文檔編制要求的概述概述如果不重視文檔編寫工作，或是對文檔編寫工作的安排不當(dāng)，就不可能得到高質(zhì)量的文檔。質(zhì)量差的文檔不僅使讀者難于理解，給使用者造成許多不便，而且會削弱對軟件的管理(難以確認(rèn)和評價(jià)開發(fā)工作的進(jìn)展情況)，提高軟件成本(一些工作可能被迫返工)，甚至造成更加有害的后果(如誤操作等)。對文檔編制要求的概述020103050604針對性可追溯性靈活性精確性清晰性完整性六大特征特征針對性,精確性和清晰性2針對性,精確性和清晰性1.針對性文檔編制以前應(yīng)分清讀者對象，按不同的類型、不同層次的讀者，決定怎樣適應(yīng)他們的需要。例如，管理文檔主要是面向管理人員的，用戶文檔主要是面向用戶的，這兩類文檔不應(yīng)像開發(fā)文檔(面向軟件開發(fā)人員)那樣過多地使用軟件的專業(yè)術(shù)語。

針對性,精確性和清晰性2.精確性文檔的行文應(yīng)當(dāng)十分確切，不能出現(xiàn)多義性的描述。同一課題若干文檔內(nèi)容應(yīng)該協(xié)調(diào)一致，應(yīng)是沒矛盾的。

3.清晰性文檔編寫應(yīng)力求簡明，如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性。

完整性,靈活性和可塑造性3針對性,精確性和清晰性1.完整性任何一個(gè)文檔都應(yīng)當(dāng)是完整的、獨(dú)立的，它應(yīng)自成體系。例如，前言部分應(yīng)作一般性介紹，正文給出中心內(nèi)容，必要時(shí)還有附錄，列出參考資料等。同一課題的幾個(gè)文檔之間可能有些部分相同，這些重復(fù)是必要的。例如，同一項(xiàng)目的用戶手冊和操作冊中關(guān)于本項(xiàng)目功能、性能、實(shí)現(xiàn)環(huán)境等方面的描述是沒有差別的。特別要避免在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況。比如，一

些段落并未具體描述，而用"見××文檔××節(jié)"的方式，這將給讀者帶來許多不便。

針對性,精確性和清晰性1.靈活性各個(gè)不同的軟件項(xiàng)目，其規(guī)模和復(fù)雜程度有著許多實(shí)際差別，不能一律看待。圖6所列文檔是針對中等規(guī)模的軟件而言的。對于較小的或比較簡單的項(xiàng)目，可做適當(dāng)調(diào)整或合并。比如，可將用戶手冊和操作手冊合并成用戶操作手冊；軟件需求說明書可包括對數(shù)據(jù)的要求，從而去掉數(shù)據(jù)要求說明書；概要設(shè)計(jì)說明書與詳細(xì)設(shè)計(jì)說明書合并成軟件設(shè)計(jì)說明書等。

2.可塑造性由于各開發(fā)階段編制的文檔與各階段完成的工作有著緊密的關(guān)系，前后兩個(gè)階段生成的文檔，隨著開發(fā)工作的逐步擴(kuò)展，具有一定的繼承關(guān)系。在一個(gè)項(xiàng)目各開發(fā)階段之間提供文檔必定存在著可追溯的關(guān)系。例如，某一項(xiàng)軟件需求，必定在設(shè)計(jì)說明書，測試計(jì)劃以至用戶手冊中有所體現(xiàn)。必要時(shí)應(yīng)能做到跟