客戶端操作指引寫作模板

1、客戶端操作指南寫作模板客戶端操作指南2005-9-8產(chǎn)品線業(yè)務(wù)與軟件產(chǎn)品線密級(jí)話首域機(jī)密共33頁(yè)客戶端操作指南寫作模板擬制評(píng)審人批準(zhǔn)簽發(fā)2005-9-82HUAWEI華為技術(shù)有限公司?2005華為技術(shù)有限公司版權(quán)所有，保留一切權(quán)禾IJ（僅供內(nèi)部使用）修訂記錄日期修訂版本修 改 早 節(jié)修改描述作者200509-09試用 稿初稿完成楊健客戶端操作指南目錄關(guān)于本手冊(cè)1第1章快速入門（可選）11.1 了解 PPC_SMAP11.1.1 PPC業(yè)務(wù)定義21.1.2 PPC_SMAP的主要功能 31.2 PPC_SMAP 操作基礎(chǔ)41.2.1 登錄 PPC_SMAP41.2.2 PPC_SMAP 界面簡(jiǎn)介

2、 61.2.3 注銷10第2章系統(tǒng)操作12.1 更改密碼12.2查看日志22.3 8第3章 業(yè)務(wù)數(shù)據(jù)操作 13.1 PPS業(yè)務(wù)數(shù)據(jù)操作 13.1.1 PPS 業(yè)務(wù)用戶數(shù)據(jù)操作 13.1.2手工充值13.2 13.2.1 1附錄A參數(shù)匯總13.3系統(tǒng)（對(duì)應(yīng)菜單名稱） 33.3.1 修改密碼33.3.2查詢?nèi)罩?3.4業(yè)務(wù)數(shù)據(jù)33.4.1開(kāi)放地區(qū)區(qū)號(hào)設(shè)置（對(duì)應(yīng)窗口名稱） 33.4.2 4附錄B錯(cuò)誤信息說(shuō)明1附錄C縮略語(yǔ)表1i客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。寫作總指導(dǎo)寫作側(cè)重點(diǎn)定位作為客戶端使用者的參考書，提供所有客戶 端界面信息。特點(diǎn)同業(yè)務(wù)操作手冊(cè)相

3、比，本手冊(cè)有以下特點(diǎn)： 基于客戶端界面組織，不關(guān)注任務(wù)； 需要詳細(xì)說(shuō)明界面上的各個(gè)元素，包括參 數(shù)說(shuō)明。特別聲明客戶端使用指南通常以聯(lián)機(jī)幫助的形式提 供。寫作難點(diǎn)/注意事項(xiàng)參數(shù)說(shuō)明信息需要完整、詳細(xì)，具有指導(dǎo)意 義。1客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。about this刪除本節(jié)。關(guān)于本手冊(cè)寫作模板采用資料部統(tǒng)一的manual 模板。如果資料部未統(tǒng)一推行該部分，i客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。第1章快速入門（可選）本章屬于可選寫作內(nèi)容，由作者根據(jù)實(shí)際情 況選擇寫作。本章的介紹業(yè)務(wù)的基本定。讀者閱讀本

4、章后 應(yīng)該了解業(yè)務(wù)的核心特征。引言簡(jiǎn)要說(shuō)明本章的主要內(nèi)容，反映本章的 寫作目的。讀者閱讀該概述后，應(yīng)該明確是 否還需要繼續(xù)閱讀本章的內(nèi)容。需要特別注意或聲明的內(nèi)容可酌情寫在此 處?！緲永勘菊率紫冉榻B了 PPC_SMAP的功能，然后 詳細(xì)介紹PPC_SMAP的界面以及登錄注銷 方法。通過(guò)閱讀本章，您可以快速掌握操作PPC_SMAP需要了解的基本信息1.1 了解 PPC_SMAP這里簡(jiǎn)單說(shuō)明客戶端和業(yè)務(wù)的關(guān)系i客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字?！緲永縋PC_SMAP 是PPC業(yè)務(wù)的核心管理工具，您可以通過(guò)該終端管理所有PPC業(yè)務(wù)的業(yè) 務(wù)數(shù)據(jù)。下面首

