軟件文檔寫(xiě)作14-用戶文檔

第八章

軟件用戶文檔

用戶文檔是軟件開(kāi)發(fā)人員為軟件用戶了解、使用、操作和維護(hù)等提供的詳細(xì)資料。用戶文檔包括用戶手冊(cè)、操作手冊(cè)和維護(hù)修改建議等。8.1編制用戶文檔的基本要求1.描述規(guī)范準(zhǔn)確用戶文檔的閱讀對(duì)象通常是非計(jì)算機(jī)專業(yè)的人員，因此對(duì)用戶有很強(qiáng)的實(shí)用和指導(dǎo)意義。要求在描述內(nèi)容、說(shuō)明方法、提出見(jiàn)解時(shí)都應(yīng)準(zhǔn)確無(wú)誤，恰如其分。文檔需要反映哪些內(nèi)容、如何描述、口氣、分寸等，都應(yīng)與編制目的、使用對(duì)象協(xié)調(diào)一致。用詞應(yīng)標(biāo)準(zhǔn)、統(tǒng)一、規(guī)范。2.敘述簡(jiǎn)練生動(dòng)用戶文檔應(yīng)簡(jiǎn)潔、精煉，少用用戶難懂的專業(yè)術(shù)語(yǔ)，并力求形象生動(dòng)、圖文并茂，便于用戶學(xué)習(xí)、理解和掌握軟件的使用、操作。3.語(yǔ)言嚴(yán)密平實(shí)用戶文檔的價(jià)值在于科學(xué)性。文字表達(dá)必須合乎邏輯，才能有助于用戶使用、操作軟件。4.內(nèi)容系統(tǒng)完整用戶文檔作為軟件系統(tǒng)開(kāi)發(fā)者和用戶之間的界面，應(yīng)能提供給用戶關(guān)于軟件整體結(jié)構(gòu)、功能、安裝、運(yùn)行和操作的有關(guān)知識(shí)，并且用戶文檔的內(nèi)容組織應(yīng)該有系統(tǒng)性、層次性，使之成為軟件使用、操作的清晰的“交通圖”。18.2軟件常用表示形式軟件的表示方法為軟件系統(tǒng)建立一個(gè)基本構(gòu)架，對(duì)理解軟件，特別是對(duì)于軟件的維護(hù)，將是非常重要的。1.容器模型基于一個(gè)共享數(shù)據(jù)庫(kù)的系統(tǒng)模型一般稱為容器模型。如果系統(tǒng)的工作所使用的數(shù)據(jù)是圍繞共享數(shù)據(jù)庫(kù)進(jìn)行的，這可以考慮采用容器模型來(lái)表達(dá)其系統(tǒng)結(jié)構(gòu)。下圖是一種集成CASE工具集的體系結(jié)構(gòu)。設(shè)計(jì)編輯器代碼生成器設(shè)計(jì)分析器報(bào)告生成器程序編輯器設(shè)計(jì)轉(zhuǎn)換器項(xiàng)目存儲(chǔ)在上面的例子中，容器是被動(dòng)的，對(duì)它的控制是由其它子系統(tǒng)完成的。22.客戶機(jī)/服務(wù)器模型這個(gè)模型用于表示一個(gè)分布式系統(tǒng)，說(shuō)明數(shù)據(jù)和加工過(guò)程在多個(gè)處理器之間的分配。其例子如下圖所示。用戶用戶用戶用戶接口客戶進(jìn)程用戶接口客戶進(jìn)程用戶接口客戶進(jìn)程多媒體數(shù)據(jù)庫(kù)服務(wù)器及中間件圖像服務(wù)器視頻服務(wù)器聲音服務(wù)器文本服務(wù)器……圖像數(shù)據(jù)庫(kù)視頻數(shù)據(jù)庫(kù)聲音數(shù)據(jù)庫(kù)文本數(shù)據(jù)庫(kù)33.抽象機(jī)模型抽象機(jī)模型，也稱分層模型，常用來(lái)表示子系統(tǒng)的接口模型。將下圖組織成一系列的層次，每一層次定義一組服務(wù)。一個(gè)著名的例子是網(wǎng)絡(luò)協(xié)議OSI參考模型。

