設(shè)計(jì)說明書模板-上海工程技術(shù)大學(xué)

上海市計(jì)算機(jī)應(yīng)用能力大賽 設(shè)計(jì)說明書模板上海市計(jì)算機(jī)應(yīng)用能力大賽 設(shè)計(jì)說明書模板個(gè)人作品，未經(jīng)授權(quán)，不得外傳 第i個(gè)人作品，未經(jīng)授權(quán)，不得外傳 第i頁，共ii頁XXXX一設(shè)計(jì)說明書參賽編號(hào)：2017001參賽學(xué)校：XXXX參賽成員：XXXXXXXXXXXXX年XX月XX日上海市計(jì)算機(jī)應(yīng)用能力大賽 設(shè)計(jì)說明書模板上海市計(jì)算機(jī)應(yīng)用能力大賽 設(shè)計(jì)說明書模板個(gè)人作品，未經(jīng)授權(quán)，不得外傳 第頁，共11頁TOC\o"1-5"\h\z\o"CurrentDocument"簡介 3\o"CurrentDocument"作品創(chuàng)意/項(xiàng)目背景 3\o"CurrentDocument"項(xiàng)目實(shí)施計(jì)劃 3\o"CurrentDocument"總體設(shè)計(jì) 4\o"CurrentDocument"系統(tǒng)功能 4\o"CurrentDocument"功能概述 4\o"CurrentDocument"功能說明 4系統(tǒng)軟硬件平臺(tái) 4\o"CurrentDocument"系統(tǒng)開發(fā)平臺(tái)（含開源/第三方工具） 4\o"CurrentDocument"系統(tǒng)運(yùn)行平臺(tái) 5\o"CurrentDocument"關(guān)鍵技術(shù) 5\o"CurrentDocument"作品特色 5詳細(xì)設(shè)計(jì)說明 6系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 6技術(shù)架構(gòu) 6\o"CurrentDocument"功能模塊設(shè)計(jì) 6\o"CurrentDocument"關(guān)鍵功能/算法設(shè)計(jì) 6\o"CurrentDocument"數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 6\o"CurrentDocument"存儲(chǔ)數(shù)據(jù) 66儲(chǔ) 7\o"CurrentDocument"接口（模塊接口、系統(tǒng)間接口） 7\o"CurrentDocument"關(guān)鍵數(shù)據(jù)結(jié)構(gòu) 7系統(tǒng)界面設(shè)計(jì) 7界面設(shè)計(jì)風(fēng)格 7\o"CurrentDocument"主要功能頁面 7\o"CurrentDocument"Web網(wǎng)站頁面結(jié)構(gòu)設(shè)計(jì) 7\o"CurrentDocument"系統(tǒng)安裝及使用說明 9\o"CurrentDocument"總結(jié) 10\o"CurrentDocument"附錄 11\o"CurrentDocument"名詞定義 11\o"CurrentDocument"參考資料 11\o"CurrentDocument"源代碼清單 111簡介作品創(chuàng)意/項(xiàng)目背景【介紹本作品的創(chuàng)意來源，產(chǎn)生背景，作品的主要功能，成果的應(yīng)用目標(biāo)等。項(xiàng)目實(shí)施計(jì)劃【介紹作品創(chuàng)作過程中的人員分工、設(shè)計(jì)制作進(jìn)度安排等。 】2總體設(shè)計(jì)【本章對(duì)系統(tǒng)實(shí)現(xiàn)的功能、開發(fā)技術(shù)和應(yīng)用環(huán)境進(jìn)行介紹。系統(tǒng)功能功能概述【概述系統(tǒng)實(shí)現(xiàn)的主要功能，包括系統(tǒng)性能。需給出系統(tǒng)功能的框架結(jié)構(gòu)圖，樣例如圖示?！繄D1系統(tǒng)功能框架圖功能說明【對(duì)系統(tǒng)功能分層逐一詳細(xì)說明。注意此處給出的是從用戶角度看到的功能。系統(tǒng)軟硬件平臺(tái)系統(tǒng)開發(fā)平臺(tái)（含開源/第三方工具）【介紹系統(tǒng)開發(fā)所使用的軟件和硬件環(huán)境，包括所用到的開源平臺(tái)、第三方工具。給出使用操作系統(tǒng)的名稱、生產(chǎn)廠家、版本號(hào)等。給出所用開源平臺(tái)的官方網(wǎng)站、版本，該平臺(tái)提供的功能。如關(guān)鍵算法的實(shí)現(xiàn)或部分實(shí)現(xiàn)調(diào)用了第三方工具或源代碼，請(qǐng)標(biāo)出其出處，寫明已實(shí)現(xiàn)的功能。給出使用數(shù)據(jù)庫的名稱、生產(chǎn)廠家、版本號(hào)等。如使用了多種數(shù)據(jù)庫，則要說明如何實(shí)現(xiàn)相互之間的關(guān)聯(lián)。給出使用的硬件設(shè)備，型號(hào)、生產(chǎn)廠家等?！肯到y(tǒng)運(yùn)行平臺(tái)【介紹系統(tǒng)運(yùn)行時(shí)需要的軟件和硬件環(huán)境。指明系統(tǒng)是集中式還是分布式的，說明設(shè)備的部署要求。提供系統(tǒng)通信網(wǎng)絡(luò)的詳細(xì)描述 ，表示系統(tǒng)組件是如何連接的。說明每臺(tái)硬件設(shè)備上部署的系統(tǒng)軟件，包括版本要求】 。關(guān)鍵技術(shù)【介紹作品完成所用到的各項(xiàng)關(guān)鍵技術(shù)，包括開發(fā)技術(shù)和理論技術(shù)。作品特色【重點(diǎn)介紹本作品在創(chuàng)意、開發(fā)實(shí)現(xiàn)、應(yīng)用等方面的亮點(diǎn)，有特色的功能，團(tuán)隊(duì)重點(diǎn)解決的問題等。】3詳細(xì)設(shè)計(jì)【對(duì)系統(tǒng)或子系統(tǒng)實(shí)現(xiàn)方法進(jìn)行詳細(xì)說明。 】系統(tǒng)結(jié)構(gòu)設(shè)計(jì)技術(shù)架構(gòu)【說明系統(tǒng)實(shí)現(xiàn)采用的關(guān)鍵技術(shù)， B/S、C/S平臺(tái)和移動(dòng)平臺(tái)，說明選用該技術(shù)的原因。使用的關(guān)鍵開發(fā)技術(shù)框架說明?！抗δ苣K設(shè)計(jì)【給出系統(tǒng)開發(fā)的功能模塊結(jié)構(gòu)圖， 并說明系統(tǒng)按照什么原理進(jìn)行劃分， 系統(tǒng)將由哪些部分,或?qū)哟谓M成。用圖的形式將各個(gè)模塊之間的調(diào)用關(guān)系說明清楚。如果采用面向過程的開發(fā)技術(shù)，給出主要的函數(shù)結(jié)構(gòu)和調(diào)用關(guān)系圖；如果采用面向?qū)ο蟮姆椒ㄟM(jìn)行設(shè)計(jì)，模塊調(diào)用關(guān)系圖相當(dāng)于包(package)圖?！筷P(guān)鍵功能/算法設(shè)計(jì)【給出系統(tǒng)關(guān)鍵功能的實(shí)現(xiàn)流程圖或算法設(shè)計(jì)流程圖，功能優(yōu)化的技巧等。數(shù)據(jù)庫系統(tǒng)如使用了存儲(chǔ)過程也應(yīng)在此進(jìn)行介紹。注：此小節(jié)為可選單元，“程序設(shè)計(jì)應(yīng)用類”項(xiàng)目必寫?！繑?shù)據(jù)結(jié)構(gòu)設(shè)計(jì)【一般而言數(shù)據(jù)分為存儲(chǔ)數(shù)據(jù)，交換數(shù)據(jù)及內(nèi)部邏輯數(shù)據(jù)，而前兩類數(shù)據(jù)是系統(tǒng)和外部系統(tǒng)之間，以及系統(tǒng)內(nèi)部模塊間交換用的， 內(nèi)部邏輯數(shù)據(jù)是模塊內(nèi)為了實(shí)現(xiàn)一定的邏輯功能而設(shè)計(jì)的。存儲(chǔ)數(shù)據(jù)【存儲(chǔ)數(shù)據(jù)是指系統(tǒng)產(chǎn)生的需長期存放在存儲(chǔ)介質(zhì)上的數(shù)據(jù)，一般系統(tǒng)都將重要數(shù)據(jù)存放在存儲(chǔ)介質(zhì)上，且存放在存儲(chǔ)介質(zhì)上的數(shù)據(jù)往往其他系統(tǒng)也可以訪問到。根據(jù)存儲(chǔ)方式的不同又可以分為數(shù)據(jù)庫和文件等方式。 】.數(shù)據(jù)庫【使用Visio或直接使用數(shù)據(jù)庫管理系統(tǒng)建立系統(tǒng)數(shù)據(jù)庫的數(shù)據(jù)對(duì)象模型。畫出建立的邏輯數(shù)據(jù)模型 E-R圖，給出數(shù)據(jù)字典，即列表說明數(shù)據(jù)庫中每個(gè)表及視圖的字段、主鍵、外鍵、約束和索引等，如表1所示。注：此小節(jié)為可選單元，“數(shù)據(jù)庫應(yīng)用系統(tǒng)類”項(xiàng)目必寫?！勘?圖書信息表數(shù)據(jù)表名：BookInfo 中文描述：圖書信息表字段名稱字段描述數(shù)據(jù)類型長度是否允許空缺省值備注BooklSBN圖書出版號(hào)varchar20NNULL主鍵BookName書名varchar50NNULL索引Publish出版社varchar50YNULLAuthorName作者名varchar30YNULLPrice圖書價(jià)格float8N0.0.文件存儲(chǔ)【如果存儲(chǔ)方式為文件，應(yīng)給出文件的路徑及讀取方式，完整清楚地說明文件的命名規(guī)則。對(duì)存放在文件中的數(shù)據(jù)格式和含義應(yīng)進(jìn)行說明。注：此小節(jié)為可選單元，根據(jù)項(xiàng)目實(shí)現(xiàn)所選用的數(shù)據(jù)存儲(chǔ)方式選擇編寫。 】接口（模塊接口、系統(tǒng)間接口）【包含系統(tǒng)間或者模塊間用來交換信息用的數(shù)據(jù)，它是系統(tǒng)接口或者模塊接口的一部分，是系統(tǒng)間或者模塊間交換信息的橋梁。交換數(shù)據(jù)方式也可以分為共享數(shù)據(jù)（共享文件，共享內(nèi)存等）、通訊協(xié)議、參數(shù)傳遞、拋異常等方式。無論采用何種方式必須詳細(xì)說明數(shù)據(jù)（協(xié)議）的格式及含義。注：此小節(jié)為可選單元，沒有使用交換數(shù)據(jù)的項(xiàng)目不必編寫。 】關(guān)鍵數(shù)據(jù)結(jié)構(gòu)【指關(guān)鍵信息在內(nèi)存中的數(shù)據(jù)存儲(chǔ)結(jié)構(gòu)。如果采用面向?qū)ο蟮某绦蛟O(shè)計(jì)，這里應(yīng)該給出就是概念數(shù)據(jù)模型（即類圖）。注：此小節(jié)為可選單元，“程序設(shè)計(jì)應(yīng)用類”項(xiàng)目必寫?！?.3系統(tǒng)界面設(shè)計(jì)界面設(shè)計(jì)風(fēng)格【給出主頁面的視圖。闡述頁面的布局，頁面的圖標(biāo)設(shè)計(jì)及其功能說明、圖像風(fēng)格等。主要功能頁面【介紹主要功能頁面，并簡要介紹這些頁面的設(shè)計(jì)特色、操作方法。 】Web網(wǎng)站頁面結(jié)構(gòu)設(shè)計(jì)【介紹Web網(wǎng)站的頁面導(dǎo)航，給出Web網(wǎng)站的頁面關(guān)系圖，如圖2所示?！孔ⅲ捍诵」?jié)為可選單元，“Web網(wǎng)站設(shè)計(jì)”項(xiàng)目必寫?！?/p>

圖2Web網(wǎng)站頁面結(jié)構(gòu)圖4系統(tǒng)安裝及使用說明5總結(jié)【對(duì)作品的創(chuàng)意、開發(fā)實(shí)現(xiàn)過程進(jìn)行總結(jié)，給出作品的改進(jìn)方向。6附錄名詞定義【列出本文檔中用到的可能會(huì)引起混淆的專業(yè)術(shù)語、定義或縮寫的原文。名詞/縮寫說明參考資料【列出設(shè)計(jì)說明書中引用的文獻(xiàn)或資料，資料的作者、標(biāo)題、出版單位和出版日期等信息，樣例如下?！縖1]計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南 .中華人民共和國國家標(biāo)準(zhǔn) GB8567-88.國家標(biāo)準(zhǔn)局，1988年1月7日.[2]謝希仁.計(jì)算機(jī)網(wǎng)絡(luò)(第四版).大連理工大學(xué)出版社，2006.8.[3]嚴(yán)霄鳳，高熾揚(yáng).美國聯(lián)邦信息安全風(fēng)險(xiǎn)管理框架及其相關(guān)標(biāo)準(zhǔn)研究 .信息安全與