5、先介紹什么是PPC業(yè)務(wù)，然后詳細(xì) 介紹PPC_SMAP 的主要功能。1.1.1 PPC業(yè)務(wù)定義本節(jié)給出業(yè)務(wù)的詳細(xì)定義，重點(diǎn)說(shuō)明業(yè)務(wù)的 核心特征。本節(jié)的介紹要求通俗易懂，少用 專業(yè)詞匯。盡量采用類比、舉例等方式，避 免突然引入太多的新概念。【樣例】PPS 業(yè)務(wù)是基于 CDMA ( code division multiple access )網(wǎng)絡(luò)或者 GSM (global system for mobile com muni cati on) 網(wǎng)絡(luò)的一種智能業(yè)務(wù)。同傳統(tǒng)的移動(dòng)網(wǎng)絡(luò)用戶相比，PPS用戶需要 預(yù)先繳納一定的費(fèi)用才可以發(fā)起呼叫或者 使用其它的業(yè)務(wù)特性。每次呼叫結(jié)束時(shí)，系 統(tǒng)會(huì)從PPS

6、用戶預(yù)先繳納的費(fèi)用扣除通話 費(fèi)用。1.1.2 PPC_SMAP的主要功能這里應(yīng)該給出PPC_SMAP功能的概要介 紹。描述盡量概要簡(jiǎn)短，從用戶應(yīng)用角度適 當(dāng)提煉，不應(yīng)該僅僅是菜單的羅列。例如：分為系統(tǒng)管理（操作員權(quán)限管理等）、 業(yè)務(wù)受理（end user需求的處理）和數(shù)據(jù)統(tǒng) 計(jì)（報(bào)表等）?！緲永縋PC_SMAP是PPC業(yè)務(wù)的業(yè)務(wù)數(shù)據(jù)管理終 端。您可以通過(guò)該終端維護(hù) PPC用戶的業(yè) 務(wù)數(shù)據(jù)，受理各種PPC業(yè)務(wù)請(qǐng)求。PPC業(yè) 務(wù)的主要功能包括：系統(tǒng)管理業(yè)務(wù)受理數(shù)據(jù)統(tǒng)計(jì)1.2 PPC_SMAP 操作基礎(chǔ)1.2.1 登錄 PPC_SMAP本節(jié)以step by step的方式介紹客戶端的 登錄方法。【

7、樣例】1 Double click the PPC_SMAP shortcut icon忍 on the desktop.登錄對(duì)話框出現(xiàn)，如圖所示。2 Enter the operator ' user name and password.The default user name and password are eppcadm and TELLIN.3 Click OK .PPC_SMAP 系統(tǒng)管理窗口出現(xiàn)，如圖所示。124 Select Service Data > EPPC Service.PPC_SMAP service management window出現(xiàn)，如圖所示

8、1.2.2 PPC_SMAP 界面簡(jiǎn)介簡(jiǎn)要介紹管理界面的結(jié)構(gòu)、菜單、快捷按鈕 等。如果系統(tǒng)提供管理權(quán)限控制功能，需要 介紹界面操作同操作員權(quán)限的關(guān)系。對(duì)于首次使用客戶端的用戶可以通過(guò)該部分介紹熟悉界面，了解系統(tǒng)功 能。對(duì)于比較熟悉客戶端的用戶可以參考這部分內(nèi)容迅速查找到任務(wù)的入 口?！緲永縀PPC_SMAP的界面由菜單、工具條和操作 區(qū)三個(gè)部分組成，如圖1-1所示。界面說(shuō)明；操作界面菜單工具條操作區(qū)圖1-1 EPPCSMAP 操作界面各個(gè)部分的詳細(xì)說(shuō)明如下：菜單這里需要詳細(xì)說(shuō)明菜單結(jié)構(gòu)、功能及權(quán)限。如果不涉及權(quán)限問(wèn)題，可以刪除權(quán)限一列?！緲永?】菜單結(jié)構(gòu)說(shuō)明權(quán)限系統(tǒng)密碼更改選擇該菜單修改自己

