客户端操作必备指南.docx

《客户端操作必备指南.docx》由会员分享，可在线阅读，更多相关《客户端操作必备指南.docx（22页珍藏版）》请在三一办公上搜索。

1、客户端操作指南写作模板拟制日期2005-9-8评审人项目组成员日期批准日期签发日期华为技术有限公司2005 华为技术有限公司 版权所有，保留一切权利（仅供内部使用）修订记录日期修订版本修改章节修改描述作者2005-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、日志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 需要详细说明界面上

3、的各个元素，包括参数说明。特别声明客户端使用指南通常以联机帮助的形式提供。写作难点/注意事项参数说明信息需要完整、详细，具有指导意义。关于本手册写作模板采用资料部统一的about this manual 模板。如果资料部未统一推行该部分，删除本节。第1章 快速入门（可选）本章属于可选写作内容，由作者根据实际情况选择写作。本章的介绍业务的基本定。读者阅读本章后应该了解业务的核心特征。引言简要说明本章的主要内容，反映本章的写作目的。读者阅读该概述后，应该明确是否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此处。【样例】本章首先介绍了PPC_SMAP的功能，然后详细介绍PPC_SMA

4、P的界面以及登录注销方法。通过阅读本章，您可以快速掌握操作PPC_SMAP需要了解的基本信息。1.1 了解PPC_SMAP这里简单说明客户端和业务的关系。【样例】PPC_SMAP是PPC业务的核心管理工具，您可以通过该终端管理所有PPC业务的业务数据。下面首先介绍什么是PPC业务，然后详细介绍PPC_SMAP的主要功能。1.1.1 PPC业务定义本节给出业务的详细定义，重点说明业务的核心特征。本节的介绍要求通俗易懂，少用专业词汇。尽量采用类比、举例等方式，避免突然引入太多的新概念。【样例】PPS业务是基于CDMA（code division multiple access）网络或者GSM（gl

5、obal system for mobile communication）网络的一种智能业务。同传统的移动网络用户相比，PPS用户需要预先缴纳一定的费用才可以发起呼叫或者使用其它的业务特性。每次呼叫结束时，系统会从PPS用户预先缴纳的费用扣除通话费用。1.1.2 PPC_SMAP的主要功能 这里应该给出PPC_SMAP功能的概要介绍。描述尽量概要简短，从用户应用角度适当提炼，不应该仅仅是菜单的罗列。例如：分为系统管理（操作员权限管理等）、业务受理（end user需求的处理）和数据统计（报表等）。【样例】PPC_SMAP是PPC业务的业务数据管理终端。您可以通过该终端维护PPC用户的业务数据，

6、受理各种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 an

7、d TELLIN.3Click OK .PPC_SMAP 系统管理窗口出现，如图所示。4Select Service Data EPPC Service.PPC_SMAP service management window出现，如图所示.1.2.2 PPC_SMAP界面简介简要介绍管理界面的结构、菜单、快捷按钮等。如果系统提供管理权限控制功能，需要介绍界面操作同操作员权限的关系。l 对于首次使用客户端的用户可以通过该部分介绍熟悉界面，了解系统功能。l 对于比较熟悉客户端的用户可以参考这部分内容迅速查找到任务的入口。【样例】EPPC_SMAP的界面由菜单、工具条和操作区三个部分组成，如图1-1所

8、示。图1-1 EPPC_SMAP操作界面各个部分的详细说明如下：菜单这里需要详细说明菜单结构、功能及权限。如果不涉及权限问题，可以删除权限一列。【样例1】菜单结构说明权限系统密码更改选择该菜单修改自己的密码。系统管理员日志浏览选择该菜单查看日常的操作日志。系统管理员返回主界面选择该菜单注销，进入登录界面。操作员业务数据PPS用户数据管理PPS业务用户数据手工充值用户挂失【样例2】表1-1 业务管理菜单功能说明业务管理菜单展开项操作员级别工具条这里要详细介绍工具条每个图标的功能。【样例】图标名称功能用户数据查询查询PPS用户的数据手工充值操作员对用户的帐户进行手工充值挂失挂失PPS用户的储值卡解

9、挂失解挂失用户的储值卡，使其用户状态返回挂失前的状态激活激活PPS用户数据去激活去激活PPS用户数据批量开户进行批量开户操作批量销户进行批量销户操作关于SMAP查看SMAP的版本、版权信息返回主界面退出PPS业务的操作界面，返回SMAP平台界面操作区这里需要给出典型的操作界面以及按钮说明。【样例】选择某一菜单后，操作区会显示对应的数据管理对话框，供您管理业务数据。图1-2给出了典型的PPS_SMAP操作界面。图1-2 PPS_SMAP典型操作界面图1-2中各个按钮的说明如表1-2所示。表1-2 典型按钮说明按钮功能条件执行查询操作前，您需要单击按钮，然后才可以输入查询条件。查询输入查询条件后，

