客戶端操作指南寫作模板

1、客戶端操作指南2005-9-8產(chǎn)品線業(yè)務(wù)與軟件產(chǎn)品線密級話音域機(jī)密共22頁客戶端操作指南寫作模板擬制日期2005-9-8評審人項目組成員日期批準(zhǔn)日期簽發(fā)日期HUAWEI華為技術(shù)有限公司?2005華為技術(shù)有限公司版權(quán)所有，保留一切權(quán)利（僅供內(nèi)部使用）修訂記錄日期修訂版本修改早下修改描述作者2005-09-09試用稿初稿完成楊健客戶端操作指南0關(guān)于本手冊2-1第3章業(yè)務(wù)數(shù)據(jù)操作3-1關(guān)于本手冊第1章快速入門（可選）2-11.1 了解PPC_SMAP.2-11.1.1 PPC業(yè)務(wù)定義2-11.1.2 PPC_SMAP的主要功能2-21.2 PPC_SMA噂作基礎(chǔ)2-21.2.1 登錄PPC_SMAP

2、2-21.2.2 PPC_SMAP界面簡介2-31.2.3 注銷2-72-1第2章系統(tǒng)操作2.1 更改密碼2-12.2 查看日志2-22.3 2-42-13.1 PPS業(yè)務(wù)數(shù)據(jù)操作3-13.1.1 PPS業(yè)務(wù)用戶數(shù)據(jù)操作3-13.1.2 手工充值3-13.2 3-13.2.1 3-13-1附錄A參數(shù)匯總3.3 系統(tǒng)（對應(yīng)菜單名稱）3-23.3.1 修改密碼3-23.3.2 查詢?nèi)罩?-23.4 業(yè)務(wù)數(shù)據(jù)3-23.4.1 開放地區(qū)區(qū)號設(shè)置（對應(yīng)窗口名稱）3-23.4.2 3-33-13-1附錄B錯誤信息說明附錄C縮略語表寫作總指導(dǎo)寫作側(cè)重點(diǎn)定位作為客戶端使用者的參考書，提供所有客戶端界面信息。特

3、點(diǎn)同業(yè)務(wù)操作手冊相比，本手冊有以下特點(diǎn)：基于客戶端界面組織，不關(guān)注任務(wù)；需要詳細(xì)說明界面上的各個元素，包括參數(shù)說明。特別聲明客戶端使用指南通常以聯(lián)機(jī)幫助的形式提供。寫作難點(diǎn)/注意事項參數(shù)說明信息需要完整、詳細(xì)，具有指導(dǎo)意義。關(guān)于本手冊模板寫作模板采用資料部統(tǒng)一的aboutthismanual如果資料部未統(tǒng)一推行該部分，刪除本節(jié)。客戶端操作指南第1章快速入門（可選）第1章快速入門（可選）本章屬于可選寫作內(nèi)容，由作者根據(jù)實際情況選擇寫作。本章的介紹業(yè)務(wù)的基本定。讀者閱讀本章后應(yīng)該了解業(yè)務(wù)的核心特征。引言簡要說明本章的主要內(nèi)容，反映本章的寫作目的。讀者閱讀該概述后，應(yīng)該明確是否還需要繼續(xù)閱讀本章的內(nèi)

4、容。需要特別注意或聲明的內(nèi)容可酌情寫在此處?！緲永勘菊率紫冉榻B了PPC_SMA的功能，然后詳細(xì)介紹PPC_SMA的界面以及登錄注銷方法。通過閱讀本章，您可以快速掌握操作PPC_SMA需要了解的基本信息。1.1 了解PPC_SMAP這里簡單說明客戶端和業(yè)務(wù)的關(guān)系?！緲永縋PC_SMAPPPCE務(wù)的核心管理工具，您可以通過該終端管理所有PPCE務(wù)的業(yè)務(wù)數(shù)據(jù)。下面首先介紹什么是PPCE務(wù)，然后詳細(xì)介紹PPC_SMAP主要功能。1.1.1 PPClk務(wù)定義本節(jié)給出業(yè)務(wù)的詳細(xì)定義，重點(diǎn)說明業(yè)務(wù)的核心特征。本節(jié)的介紹要求通俗易懂，少用專業(yè)詞匯。盡量采用類比、舉例等方式，避免突然引入太多的新概念?！緲永?/p>