9、的密碼。系統(tǒng)管理員日志瀏覽選擇該菜單查看日常的操作日志。系統(tǒng)管理員返回主界面選擇該菜單注銷，進(jìn)入登錄界面。操作員業(yè)務(wù)數(shù)據(jù)PPS用戶數(shù)據(jù)管理PPS業(yè)務(wù)用戶數(shù)據(jù)手工充值用戶掛失【樣例2】表1-1業(yè)務(wù)管理菜單功能說(shuō)明工具條這里要詳細(xì)介紹工具條每個(gè)圖標(biāo)的功能【樣例】圖標(biāo)名稱功能置1用戶數(shù)據(jù)查詢查詢PPS用戶的數(shù)據(jù)魚1手工充值操作員對(duì)用戶的帳戶進(jìn)行手工充值©掛失掛失PPS用戶的儲(chǔ)值卡解掛失解掛失用戶的儲(chǔ)值卡，使其用戶狀態(tài)返回掛失前的狀態(tài)至1激活激活PPS用戶數(shù)據(jù)X1去激活去激活PPS用戶數(shù)據(jù)批量開(kāi)戶進(jìn)行批量開(kāi)戶操作批量銷戶進(jìn)行批量銷戶操作XI關(guān)于SMAP查看SMAP的版本、版權(quán)信息囲返回主界面

10、退出PPS業(yè)務(wù)的操作界面，返回 SMAP平臺(tái)界面操作區(qū)這里需要給出典型的操作界面以及按鈕說(shuō) 明?！緲永窟x擇某一菜單后，操作區(qū)會(huì)顯示對(duì)應(yīng)的數(shù)據(jù) 管理對(duì)話框，供您管理業(yè)務(wù)數(shù)據(jù)。圖 1-2給 出了典型的PPS_SMAP操作界面。圖1-2 PPSSMAP典型操作界面圖1-2中各個(gè)按鈕的說(shuō)明如表1-1所示表1-1典型按鈕說(shuō)明按鈕功能條件執(zhí)行查詢操作前，您需要單擊 條件按鈕，然后才可以輸入查詢條件。查詢輸入查詢條件后，單擊 查詢按鈕，可以查詢到符合要求的信息。插入1.2.3注銷本節(jié)以step by step的方式介紹客戶端的 注銷方法?！緲永靠蛻舳瞬僮髦改襄e(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中

11、沒(méi)有指定樣式的文字。1確認(rèn)光標(biāo)停留在PPC_SMA業(yè)務(wù) man ageme nt win dow.2 Select System > Return或者 Click 陽(yáng)on the toolbar.PPC_SMAP system man ageme nt wi ndow 出現(xiàn)。3 Select System > Exit. 或者 Click 業(yè) on the toolbar.A dialog box will appear, saying "Are you sure to stop running the SMAP?"4 Click Yes.ii客戶端操作指南錯(cuò)誤

12、!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。第2章系統(tǒng)操作按照菜單結(jié)構(gòu)介紹各個(gè)界面的操作，目錄結(jié) 構(gòu)和導(dǎo)航樹對(duì)應(yīng)。導(dǎo)航樹上的每個(gè)根節(jié)點(diǎn)對(duì) 應(yīng)一章，然后依次向下安排二級(jí)標(biāo)題和三級(jí) 標(biāo)題。引言簡(jiǎn)要說(shuō)明本章的主要內(nèi)容，反映本章的 寫作目的。讀者閱讀該概述后，應(yīng)該明確是 否還需要繼續(xù)閱讀本章的內(nèi)容。需要特別注意或聲明的內(nèi)容可酌情寫在此 處。【樣例】本章詳細(xì)介紹system菜單下所有各個(gè)子菜 單的功能。通過(guò)閱讀本章，您可以了解到System類界 面操作的詳細(xì)說(shuō)明。2.1更改密碼1. 操作說(shuō)明i客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。2. 操作前提

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

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

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

16、明的 同時(shí)需要提供界面供用戶參考。在提供操作步驟一節(jié)內(nèi)容時(shí)，本節(jié)提供當(dāng)前 界面上所有參數(shù)的詳細(xì)說(shuō)明。參數(shù)描述次序 依據(jù)界面排列情況決定，一般遵循如下原 則：(1)從左至U右從上到下參數(shù)描述的詳細(xì)要求參見(jiàn)參考-03-07-參數(shù)描述寫作模板 說(shuō)明：如果以聯(lián)機(jī)幫助形式提供本指南，參數(shù)說(shuō)明 使用單獨(dú)的頁(yè)面提供。操作說(shuō)明界面提供到 該頁(yè)面的鏈接。5. 相關(guān)主題（可選） 本節(jié)介紹當(dāng)前操作相關(guān)的一些信息，包括但 不限于：背景知識(shí)執(zhí)行任務(wù)需要掌握的原理或概念?？梢哉f(shuō) 明，也可以提供信息的參考路徑。操作結(jié)果可以供當(dāng)前操作參考的操作 例如，“查詢帳號(hào)信息”作為“開(kāi)戶”相關(guān) 主題；因?yàn)椴僮鲉T可能需要了解一下還有那

