软工文档简介
軟工文檔簡介
一、???軟工文檔的概念
? ? ? ? ? 文檔是指:是指某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。
? ? ? ? ? 軟件工程文檔就是表示對(duì)活動(dòng)、需求、過程或結(jié)果進(jìn)行描述、定義、規(guī)定、報(bào)告或認(rèn)證的任何書面或圖示的信息。
二、???軟工文檔的作用
? ? ? ? ? 軟件開發(fā)文檔是軟件開發(fā)使用和維護(hù)過程中的必備資料。它能提高軟件開發(fā)的效率,保證軟件的質(zhì)量,而且在軟件的使用過程中有指導(dǎo),幫助,解惑的作用,尤其在維護(hù)工作中,文檔是不可或缺的資料。
三、???軟工文檔的分類
? ? ? ? ? 按照文檔產(chǎn)生和使用的范圍,軟件文檔大致可以分為三類,開發(fā)文檔、用戶文檔,管理文檔。
四、???軟工文檔開發(fā)的質(zhì)量要求
? ? ? ? ? 軟件工程文檔在開發(fā)的過程中的要求,包括了五個(gè)主要的方面,針對(duì)性,精確性,清晰性,完整性,靈活性。
? ? ? ? ? 針對(duì)性:文檔編制以前應(yīng)分清讀者對(duì)象。按不同的類型、不同層次的讀者,決定怎樣適應(yīng)他們的需要。
? ? ? ? ? 精確性:文檔的行文應(yīng)當(dāng)十分確切,不能出現(xiàn)多義性的描述,同一課題幾個(gè)文檔的內(nèi)容應(yīng)當(dāng)是協(xié)調(diào)一致,沒有矛盾的。
? ? ? ? ? 清晰性:文檔編寫應(yīng)力求簡明,如有可能,配以適當(dāng)?shù)膱D表,以增強(qiáng)其清晰性。
? ? ? ? ? 完整性:任何一個(gè)文檔都應(yīng)當(dāng)是完整的、獨(dú)立的,它應(yīng)自成體系,不要在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況。
? ? ? ? ? 靈活性:各個(gè)不同軟件項(xiàng)目,其規(guī)模和復(fù)雜程度有著許多實(shí)際差別,不能一律看待,應(yīng)根據(jù)具體的軟件開發(fā)項(xiàng)目,決定編制的文檔種類。
總結(jié)