5、】PPS業(yè)務(wù)是基于CDMAcodedivisionmultipleaccess）網(wǎng)絡(luò)或者GSMglobalsystemformobilecommunication）網(wǎng)絡(luò)的一種智能業(yè)務(wù)。同傳統(tǒng)的移動網(wǎng)絡(luò)用戶相比，PPS用戶需要預(yù)先繳納一定的費(fèi)用才可以發(fā)起呼叫或者使用其它的業(yè)務(wù)特性。每次呼叫結(jié)束時，系統(tǒng)會從PPS用戶預(yù)先繳納的費(fèi)用扣除通話費(fèi)用。1.1.2 PPC_SMA®主要功能這里應(yīng)該給出PPC_SMAP能的概要介紹。描述盡量概要簡短，從用戶應(yīng)用角度適當(dāng)提煉，不應(yīng)該僅僅是菜單的羅列。例如：分為系統(tǒng)管理（操作員權(quán)限管理等）、業(yè)務(wù)受理（enduser需求的處理）和數(shù)據(jù)統(tǒng)計（報表等）?！緲永?/p>

6、】PPC_SMA赴PPC業(yè)務(wù)的業(yè)務(wù)數(shù)據(jù)管理終端。您可以通過該終端維護(hù)PPC用戶的業(yè)務(wù)數(shù)據(jù)，受理各種PPC業(yè)務(wù)請求。PPC業(yè)務(wù)的主要功能包括：系統(tǒng)管理業(yè)務(wù)受理數(shù)據(jù)統(tǒng)計1.2 PPC_SMAP作基礎(chǔ)1.2.1 登錄PPC_SMAP本節(jié)以stepbystep的方式介紹客戶端的登錄方法?！緲永?DoubleclickthePPC_SMAPshortcuticonMonthedesktop.登錄對話框出現(xiàn)，如圖所示。2Entertheoperatorsusernameandpassword.ThedefaultusernameandpasswordareeppcadmandTELLIN3ClickOK

7、.PPC_SMAP系統(tǒng)管理窗口出現(xiàn)，如圖所示4 Select Service Data > EPPC Service .-|n|x|PPC_SMAPservicemanagementwindow出現(xiàn)，如圖所示HuaweiInlelligenl:NetworkSWAP-EPPC5i)slemSSeMCeTFiesourceE.RepoilPHelpHRgdy1.2.2 PPC_SM曲面簡介簡要介紹管理界面的結(jié)構(gòu)、菜單、快捷按鈕等。如果系統(tǒng)提供管理權(quán)限控制功能,需要介紹界面操作同操作員權(quán)限的關(guān)系。對于首次使用客戶端的用戶可以通過該部分介紹熟悉界面，了解系統(tǒng)功能。對于比較熟悉客戶端的用戶可以參

8、考這部分內(nèi)容迅速查找到任務(wù)的入口。【樣例】EPPC_SMA的界面由菜單、工具條和操作區(qū)三個部分組成，如圖1-1所示。圖1-1EPPC_SMA的作界面各個部分的詳細(xì)說明如下:菜單這里需要詳細(xì)說明菜單結(jié)構(gòu)、功能及權(quán)限。如果不涉及權(quán)限問題，可以刪除權(quán)限一列?！緲永?】菜單結(jié)構(gòu)說明權(quán)限系統(tǒng)密碼更改選擇該菜單修改自己的密碼。系統(tǒng)管理員日志瀏覽選擇該菜單查看日常的操作日志。系統(tǒng)管理員返回主界面選擇該菜單注銷，進(jìn)入登錄界面。操作員業(yè)務(wù)數(shù)據(jù)PPS用戶數(shù)據(jù)管理PPS業(yè)務(wù)用戶數(shù)據(jù)手工充值用戶掛失【樣例2】工具條這里要詳細(xì)介紹工具條每個圖標(biāo)的功能?！緲永繄D標(biāo)名稱功能富|用戶數(shù)據(jù)查詢查詢PPS用戶的數(shù)據(jù)受1手工充值

9、操作員對用戶的帳戶進(jìn)行手工充值©掛失掛失PPS用戶的儲值卡圖標(biāo)名稱功能©J解掛失解掛失用戶的儲值卡，使其用戶狀態(tài)返回掛失前的狀態(tài)到激活激活PPS用戶數(shù)據(jù)X1去激活去激活PPS用戶數(shù)據(jù)包批量開戶進(jìn)行批量開戶操作批量銷戶進(jìn)行批量銷戶操作關(guān)于SMAP查看SMAP的版本、版權(quán)信息返回主界面退出PPS業(yè)務(wù)的操作界面，返回SMAP平臺界面操作區(qū)這里需要給出典型的操作界面以及按鈕說明【樣例】選擇某一菜單后，操作區(qū)會顯示對應(yīng)的數(shù)據(jù)管理對話框，供您管理業(yè)務(wù)數(shù)據(jù)。圖1-2給出了典型的PPS_SMA臊作界面。圖1-2PPS_SMA典型操作界面圖1-2中各個按鈕的說明如表1-1所示。表1-1典型按