17、些空閑帳號(hào)。與當(dāng)前操作近似的操作例如，停機(jī)保號(hào)作為銷戶的相關(guān)主題。影響當(dāng)前操作結(jié)果的操作2.3這類操作并非執(zhí)行當(dāng)前操作的前提條件，但 是會(huì)對(duì)當(dāng)前操作產(chǎn)生影響。例如，“調(diào)整報(bào) 表結(jié)構(gòu)”作為“打印報(bào)表”的相關(guān)主題。【樣例】如果覺(jué)得報(bào)表風(fēng)格不能滿足你的需要，可以 參考“ 2.8調(diào)整報(bào)表結(jié)構(gòu)”修改報(bào)表的風(fēng)格客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。第3章業(yè)務(wù)數(shù)據(jù)操作3.13.1.1PPS業(yè)務(wù)數(shù)據(jù)操作PPS業(yè)務(wù)用戶數(shù)據(jù)操作1操作說(shuō)明2. 操作前提（可選）3. 操作步驟（可選）4. 參數(shù)說(shuō)明/界面元素說(shuō)明3.1.25. 相關(guān)主題（可選）手工充值1. 操作說(shuō)明2. 執(zhí)行

18、前提（可選）3. 操作步驟（可選）4. 參數(shù)說(shuō)明/界面元素說(shuō)明5. 相關(guān)主題（可選）23.23.2.1客戶端操作指南錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。 錯(cuò)誤!文檔中沒(méi)有指定樣式的文字。附錄A參數(shù)匯總?cè)绻局改弦月?lián)機(jī)幫助形式提供，本附錄屬 于必選內(nèi)容；其他方式提供，本附錄作為可 選內(nèi)容。本章按照菜單次序依次介紹各個(gè)界面上的 參數(shù)。二級(jí)標(biāo)題和菜單根目錄對(duì)應(yīng)，三級(jí)標(biāo) 題和各個(gè)菜單項(xiàng)對(duì)應(yīng)。參數(shù)描述的詳細(xì)要求參見(jiàn)：參考-03-07-參數(shù) 描述寫作模板。每個(gè)界面的參數(shù)說(shuō)明需要同時(shí)提供一個(gè)不 包含任何數(shù)據(jù)的截圖。說(shuō)明：如果以聯(lián)機(jī)幫助形式提供本指南，參數(shù)匯總 單獨(dú)作為一頁(yè)，提供到各個(gè)界面參數(shù)說(shuō)明業(yè) 務(wù)的鏈接即可。4引言簡(jiǎn)要說(shuō)明本章的主要內(nèi)容，反映本章的