10、单击按钮，可以查询到符合要求的信息。插入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?4Clic

11、k Yes.第2章 系统操作按照菜单结构介绍各个界面的操作，目录结构和导航树对应。导航树上的每个根节点对应一章，然后依次向下安排二级标题和三级标题。引言简要说明本章的主要内容，反映本章的写作目的。读者阅读该概述后，应该明确是否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此处。【样例】本章详细介绍system菜单下所有各个子菜单的功能。通过阅读本章，您可以了解到System类界面操作的详细说明。2.1 更改密码1. 操作说明2. 操作前提（可选）3. 操作步骤（可选）4. 参数说明/界面元素说明5. 相关主题（可选）2.2 查看日志1. 操作说明用户阅读操作说明后，可以明确是否执

12、行该操作。操作说明可以包括但不限于以下内容。l 什么情况下执行该操作可以采用说明操作目的、意义的方式提供该类信息。l 执行结果操作执行结果、执行后的状态等说明信息。不可逆转或危险性操作要给出警告说明。【样例】当用户提出不再使用PPS业务时，可以为用户销户。销户成功后，用户的业务数据将被删除，用户将不能再使用PPS业务。注意用户销户后，所有用户数据将被删除，无法再恢复。2. 操作前提（可选）用户阅读操作前提后，应该明确自己是否可以执行任务。操作前提可以包括但不限于以下内容。l 操作权限要求例如，只有超级管理员才可以清除黑名单。也可以包括技能要求，并给出参考信息的位置。l 前置任务/执行环境要求例

13、如，完成操作系统安装后才能安装数据库。存在前置任务时，可以给出参考路径。【样例】处于正常使用状态的用户才可以销户；处于欠费停机状态的用户需要恢复至正常状态才能销户。停机状态用户恢复至正常状态的方法请参见“2.5 复机”。3. 操作步骤（可选）如果操作界面较为简单，基本不涉及操作步骤，可以不提供本部分内容。此时，参数说明部分扩展为界面元素说明。对步骤的说明应该简单，采用动宾结构的语句，基本风格参考样例。如果采用联机帮助的形式提供本指南，需要注意以下两点：l 无需提供操作界面截图l 同一页面中如果存在多个子操作任务，使用折叠形式并列提供。例如：“增加用户数据”和“查询用户数据”的详细步骤作为“用户

14、管理数据”页面中的两个折叠。【样例】选择业务管理/业务用户数据管理菜单项，进入业务数据管理页面。这里插入操作界面截图。在该页面中，您可以执行以下操作：查询用户信息1在“电话号码”文本框中输入12345678。这里插入操作界面截图。2单击按钮。增加用户信息1单击按钮。2填写用户信息。这里插入操作界面截图。3单击按钮。4. 参数说明/界面元素说明在没有提供操作步骤一节内容时，本节提供当前界面所有元素的说明，包括参数和按钮等用户可操作控件的说明。提供这些说明的同时需要提供界面供用户参考。在提供操作步骤一节内容时，本节提供当前界面上所有参数的详细说明。参数描述次序依据界面排列情况决定，一般遵循如下原则

15、：(1) 从左到右(2) 从上到下参数描述的详细要求参见参考-03-07-参数描述写作模板。& 说明：如果以联机帮助形式提供本指南，参数说明使用单独的页面提供。操作说明界面提供到该页面的链接。5. 相关主题（可选）本节介绍当前操作相关的一些信息，包括但不限于：l 背景知识执行任务需要掌握的原理或概念。可以说明，也可以提供信息的参考路径。l 操作结果可以供当前操作参考的操作例如，“查询帐号信息”作为“开户”相关主题；因为操作员可能需要了解一下还有那些空闲帐号。l 与当前操作近似的操作例如，停机保号作为销户的相关主题。l 影响当前操作结果的操作这类操作并非执行当前操作的前提条件，但是会对当前操作产

16、生影响。例如，“调整报表结构”作为“打印报表”的相关主题。【样例】如果觉得报表风格不能满足你的需要，可以参考“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 参数汇总如果本指南以联机帮助形式提供，本附录属于必选内容；其他方式提供，本附录作为可选内容。本章按照

17、菜单次序依次介绍各个界面上的参数。二级标题和菜单根目录对应，三级标题和各个菜单项对应。参数描述的详细要求参见：参考-03-07-参数描述写作模板。每个界面的参数说明需要同时提供一个不包含任何数据的截图。& 说明：如果以联机帮助形式提供本指南，参数汇总单独作为一页，提供到各个界面参数说明业务的链接即可。引言简要说明本章的主要内容，反映本章的写作目的。读者阅读该概述后，应该明确是否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此处。【样例】本章按照菜单次序介绍各个页面上的参数。您可以阅读本章，查询参数的含义和取值等信息。3.3 系统（对应菜单名称）3.3.1 修改密码3.3.2 查询

18、日志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归属位置寄存器