4.接口描述大型系統(tǒng)總是分解成獨(dú)立開(kāi)發(fā)的一些子系統(tǒng)。因此，在軟件描述中的一個(gè)必要成分就是定義子系統(tǒng)接口。接口的示意如下圖。子系統(tǒng)A子系統(tǒng)B4接口是一種抽象的概念，在面向?qū)ο蟮某绦蛟O(shè)計(jì)中，可以是一個(gè)類的公開(kāi)的數(shù)據(jù)成員或成員函數(shù)，也可以是若干個(gè)類抽象出的接口對(duì)象。接口抽象概念如圖所示。Class1-用于接口數(shù)據(jù)成員-其它數(shù)據(jù)成員Class2+用于接口的成員函數(shù)()+其它成員函數(shù)()Class3Class4《interface》接口對(duì)象Class5接口描述主要包括三方面信息：-類型名：即一組對(duì)象的名字-接口語(yǔ)法：定義接口操作的名字、參數(shù)個(gè)數(shù)、參數(shù)類型及操作結(jié)果類型-接口描述：對(duì)接口操作給出無(wú)二義的語(yǔ)法和語(yǔ)義解釋55.控制模型控制模型在體系結(jié)構(gòu)層次上描述子系統(tǒng)之間的控制流。有兩種表示形式：集中式控制和事件驅(qū)動(dòng)控制。

集中式控制模型中，由一個(gè)稱為系統(tǒng)控制器的子系統(tǒng)來(lái)負(fù)責(zé)管理其它子系統(tǒng)的執(zhí)行，模型工具子系統(tǒng)是順序執(zhí)行還是并發(fā)執(zhí)行，而分成調(diào)用-返回模型和管理者模型。下圖是一個(gè)調(diào)用-返回式集中控制模型的結(jié)構(gòu)示例：主程序程序1程序2程序3程序1.1程序1.2程序3.1程序3.26下圖是一種實(shí)時(shí)系統(tǒng)的管理者集中控制模型的結(jié)構(gòu)示例：故障處理器傳感器進(jìn)程傳動(dòng)裝置進(jìn)程計(jì)算進(jìn)程系統(tǒng)控制用戶界面在基于事件驅(qū)動(dòng)控制模型中，各個(gè)子系統(tǒng)都可以接受來(lái)自外部子系統(tǒng)的事件，并對(duì)此作出響應(yīng)。典型的有廣播型事件驅(qū)動(dòng)控制模型和中斷型控制模型。7廣播型事件驅(qū)動(dòng)控制模型的結(jié)構(gòu)示例如圖：子系統(tǒng)1子系統(tǒng)2子系統(tǒng)3子系統(tǒng)n…時(shí)間和消息處理器中斷驅(qū)動(dòng)型控制模型的結(jié)構(gòu)示例如圖：處理器1處理器2處理器3處理器4進(jìn)程1進(jìn)程2進(jìn)程3進(jìn)程4中斷向量86.數(shù)據(jù)流模型

數(shù)據(jù)流模型是描述系統(tǒng)數(shù)據(jù)處理的一種很直觀的方式。下圖是一個(gè)訂單處理的數(shù)據(jù)流圖。完成訂單表完成訂單表完成訂單表驗(yàn)證訂單記錄訂單訂單明細(xì)+空白訂單表訂單文件預(yù)算文件下圖是一個(gè)CASE工具集的數(shù)據(jù)流圖。設(shè)計(jì)編輯器設(shè)計(jì)交叉檢查器設(shè)計(jì)分析器報(bào)告生成器代碼框架生成器設(shè)計(jì)數(shù)據(jù)庫(kù)設(shè)計(jì)數(shù)據(jù)庫(kù)檢查過(guò)的設(shè)計(jì)引用的設(shè)計(jì)輸出代碼輸入設(shè)計(jì)有效設(shè)計(jì)設(shè)計(jì)分析用戶報(bào)告檢查過(guò)的設(shè)計(jì)97.狀態(tài)機(jī)模型

