客户端操作必备指南

客户端操作指南写作模板拟制日期-9-8评审人项目构成员日期批准日期签发日期华为技术有限公司 华为技术有限公司 版权所有，保存一切权利（仅供内部使用）修订记录日期修订版本修改章节修改描述作者-09-09试用稿草稿完毕杨健目 录有关本手册2-1第1章 迅速入门（可选）2-11.1 理解PPC_SMAP2-11.1.1 PPC业务定义2-11.1.2 PPC_SMAP的重要功能2-21.2 PPC_SMAP操作基本2-21.2.1 登录PPC_SMAP2-21.2.2 PPC_SMAP界面简介2-31.2.3 注销2-7第2章 系统操作2-12.1 更改密码2-12.2 查看日记2-22.3 2-4第3章 业务数据操作3-13.1 PPS业务数据操作3-13.1.1 PPS业务顾客数据操作3-13.1.2 手工充值3-13.2 3-13.2.1 3-1附录A 参数汇总3-13.3 系统（相应菜单名称）3-23.3.1 修改密码3-23.3.2 查询日记3-23.4 业务数据3-23.4.1 开放地区区号设立（相应窗口名称）3-23.4.2 3-3附录B 错误信息阐明3-1附录C 缩略语表3-1写作总指引写作侧重点定位作为客户端使用者的参照书，提供所有客户端界面信息。特点同业务操作手册相比，本手册有如下特点：l 基于客户端界面组织，不关注任务；l 需要具体阐明界面上的各个元素，涉及参数阐明。特别声明客户端使用指南一般以联机协助的形式提供。写作难点/注意事项参数阐明信息需要完整、具体，具有指引意义。有关本手册写作模板采用资料部统一的about this manual 模板。如果资料部未统一履行该部分，删除本节。第1章 迅速入门（可选）本章属于可选写作内容，由作者根据实际状况选择写作。本章的简介业务的基本定。读者阅读本章后应当理解业务的核心特性。引言简要阐明本章的重要内容，反映本章的写作目的。读者阅读该概述后，应当明确与否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此处。【样例】本章一方面简介了PPC_SMAP的功能，然后具体简介PPC_SMAP的界面以及登录注销措施。通过阅读本章，您可以迅速掌握操作PPC_SMAP需要理解的基本信息。1.1 理解PPC_SMAP这里简朴阐明客户端和业务的关系。【样例】PPC_SMAP是PPC业务的核心管理工具，您可以通过该终端管理所有PPC业务的业务数据。下面一方面简介什么是PPC业务，然后具体简介PPC_SMAP的重要功能。1.1.1 PPC业务定义本节给出业务的具体定义，重点阐明业务的核心特性。本节的简介规定通俗易懂，少用专业词汇。尽量采用类比、举例等方式，避免忽然引入太多的新概念。【样例】PPS业务是基于CDMA（code division multiple access）网络或者GSM（global system for mobile communication）网络的一种智能业务。同老式的移动网络顾客相比，PPS顾客需要预先缴纳一定的费用才可以发起呼喊或者使用其他的业务特性。每次呼喊结束时，系统会从PPS顾客预先缴纳的费用扣除通话费用。1.1.2 PPC_SMAP的重要功能 这里应当给出PPC_SMAP功能的概要简介。描述尽量概要简短，从顾客应用角度合适提炼，不应当仅仅是菜单的罗列。例如：分为系统管理（操作员权限管理等）、业务受理（end user需求的解决）和数据记录（报表等）。【样例】PPC_SMAP是PPC业务的业务数据管理终端。您可以通过该终端维护PPC顾客的业务数据，受理多种PPC业务祈求。PPC业务的重要功能涉及：l 系统管理l 业务受理l 数据记录1.2 PPC_SMAP操作基本1.2.1 登录PPC_SMAP本节以step by step的方式简介客户端的登录措施。【样例】1Double click the PPC_SMAP shortcut icon on the desktop.问题1. 这个表格的边框是不是错的， 应当没有竖线边框吧。登录对话框浮现，如图所示。 2Enter the operators user name and password.The default user name and password are eppcadm and TELLIN.3Click OK .PPC_SMAP 系统管理窗口浮现，如图所示。4Select Service Data EPPC Service.PPC_SMAP service management window浮现，如图所示.1.2.2 PPC_SMAP界面简介简要简介管理界面的构造、菜单、快捷按钮等。如果系统提供管理权限控制功能，需要简介界面操作同操作员权限的关系。l 对于初次使用客户端的顾客可以通过该部分简介熟悉界面，理解系统功能。l 对于比较熟悉客户端的顾客可以参照这部分内容迅速查找到任务的入口。【样例】EPPC_SMAP的界面由菜单、工具条和操作区三个部分构成，如Error! Reference source not found.所示。图1-1 EPPC_SMAP操作界面各个部分的具体阐明如下：菜单这里需要具体阐明菜单构造、功能及权限。如果不波及权限问题，可以删除权限一列。【样例1】菜单构造阐明权限系统密码更改选择该菜单修改自己的密码。系统管理员日记浏览选择该菜单查看平常的操作日记。系统管理员返回主界面选择该菜单注销，进入登录界面。操作员业务数据PPS顾客数据管理PPS业务顾客数据手工充值顾客挂失【样例2】表1-1 业务管理菜单功能阐明业务管理菜单展开项操作员级别工具条这里要具体简介工具条每个图标的功能。【样例】图标名称功能顾客数据查询查询PPS顾客的数据手工充值操作员对顾客的帐户进行手工充值挂失挂失PPS顾客的储值卡解挂失解挂失顾客的储值卡，使其顾客状态返回挂失前的状态激活激活PPS顾客数据去激活去激活PPS顾客数据批量开户进行批量开户操作批量销户进行批量销户操作有关SMAP查看SMAP的版本、版权信息返回主界面退出PPS业务的操作界面，返回SMAP平台界面操作区这里需要给出典型的操作界面以及按钮阐明。【样例】选择某一菜单后，操作区会显示相应的数据管理对话框，供您管理业务数据。Error! Reference source not found.给出了典型的PPS_SMAP操作界面。图1-2 PPS_SMAP典型操作界面Error! Reference source not found.中各个按钮的阐明如Error! Reference source not found.所示。表1-2 典型按钮阐明按钮功能条件执行查询操作前，您需要单击按钮，然后才可以输入查询条件。查询输入查询条件后，单击按钮，可以查询到符合规定的信息。插入1.2.3 注销本节以step by step的方式简介客户端的注销措施。【样例】1确认光标停留在PPC_SMAP 业务 management window.2Select System Return 或者Click on the toolbar.PPC_SMAP system management window浮现。3Select System Exit. 或者Click on the toolbar.A dialog box will appear, saying Are you sure to stop running the SMAP?4Click Yes.第2章 系统操作按照菜单构造简介各个界面的操作，目录构造和导航树相应。导航树上的每个根节点相应一章，然后依次向下安排二级标题和三级标题。引言简要阐明本章的重要内容，反映本章的写作目的。读者阅读该概述后，应当明确与否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此处。【样例】本章具体简介system菜单下所有各个子菜单的功能。通过阅读本章，您可以理解到System类界面操作的具体阐明。2.1 更改密码1. 操作阐明2. 操作前提（可选）3. 操作环节（可选）4. 参数阐明/界面元素阐明5. 有关主题（可选）2.2 查看日记1. 操作阐明顾客阅读操作阐明后，可以明确与否执行该操作。操作阐明可以涉及但不限于如下内容。l 什么状况下执行该操作可以采用阐明操作目的、意义的方式提供该类信息。l 执行成果操作执行成果、执行后的状态等阐明信息。不可逆转或危险性操作要给出警告阐明。【样例】当顾客提出不再使用PPS业务时，可觉得顾客销户。销户成功后，顾客的业务数据将被删除，顾客将不能再使用PPS业务。注意顾客销户后，所有顾客数据将被删除，无法再恢复。2. 操作前提（可选）顾客阅读操作前提后，应当明确自己与否可以执行任务。操作前提可以涉及但不限于如下内容。l 操作权限规定例如，只有超级管理员才可以清除黑名单。也可以涉及技能规定，并给出参照信息的位置。l 前置任务/执行环境规定例如，完毕操作系统安装后才干安装数据库。存在前置任务时，可以给出参照途径。【样例】处在正常使用状态的顾客才可以销户；处在欠费停机状态的顾客需要恢复至正常状态才干销户。停机状态顾客恢复至正常状态的措施请参见“2.5 复机”。3. 操作环节（可选）如果操作界面较为简朴，基本不波及操作环节，可以不提供本部分内容。此时，参数阐明部分扩展为界面元素阐明。对环节的阐明应当简朴，采用动宾构造的语句，基本风格参照样例。如果采用联机协助的形式提供本指南，需要注意如下两点：l 无需提供操作界面截图l 同一页面中如果存在多种子操作任务，使用折叠形式并列提供。例如：“增长顾客数据”和“查询顾客数据”的具体环节作为“顾客管理数据”页面中的两个折叠。【样例】选择业务管理/业务顾客数据管理菜单项，进入业务数据管理页面。这里插入操作界面截图。在该页面中，您可以执行如下操作：查询顾客信息1在“电话号码”文本框中输入12345678。这里插入操作界面截图。2单击按钮。增长顾客信息1单击按钮。2填写顾客信息。这里插入操作界面截图。3单击按钮。4. 参数阐明/界面元素阐明在没有提供操作环节一节内容时，本节提供目前界面所有元素的阐明，涉及参数和按钮等顾客可操作控件的阐明。提供这些阐明的同步需要提供界面供顾客参照。在提供操作环节一节内容时，本节提供目前界面上所有参数的具体阐明。参数描述顺序根据界面排列状况决定，一般遵循如下原则：(1) 从左到右(2) 从上到下参数描述的具体规定参见参照-03-07-参数描述写作模板。& 阐明：如果以联机协助形式提供本指南，参数阐明使用单独的页面提供。操作阐明界面提供到该页面的链接。5. 有关主题（可选）本节简介目前操作有关的某些信息，涉及但不限于：l 背景知识执行任务需要掌握的原理或概念。可以阐明，也可以提供信息的参照途径。l 操作成果可以供目前操作参照的操作例如，“查询帐号信息”作为“开户”有关主题；由于操作员也许需要理解一下尚有那些空闲帐号。l 与目前操作近似的操作例如，停机保号作为销户的有关主题。l 影响目前操作成果的操作此类操作并非执行目前操作的前提条件，但是会对目前操作产生影响。例如，“调节报表构造”作为“打印报表”的有关主题。【样例】如果觉得报表风格不能满足你的需要，可以参照“2.8 调节报表构造”修改报表的风格。2.3 第3章 业务数据操作3.1 PPS业务数据操作3.1.1 PPS业务顾客数据操作1. 操作阐明2. 操作前提（可选）3. 操作环节（可选）4. 参数阐明/界面元素阐明5. 有关主题（可选）3.1.2 手工充值1. 操作阐明2. 执行前提（可选）3. 操作环节（可选）4. 参数阐明/界面元素阐明5. 有关主题（可选）3.2 3.2.1 附录A 参数汇总如果本指南以联机协助形式提供，本附录属于必选内容；其她方式提供，本附录作为可选内容。本章按照菜单顺序依次简介各个界面上的参数。二级标题和菜单根目录相应，三级标题和各个菜单项相应。参数描述的具体规定参见：参照-03-07-参数描述写作模板。每个界面的参数阐明需要同步提供一种不涉及任何数据的截图。& 阐明：如果以联机协助形式提供本指南，参数汇总单独作为一页，提供到各个界面参数阐明业务的链接即可。引言简要阐明本章的重要内容，反映本章的写作目的。读者阅读该概述后，应当明确与否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此处。【样例】本章按照菜单顺序简介各个页面上的参数。您可以阅读本章，查询参数的含义和取值等信息。3.3 系统（相应菜单名称）3.3.1 修改密码3.3.2 查询日记3.4 业务数据3.4.1 开放地区区号设立（相应窗口名称）1. 界面2. 参数阐明参数如何理解如何设立区号本地号码长度区号阐明3.4.2 附录B 错误信息阐明本章提供所有界面错误信息的阐明，写作措施参照：参照-03-12-错误信息描述写作模板。附录C 缩略语表如果有术语，也需要有术语表，术语表在缩略语表前，单独一种附录。CCAAClient Access Agent 客户接入代理C/SClient/Server客户机/服务器体系构造CMPCard Management Point资源管理台DDNSDomain Name Server域名服务器HHTTPHyper Text Transport Protocal超文本传播合同HTMLHyper Text Markup Language超文本标记语言HLRHome Location Register归属位置寄存器