軟件文檔寫作14-用戶文檔

第八章

軟件用戶文檔

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

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

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

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

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

絕大多數(shù)的軟件系統(tǒng)都要使用數(shù)據(jù)庫，因此，系統(tǒng)建模的一項重要工作就是定義系統(tǒng)處理的邏輯結(jié)構(gòu)。數(shù)據(jù)模型就是要表達這樣的一個結(jié)構(gòu)。數(shù)據(jù)模型可以表示為一個有向圖，包含一系列不同類型的結(jié)點(jiédiǎn)，結(jié)點(jiédiǎn)之間的連線表示結(jié)點(jiédiǎn)之間的關(guān)系，每個結(jié)點(jiédiǎn)有結(jié)點(jiédiǎn)標示和若干屬性描述。下圖是一個由一組結(jié)點(jiédiǎn)和一組關(guān)聯(lián)構(gòu)成的ERA數(shù)據(jù)模型，表是對應的數(shù)據(jù)字典。設計NamedescriptionC-dateM-date標簽Nametexticon鏈接Nametype鏈接Nametype有結(jié)點n1有標簽11isan有鏈接有標簽1nn1有鏈接12鏈接11共十六頁ERA圖所對應(duìyìng)的數(shù)據(jù)字典名字描述類型日期has-labels在結(jié)點或關(guān)聯(lián)實體和類型標簽實體間的1:n關(guān)系關(guān)系2005-12-30label存放結(jié)點或關(guān)聯(lián)的結(jié)構(gòu)化的或非結(jié)構(gòu)化的信息。標簽由一個圖標(可能是一個透明方塊)和相關(guān)的文本表示實體2005-12-30link表示設計實體的結(jié)點間的1:1關(guān)系，關(guān)聯(lián)具有類型和名字關(guān)系2005-12-30name(label)每個標簽具有一個說明類型的名字，該名字在設計中的標簽類型必須唯一屬性2005-12-30name(node)每個結(jié)點名字在整個設計中必須唯一，名字可以長達64個字符屬性2005-12-309.對象模型對象模型是一種映射真實世界中實體及對其操作的自然方法。對象模型既可以表達系統(tǒng)數(shù)據(jù)，又可以表達對數(shù)據(jù)的處理。因此，對象模型可以看作是數(shù)據(jù)流模型和數(shù)據(jù)模型的結(jié)合。下面(xiàmian)的圖是用UML描述對象類的例子。圖中，每個矩形表示一個對象類，其中包括對象名字、對象類中的屬性、對象類的中操作。向上的空三角箭頭表示繼承。12共十六頁-CataloguenumberAcquisitionCostType-Status-Numberofcopies+Acquire()+Catalogue()+Dispose()+Issue()+Return()-Author-Edition-Publicationdate-ISBN-Title-Publisher-Title-Medium-Year-Issue-Version-Platform-Director-Dateofrelease-Distributor圖書館系統(tǒng)(xìtǒng)的部分類層次13共十六頁除了通過繼承來組織系統(tǒng)，對象類還可以由其它的對象組合而成，稱為對象成員(chéngyuán)。這種關(guān)系稱為對象的聚合，使用菱形表示聚合關(guān)系。如圖所示的是課程的聚合對象表示。課程CoursetitleNumberYearInstructor作業(yè)Credits幻燈片Slides課堂筆記Text錄像帶Tapeids練習ProblemsDescription解答TextDiagrams14共十六頁對象行為建模用序列圖來表示。如圖，描述一組對象上的一個序列圖，操作由帶標簽的箭頭指示，操作順序(shùnxù)是自上而下。讀者目錄圖書館項目服務器查找顯示發(fā)行發(fā)行許可接受許可打包交付電子科目的發(fā)放——對象(duìxiàng)行為建模15共十六頁內(nèi)容(nèiróng)總結(jié)