10、鈕說明按鈕功能條件執(zhí)行查詢操作前，您需要單擊條件,按鈕，然后才可以輸入查詢條件。查詢輸入查詢條件后，單擊查詢,按鈕，可以查詢到符合要求的信息。插入1.2.3注銷2-7本節(jié)以stepbystep的方式介紹客戶端的注銷方法【樣例】1確認(rèn)光標(biāo)停留在PPC_SMAP業(yè)務(wù)managementwindow.on the toolbar.SelectSystem>Return或者ClickPPC_SMAPsystemmanagementwindow出現(xiàn)。on the toolbar.SelectSystem>Exit.或者ClickAdialogboxwillappear,saying"

11、;AreyousuretostoprunningtheSMAP?"ClickYes.客戶端操作指南第2章系統(tǒng)操作第2章系統(tǒng)操作按照菜單結(jié)構(gòu)介紹各個界面的操作，目錄結(jié)構(gòu)和導(dǎo)航樹對應(yīng)。導(dǎo)航樹上的每個根節(jié)點(diǎn)對應(yīng)一章，然后依次向下安排二級標(biāo)題和三級標(biāo)題。引言簡要說明本章的主要內(nèi)容，反映本章的寫作目的。讀者閱讀該概述后，應(yīng)該明確是否還需要繼續(xù)閱讀本章的內(nèi)容。需要特別注意或聲明的內(nèi)容可酌情寫在此處?！緲永勘菊略敿?xì)介紹system菜單下所有各個子菜單的功能。通過閱讀本章，您可以了解到System類界面操作的詳細(xì)說明。2.1 更改密碼1 .操作說明2 .操作前提（可選）3 .操作步驟（可選）4 .

12、參數(shù)說明/界面元素說明5 .相關(guān)主題（可選）2.2 查看日志1 .操作說明用戶閱讀操作說明后，可以明確是否執(zhí)行該操作。操作說明可以包括但不限于以下內(nèi)容。什么情況下執(zhí)行該操作可以采用說明操作目的、意義的方式提供該類信息。執(zhí)行結(jié)果操作執(zhí)行結(jié)果、執(zhí)行后的狀態(tài)等說明信息。不可逆轉(zhuǎn)或危險性操作要給出警告說明【樣例】當(dāng)用戶提出不再使用PPS業(yè)務(wù)時，可以為用戶銷戶。銷戶成功后，用戶的業(yè)務(wù)數(shù)據(jù)將被刪除，用戶將不能再使用PPS業(yè)務(wù)。在思用戶銷戶后，所有用戶數(shù)據(jù)將被刪除，無法再恢復(fù)。2 .操作前提（可選）用戶閱讀操作前提后，應(yīng)該明確自己是否可以執(zhí)行任務(wù)。操作前提可以包括但不限于以下內(nèi)容。操作權(quán)限要求例如，只有超級

13、管理員才可以清除黑名單。也可以包括技能要求，并給出參考信息的位置。前置任務(wù)/執(zhí)行環(huán)境要求例如，完成操作系統(tǒng)安裝后才能安裝數(shù)據(jù)庫。存在前置任務(wù)時，可以給出參考路徑?！緲永刻幱谡Ｊ褂脿顟B(tài)的用戶才可以銷戶；處于欠費(fèi)停機(jī)狀態(tài)的用戶需要恢復(fù)至正常狀態(tài)才能銷戶。停機(jī)狀態(tài)用戶恢復(fù)至正常態(tài)的方法請參見“2.5復(fù)機(jī)”。3 .操作步驟（可選）如果操作界面較為簡單，基本不涉及操作步驟，可以不提供本部分內(nèi)容。此時，參數(shù)說明部分?jǐn)U展為界面元素說明。對步驟的說明應(yīng)該簡單，采用動賓結(jié)構(gòu)的語句，基本風(fēng)格參考樣例。如果采用聯(lián)機(jī)幫助的形式提供本指南，需要注意以下兩點(diǎn)：無需提供操作界面截圖同一頁面中如果存在多個子操作任務(wù)，使用

14、折疊形式并列提供。例如：“增加用戶數(shù)據(jù)”和“查詢用戶數(shù)據(jù)”的詳細(xì)步驟作為“用戶管理數(shù)據(jù)”頁面中的兩個折疊?！緲永窟x擇業(yè)務(wù)管理/業(yè)務(wù)用戶數(shù)據(jù)管理菜單項，進(jìn)入業(yè)務(wù)數(shù)據(jù)管理頁面。這里插入操作界面截圖。在該頁面中，您可以執(zhí)行以下操作：查詢用戶信息1在“電話號碼”文本框中輸入12345678。這里插入操作界面截圖2單擊查詢,按鈕。增加用戶信息1單擊增加,按鈕。2填寫用戶信息。這里插入操作界面截圖3 單擊保存按鈕。4 .參數(shù)說明/界面元素說明在沒有提供操作步驟一節(jié)內(nèi)容時，本節(jié)提供當(dāng)前界面所有元素的說明，包括參數(shù)和按鈕等用戶可操作控件的說明。提供這些說明的同時需要提供界面供用戶參考。在提供操作步驟一節(jié)內(nèi)容

