【經(jīng)管勵(lì)志】軟件工程文檔規(guī)范--前景文檔-資料下載頁(yè)
2025-04-23 03:57本頁(yè)面
【正文】 整個(gè)這一部分中，每一個(gè)特征都應(yīng)該是用戶、操作者或其他外部系統(tǒng)可以感知的。 特征＃ 1 特征＃ 2 6. 關(guān)鍵用例 描述一些關(guān)鍵用例，可以是對(duì)體系結(jié)構(gòu)有意義或最方便幫助讀者理解系統(tǒng)如何使用的用例。 7. 其他產(chǎn)品需求 可應(yīng)用標(biāo)準(zhǔn) 列出產(chǎn)品必須符合的標(biāo)準(zhǔn)，如法律和規(guī)章（ FDA、 FCC）、通信標(biāo)準(zhǔn)（ TCP/IP、 ISDN）、平臺(tái)兼容標(biāo)準(zhǔn)（ Windows、 UNIX）以及質(zhì)量和安全標(biāo)準(zhǔn)（ UL、 ISO、 CMM）。 系統(tǒng)需求 定義支持應(yīng)用所必須的所有系統(tǒng)需求。包括支持的主機(jī)操作系統(tǒng)、網(wǎng)絡(luò)平臺(tái)、配置、內(nèi)存、外設(shè)以及軟件。 許可和安裝 許可和安裝問(wèn)題對(duì)于開(kāi)發(fā)工作有直接影響。例如，支持序列號(hào)、口令安全或網(wǎng)絡(luò)許可證的需要必須創(chuàng)建其他開(kāi)發(fā)過(guò)程中必須考慮的附加的系統(tǒng)需注。安裝需求也會(huì)影響編碼或者產(chǎn)生開(kāi)發(fā)獨(dú)立安裝軟件的需求。 性能需求 性能問(wèn)題包括用戶負(fù)載因素、帶寬或通信能力、吞吐量、準(zhǔn)確度、可靠性或在某些負(fù)載條件下的響應(yīng)時(shí)間等。 8. 建檔需求 這一部分描述 所有支持成功地部署系統(tǒng)必須開(kāi)發(fā)的文檔 用戶手冊(cè) 描述用戶手冊(cè)的目的和內(nèi)容。討論其需要的長(zhǎng)度、詳盡程序、索引和詞匯表的需要、指南及參考手冊(cè)策略，等等。還要指定格式和打印約束。 在線幫助 許多應(yīng)用系統(tǒng)都提供一個(gè)在線的幫助系統(tǒng)來(lái)輔助用戶。這些系統(tǒng)的本質(zhì)是應(yīng)用系統(tǒng)開(kāi)發(fā)所特有的，因?yàn)樗鼈儼丫幊蹋ㄈ绯溄樱┖图夹g(shù)書(shū)寫(xiě)（如組織和表示）結(jié)合起來(lái)。許多人發(fā)現(xiàn)在在線幫助系統(tǒng)是項(xiàng)目中的項(xiàng)目，它從廣度管理和計(jì)劃活動(dòng)中直接受益。 安裝指南、配置和自述文件 對(duì)于一個(gè)全面的解決方案來(lái)說(shuō)，有 一個(gè)包括安裝指令和配置指南的文檔非常重要，而一個(gè)自述（ Read Me）文件也通常作為標(biāo)準(zhǔn)組件而存在。自述文件中可能包括一個(gè) “ 本版本的新增內(nèi)容 ” 部分以及一個(gè)與以前版本的兼容問(wèn)題的討論。許多用戶還希望在自述文件中說(shuō)明所有已知的錯(cuò)誤和變通方法。 標(biāo)記和打包 當(dāng)今最新的藝術(shù)化的應(yīng)用系統(tǒng)提供了一個(gè)從安裝菜單提示的產(chǎn)品打包和裝載清單、炫耀的屏幕、幫助系統(tǒng)、 GUI對(duì)話等開(kāi)始的一致的外觀和感覺(jué)。這一部分定義要集成到代碼中的標(biāo)記的類(lèi)型和需要。包括版本和專(zhuān)利說(shuō)明、公司商標(biāo)、標(biāo)準(zhǔn)化圖標(biāo)及其他圖形無(wú)素等。 9. 詞 匯表 詞匯表定義所有項(xiàng)目特有的術(shù)語(yǔ)。包括所有閱讀文檔的用戶或其他人無(wú)法理解的縮寫(xiě)和簡(jiǎn)寫(xiě)
規(guī)章制度相關(guān)推薦
鄂ICP備17016276號(hào)-1