狀態(tài)機(jī)模型是一種描述系統(tǒng)對(duì)內(nèi)或外部事件響應(yīng)的行為模型，用來(lái)表示系統(tǒng)狀態(tài)和事件，以及事件引發(fā)系統(tǒng)在狀態(tài)之間的轉(zhuǎn)換。下圖是一個(gè)簡(jiǎn)單微波爐的狀態(tài)機(jī)模型示例。全功率Do:setpower=600等待Do:displaytime半功率Do:setpower=300設(shè)置時(shí)間Do:getnumberExit:settime屏蔽Do:display‘Waiting’激活Do:display‘ready’等待Do:displaytime操作Do:operateopen全功率半功率全功率半功率機(jī)時(shí)器機(jī)時(shí)器門(mén)開(kāi)門(mén)開(kāi)門(mén)關(guān)開(kāi)始取消系統(tǒng)出錯(cuò)數(shù)字108.數(shù)據(jù)模型

絕大多數(shù)的軟件系統(tǒng)都要使用數(shù)據(jù)庫(kù)，因此，系統(tǒng)建模的一項(xiàng)重要工作就是定義系統(tǒng)處理的邏輯結(jié)構(gòu)。數(shù)據(jù)模型就是要表達(dá)這樣的一個(gè)結(jié)構(gòu)。數(shù)據(jù)模型可以表示為一個(gè)有向圖，包含一系列不同類型的結(jié)點(diǎn)，結(jié)點(diǎn)之間的連線表示結(jié)點(diǎn)之間的關(guān)系，每個(gè)結(jié)點(diǎn)有結(jié)點(diǎn)標(biāo)示和若干屬性描述。下圖是一個(gè)由一組結(jié)點(diǎn)和一組關(guān)聯(lián)構(gòu)成的ERA數(shù)據(jù)模型，表是對(duì)應(yīng)的數(shù)據(jù)字典。設(shè)計(jì)NamedescriptionC-dateM-date標(biāo)簽Nametexticon鏈接Nametype鏈接Nametype有結(jié)點(diǎn)n1有標(biāo)簽11isan有鏈接有標(biāo)簽1nn1有鏈接12鏈接11ERA圖所對(duì)應(yīng)的數(shù)據(jù)字典名字描述類型日期has-labels在結(jié)點(diǎn)或關(guān)聯(lián)實(shí)體和類型標(biāo)簽實(shí)體間的1:n關(guān)系關(guān)系2005-12-30label存放結(jié)點(diǎn)或關(guān)聯(lián)的結(jié)構(gòu)化的或非結(jié)構(gòu)化的信息。標(biāo)簽由一個(gè)圖標(biāo)(可能是一個(gè)透明方塊)和相關(guān)的文本表示實(shí)體2005-12-30link表示設(shè)計(jì)實(shí)體的結(jié)點(diǎn)間的1:1關(guān)系，關(guān)聯(lián)具有類型和名字關(guān)系2005-12-30name(label)每個(gè)標(biāo)簽具有一個(gè)說(shuō)明類型的名字，該名字在設(shè)計(jì)中的標(biāo)簽類型必須唯一屬性2005-12-30name(node)每個(gè)結(jié)點(diǎn)名字在整個(gè)設(shè)計(jì)中必須唯一，名字可以長(zhǎng)達(dá)64個(gè)字符屬性2005-12-309.對(duì)象模型對(duì)象模型是一種映射真實(shí)世界中實(shí)體及對(duì)其操作的自然方法。對(duì)象模型既可以表達(dá)系統(tǒng)數(shù)據(jù)，又可以表達(dá)對(duì)數(shù)據(jù)的處理。因此，對(duì)象模型可以看作是數(shù)據(jù)流模型和數(shù)據(jù)模型的結(jié)合。下面的圖是用UML描述對(duì)象類的例子。圖中，每個(gè)矩形表示一個(gè)對(duì)象類，其中包括對(duì)象名字、對(duì)象類中的屬性、對(duì)象類的中操作。向上的空三角箭頭表示繼承。12-CataloguenumberAcquisitionCostType-Status-Numberofcopies+Acquire()+Catalogue()+Dispose()+Issue()+Return()-Author-Edition-Publicationdate-ISBN-Title-Publisher-Title-Medium-Year-Issue-Version-Platform-Director-Dateofrelease-Distributor圖書(shū)館系統(tǒng)的部分類層次13除了通過(guò)繼承來(lái)組織系統(tǒng)，對(duì)象類還可以由其它的對(duì)象組合而成，稱為對(duì)象成員。這種關(guān)系稱為對(duì)象的聚合，使用菱形表示聚合關(guān)系。如圖所示的是課程的聚合對(duì)象表示。課程CoursetitleNumberYearInstructor作業(yè)Credits幻燈片S