項(xiàng)目管理-研發(fā)項(xiàng)目用戶手冊(cè)模板

PAGE文檔編號(hào)：密級(jí)：TDCQ項(xiàng)目用戶手冊(cè)編寫(xiě)：校對(duì)：審核：批準(zhǔn)：日期：版本修訂記錄版本號(hào)簡(jiǎn)述修改原因修改人修改批準(zhǔn)人修改日期TDCQ中心PAGEII目錄1引言 -1-1.1編寫(xiě)目的 -1-1.2背景 -1-1.3定義 -1-1.4參考資料 -1-2用途 -1-2.1功能 -1-2.2性能 -2-2.2.1精度 -2-2.2.2時(shí)間特性 -2-2.2.3靈活性 -2-2.3安全保密 -2-3運(yùn)行環(huán)境 -2-3.1硬設(shè)備 -2-3.2支持軟件 -2-3.3數(shù)據(jù)結(jié)構(gòu) -3-4使用過(guò)程 -3-4.1安裝與初始化 -3-4.2輸入 -3-4.2.1輸入數(shù)據(jù)的現(xiàn)實(shí)背景 -3-4.2.2輸入格式 -4-4.2.3輸入舉例 -4-4.3輸出對(duì)每項(xiàng)輸出作出說(shuō)明 -4-4.3.1輸出數(shù)據(jù)的現(xiàn)實(shí)背景 -4-4.3.2輸出格式 -5-4.3.3輸出舉例 -5-4.4文卷查詢 -5-4.5出錯(cuò)處理和恢復(fù) -5-4.6終端操作 -56-用戶手冊(cè)1引言1.1編寫(xiě)目的說(shuō)明編寫(xiě)這份用戶手冊(cè)的目的，指出預(yù)期的讀者。標(biāo)題左對(duì)齊，標(biāo)題編號(hào)為1→1.1→1.1.1三級(jí)形式，一級(jí)標(biāo)題小二號(hào)黑體，二級(jí)標(biāo)題小三號(hào)黑體，三級(jí)標(biāo)題4號(hào)黑體，英文字符為T(mén)imeNewRoman，行間距為1.5倍；文內(nèi)標(biāo)題空2個(gè)字符，標(biāo)題編號(hào)為（1）→1）→①的形式，小四號(hào)宋體加粗，英文字符為T(mén)imeNewRoman，行間距為1.5倍；正文文字為小四號(hào)宋體，英文字符為T(mén)imeNewRoman，行間距為1.5倍；圖和表的編號(hào)為全文順序編號(hào)，圖號(hào)和圖題（例如圖1×××原理框圖）在圖的下方，表號(hào)和標(biāo)題（例如表1×××統(tǒng)計(jì)結(jié)果）在表的上方，圖表中的文字不超過(guò)正文文字大小，圖和表的量綱齊全；公式必須用Office自帶的公式編譯器3.0輸入，且符號(hào)字體為T(mén)imeNewRoman格式，公式居中，編號(hào)右對(duì)齊，編號(hào)采用全文順序編號(hào)；參考文獻(xiàn)按照標(biāo)準(zhǔn)參考文獻(xiàn)格式書(shū)寫(xiě)，例如期刊：作者1，作者2，作者3.文章題目[J].期刊名稱,出版年,卷(期):頁(yè)碼.書(shū)籍：作者1，作者2，作者3.書(shū)的名稱[M].出版地:出版社,出版年,頁(yè)碼.學(xué)位論文：作者.文章題目[D].出版地：出版學(xué)校，出版年,頁(yè)碼.會(huì)議論文：作者1，作者2，作者3.文章題目[C].會(huì)議名稱,會(huì)議地點(diǎn)，會(huì)議召開(kāi)月份，會(huì)議召開(kāi)年，頁(yè)碼.文檔書(shū)寫(xiě)后，將紅色字體刪除。1.2背景說(shuō)明：（1）這份用戶手冊(cè)所描述的軟件系統(tǒng)的名稱；（2）該軟件項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶（或首批用戶）及安裝此軟件的計(jì)算中心。1.3定義列出本文件中用到的專門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1.4參考資料列出有用的參考資料，如：項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)的批文；屬于本項(xiàng)目的其他已發(fā)表文件；本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件資料的來(lái)源。2用途2.1功能結(jié)合本軟件的開(kāi)發(fā)目的逐項(xiàng)地說(shuō)明本軟件所具有各項(xiàng)功能以及它們的極限范圍。2.2性能2.2.1精度逐項(xiàng)說(shuō)明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求。2.2.2時(shí)間特性定量地說(shuō)明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì)算時(shí)間等。2.2.3靈活性說(shuō)明本軟件所具有的靈活性，即當(dāng)用戶需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特性等的要求）有某些變化時(shí)，本軟件的適應(yīng)能力。2.3安全保密說(shuō)明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。3運(yùn)行環(huán)境3.1硬設(shè)備列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，如：（1）處理機(jī)的型號(hào)、內(nèi)存容量；（2）所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)／脫機(jī)；（3）I／O設(shè)備（聯(lián)機(jī)／脫機(jī)？）；（4）數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。3.2支持軟件說(shuō)明為運(yùn)行本軟件所需要的支持軟件，如：（1）操作系統(tǒng)的名稱、版本號(hào)；（2）程序語(yǔ)言的編譯／匯編系統(tǒng)的名稱和版本號(hào)；（3）數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱和版本號(hào)；（4）其他支持軟件。3.3數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)文卷。4使用過(guò)程在本章，首先用圖表的形式說(shuō)明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系。4.1安裝與初始化一步一步地說(shuō)明為使用本軟件而需進(jìn)行的安裝與初始化過(guò)程，包括程序的存儲(chǔ)形式、安裝與初始化過(guò)程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中所需用到的專用軟件。4.2輸入規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。4.2.1輸入數(shù)據(jù)的現(xiàn)實(shí)背景說(shuō)明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是（1）情況——例如人員變動(dòng)、庫(kù)存缺貨；（2）情況出現(xiàn)的頻度——例如是周期性的、隨機(jī)的、一項(xiàng)操作狀態(tài)的函數(shù)；（3）情況來(lái)源—一例如人事部門(mén)、倉(cāng)庫(kù)管理部門(mén)；（4）輸入媒體———例如鍵盤(pán)、穿孔卡片、磁帶；（5）限制——出于安全、保密考慮而對(duì)訪問(wèn)這些輸入數(shù)據(jù)所加的限制；（6）質(zhì)量管理——例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，如建立出錯(cuò)情況的記錄等；（7）支配——例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。4.2.2輸入格式說(shuō)明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語(yǔ)法規(guī)則和有關(guān)約定，如：（1）長(zhǎng)度—一例如字符數(shù)／行，字符數(shù)／項(xiàng)；（2）格式基準(zhǔn)——例如以左面的邊沿為基準(zhǔn)；（3）標(biāo)號(hào)——例如標(biāo)記或標(biāo)識(shí)符；（4）順序——例如各個(gè)數(shù)據(jù)項(xiàng)的次序及位置；（5）標(biāo)點(diǎn)——例如用來(lái)表示行、數(shù)據(jù)組等的開(kāi)始或結(jié)束而使用的空格、斜線、星號(hào)、字符組等。（6）詞匯表——給出允許使用的字符組合的列表，禁止使用＊的字符組合的列表等；（7）省略和重復(fù)——給出用來(lái)表示輸人元素可省略或重復(fù)的表示方式；（8）控制——給出用來(lái)表示輸入開(kāi)始或結(jié)束的控制信息。4.2.3輸入舉例為每個(gè)完整的輸入形式提供樣本，包括：（1）控制或首部——例如用來(lái)表示輸入的種類和類型的信息，標(biāo)識(shí)符輸入日期，正文起點(diǎn)和對(duì)所用編碼的規(guī)定；（2）主體——輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分；（3）尾部——用來(lái)表示輸入結(jié)束的控制信息，累計(jì)字符總數(shù)等；（4）省略——指出哪些輸入數(shù)據(jù)是可省略的；（5）重復(fù)——指出哪些輸入數(shù)據(jù)是重復(fù)的。4.3輸出對(duì)每項(xiàng)輸出作出說(shuō)明4.3.1輸出數(shù)據(jù)的現(xiàn)實(shí)背景說(shuō)明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：（1）使用——這些輸出數(shù)據(jù)是給誰(shuí)的，用來(lái)干什么；（2）使用頻度——例如每周的、定期的或備查閱的；（3）媒體——打印、CRI顯示、磁帶、卡片、磁盤(pán)，（4）質(zhì)量管理—一例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定；（5）支配——例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。4.3.2輸出格式給出對(duì)每一類輸出信息的解釋，主要是：（1）首部——如輸出數(shù)據(jù)的標(biāo)識(shí)符，輸出日期和輸出編號(hào)；（2）主體——輸出信息的主體，包括分欄標(biāo)題；（3）尾部——包括累計(jì)總數(shù)，結(jié)束標(biāo)記。4.3.3輸出舉例為每種輸出類型提供例子。對(duì)例子中的每一項(xiàng)，說(shuō)明：（1）定義——每項(xiàng)輸出信息的意義和用途；（2）來(lái)源——是從特定的輸入中抽出、從數(shù)據(jù)庫(kù)文卷中取出、或從軟件的計(jì)算過(guò)程中得到；（3）特性——輸出的值域、計(jì)量單位、在什么情況下可缺省等。4.