15、時，本節(jié)提供當(dāng)前界面上所有參數(shù)的詳細(xì)說明。參數(shù)描述次序依據(jù)界面排列情況決定，一般遵循如下原則：(1) 從左到右(2) 從上到下參數(shù)描述的詳細(xì)要求參見參考-03-07-參數(shù)描述寫作模板。如果以聯(lián)機(jī)幫助形式提供本指南，參數(shù)說明使用單獨(dú)的頁面提供。操作說明界面提供到該頁面的鏈接。(5) 關(guān)主題(可選)本節(jié)介紹當(dāng)前操作相關(guān)的一些信息，包括但不限于：背景知識執(zhí)行任務(wù)需要掌握的原理或概念。可以說明，也可以提供信息的參考路徑。操作結(jié)果可以供當(dāng)前操作參考的操作例如，“查詢帳號信息”作為“開戶”相關(guān)主題；因為操作員可能需要了解一下還有那些空閑帳號。與當(dāng)前操作近似的操作例如，停機(jī)保號作為銷戶的相關(guān)主題。影響當(dāng)前操

16、作結(jié)果的操作這類操作并非執(zhí)行當(dāng)前操作的前提條件，但是會對當(dāng)前操作產(chǎn)生影響。例如，“調(diào)整報表結(jié)構(gòu)”作為“打印報表”的相關(guān)主題。【樣例】如果覺得報表風(fēng)格不能滿足你的需要，可以參考“2.8調(diào)整報表結(jié)構(gòu)”修改報表的風(fēng)格。2.32-4客戶端操作指南第3章業(yè)務(wù)數(shù)據(jù)操作第3章業(yè)務(wù)數(shù)據(jù)操作3.1 PPS業(yè)務(wù)數(shù)據(jù)操作3.1.1 PPS業(yè)務(wù)用戶數(shù)據(jù)操作1 .操作說明2 .操作前提（可選）3 .操作步驟（可選）4 .參數(shù)說明/界面元素說明5 .相關(guān)主題（可選）3.1.2手工充值1 .操作說明2 .執(zhí)行前提（可選）3 .操作步驟（可選）4 .參數(shù)說明/界面元素說明5 .相關(guān)主題（可選）3.23-1客戶端操作指南0附錄

17、A參數(shù)匯總附錄A參數(shù)匯總?cè)绻局改弦月?lián)機(jī)幫助形式提供，本附錄屬于必選內(nèi)容；其他方式提供，本附錄作為可選內(nèi)容。本章按照菜單次序依次介紹各個界面上的參數(shù)。二級標(biāo)題和菜單根目錄對應(yīng)，三級標(biāo)題和各個菜單項對應(yīng)。參數(shù)描述的詳細(xì)要求參見：參考-03-07-參數(shù)描述寫作模板。每個界面的參數(shù)說明需要同時提供一個不包含任何數(shù)據(jù)的截圖。說明：如果以聯(lián)機(jī)幫助形式提供本指南，參數(shù)匯總單獨(dú)作為一頁，提供到各個界面參數(shù)說明業(yè)務(wù)的鏈接即可。引言簡要說明本章的主要內(nèi)容，反映本章的寫作目的。讀者閱讀該概述后，應(yīng)該明確是否還需要繼續(xù)閱讀本章的內(nèi)容。需要特別注意或聲明的內(nèi)容可酌情寫在此處?！緲永勘菊掳凑詹藛未涡蚪榻B各個頁面上的參數(shù)。您可以閱讀本章，查詢參數(shù)的含義和取值等信息。3-1客戶端操作指南0附錄A參數(shù)匯總3.3 系統(tǒng)（對應(yīng)菜單名稱）3.3.1 修改密碼3.3.2 查詢?nèi)罩?.4 業(yè)務(wù)數(shù)據(jù)3.4.1 開放地區(qū)區(qū)號設(shè)置（對應(yīng)窗口名稱）1.界面并放地區(qū)區(qū)號設(shè)置B工陰© |2.參數(shù)說明參數(shù)如何理解如何設(shè)置區(qū)號本地號碼長度區(qū)號說明3-33.4.2客戶端操作指南0附錄B錯誤信息說明附錄B錯誤信息說明本章提供所有界面錯誤信息的說明，寫作方法參考：參考-03-