客户端操作指引写作模板

1、客户端操作指南写作模板客户端操作指南2005-9-8产品线业务与软件产品线密级话首域机密共33页客户端操作指南写作模板拟制评审人批准签发2005-9-82HUAWEI华为技术有限公司?2005华为技术有限公司版权所有，保留一切权禾IJ（仅供内部使用）修订记录日期修订版本修 改 早 节修改描述作者200509-09试用 稿初稿完成杨健客户端操作指南目录关于本手册1第1章快速入门（可选）11.1 了解 PPC_SMAP11.1.1 PPC业务定义21.1.2 PPC_SMAP的主要功能 31.2 PPC_SMAP 操作基础41.2.1 登录 PPC_SMAP41.2.2 PPC_SMAP 界面简介

2、 61.2.3 注销10第2章系统操作12.1 更改密码12.2查看日志22.3 8第3章 业务数据操作 13.1 PPS业务数据操作 13.1.1 PPS 业务用户数据操作 13.1.2手工充值13.2 13.2.1 1附录A参数汇总13.3系统（对应菜单名称） 33.3.1 修改密码33.3.2查询日志33.4业务数据33.4.1开放地区区号设置（对应窗口名称） 33.4.2 4附录B错误信息说明1附录C缩略语表1i客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。写作总指导写作侧重点定位作为客户端使用者的参考书，提供所有客户 端界面信息。特点同业务操作手册相

3、比，本手册有以下特点： 基于客户端界面组织，不关注任务； 需要详细说明界面上的各个元素，包括参 数说明。特别声明客户端使用指南通常以联机帮助的形式提 供。写作难点/注意事项参数说明信息需要完整、详细，具有指导意 义。1客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。about this删除本节。关于本手册写作模板采用资料部统一的manual 模板。如果资料部未统一推行该部分，i客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。第1章快速入门（可选）本章属于可选写作内容，由作者根据实际情 况选择写作。本章的介绍业务的基本定。读者阅读本

4、章后 应该了解业务的核心特征。引言简要说明本章的主要内容，反映本章的 写作目的。读者阅读该概述后，应该明确是 否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此 处。【样例】本章首先介绍了 PPC_SMAP的功能，然后 详细介绍PPC_SMAP的界面以及登录注销 方法。通过阅读本章，您可以快速掌握操作PPC_SMAP需要了解的基本信息1.1 了解 PPC_SMAP这里简单说明客户端和业务的关系i客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。【样例】PPC_SMAP 是PPC业务的核心管理工具，您可以通过该终端管理所有PPC业务的业 务数据。下面首

5、先介绍什么是PPC业务，然后详细 介绍PPC_SMAP 的主要功能。1.1.1 PPC业务定义本节给出业务的详细定义，重点说明业务的 核心特征。本节的介绍要求通俗易懂，少用 专业词汇。尽量采用类比、举例等方式，避 免突然引入太多的新概念。【样例】PPS 业务是基于 CDMA ( code division multiple access )网络或者 GSM (global system for mobile com muni cati on) 网络的一种智能业务。同传统的移动网络用户相比，PPS用户需要 预先缴纳一定的费用才可以发起呼叫或者 使用其它的业务特性。每次呼叫结束时，系 统会从PPS

6、用户预先缴纳的费用扣除通话 费用。1.1.2 PPC_SMAP的主要功能这里应该给出PPC_SMAP功能的概要介 绍。描述尽量概要简短，从用户应用角度适 当提炼，不应该仅仅是菜单的罗列。例如：分为系统管理（操作员权限管理等）、 业务受理（end user需求的处理）和数据统 计（报表等）。【样例】PPC_SMAP是PPC业务的业务数据管理终 端。您可以通过该终端维护 PPC用户的业 务数据，受理各种PPC业务请求。PPC业 务的主要功能包括：系统管理业务受理数据统计1.2 PPC_SMAP 操作基础1.2.1 登录 PPC_SMAP本节以step by step的方式介绍客户端的 登录方法。【

7、样例】1 Double click the PPC_SMAP shortcut icon忍 on the desktop.登录对话框出现，如图所示。2 Enter the operator ' user name and password.The default user name and password are eppcadm and TELLIN.3 Click OK .PPC_SMAP 系统管理窗口出现，如图所示。124 Select Service Data > EPPC Service.PPC_SMAP service management window出现，如图所示

8、1.2.2 PPC_SMAP 界面简介简要介绍管理界面的结构、菜单、快捷按钮 等。如果系统提供管理权限控制功能，需要 介绍界面操作同操作员权限的关系。对于首次使用客户端的用户可以通过该部分介绍熟悉界面，了解系统功 能。对于比较熟悉客户端的用户可以参考这部分内容迅速查找到任务的入 口。【样例】EPPC_SMAP的界面由菜单、工具条和操作 区三个部分组成，如图1-1所示。界面说明；操作界面菜单工具条操作区图1-1 EPPCSMAP 操作界面各个部分的详细说明如下：菜单这里需要详细说明菜单结构、功能及权限。如果不涉及权限问题，可以删除权限一列。【样例1】菜单结构说明权限系统密码更改选择该菜单修改自己

9、的密码。系统管理员日志浏览选择该菜单查看日常的操作日志。系统管理员返回主界面选择该菜单注销，进入登录界面。操作员业务数据PPS用户数据管理PPS业务用户数据手工充值用户挂失【样例2】表1-1业务管理菜单功能说明工具条这里要详细介绍工具条每个图标的功能【样例】图标名称功能置1用户数据查询查询PPS用户的数据鱼1手工充值操作员对用户的帐户进行手工充值©挂失挂失PPS用户的储值卡解挂失解挂失用户的储值卡，使其用户状态返回挂失前的状态至1激活激活PPS用户数据X1去激活去激活PPS用户数据批量开户进行批量开户操作批量销户进行批量销户操作XI关于SMAP查看SMAP的版本、版权信息囲返回主界面

10、退出PPS业务的操作界面，返回 SMAP平台界面操作区这里需要给出典型的操作界面以及按钮说 明。【样例】选择某一菜单后，操作区会显示对应的数据 管理对话框，供您管理业务数据。图 1-2给 出了典型的PPS_SMAP操作界面。图1-2 PPSSMAP典型操作界面图1-2中各个按钮的说明如表1-1所示表1-1典型按钮说明按钮功能条件执行查询操作前，您需要单击 条件按钮，然后才可以输入查询条件。查询输入查询条件后，单击 查询按钮，可以查询到符合要求的信息。插入1.2.3注销本节以step by step的方式介绍客户端的 注销方法。【样例】客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中

11、没有指定样式的文字。1确认光标停留在PPC_SMA业务 man ageme nt win dow.2 Select System > Return或者 Click 阳on the toolbar.PPC_SMAP system man ageme nt wi ndow 出现。3 Select System > Exit. 或者 Click 业 on the toolbar.A dialog box will appear, saying "Are you sure to stop running the SMAP?"4 Click Yes.ii客户端操作指南错误

12、!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。第2章系统操作按照菜单结构介绍各个界面的操作，目录结 构和导航树对应。导航树上的每个根节点对 应一章，然后依次向下安排二级标题和三级 标题。引言简要说明本章的主要内容，反映本章的 写作目的。读者阅读该概述后，应该明确是 否还需要继续阅读本章的内容。需要特别注意或声明的内容可酌情写在此 处。【样例】本章详细介绍system菜单下所有各个子菜 单的功能。通过阅读本章，您可以了解到System类界 面操作的详细说明。2.1更改密码1. 操作说明i客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。2. 操作前提

13、（可选）3. 操作步骤（可选）4. 参数说明/界面元素说明5. 相关主题（可选）2.2查看日志1. 操作说明用户阅读操作说明后，可以明确是否执行该 操作。操作说明可以包括但不限于以下内 容。什么情况下执行该操作 可以采用说明操作目的、意义的方式提供该 类信息。执行结果操作执行结果、执行后的状态等说明信息。 不可逆转或危险性操作要给出警告说明。【样例】当用户提出不再使用 PPS业务时，可以为 用户销户。销户成功后，用户的业务数据将 被删除，用户将不能再使用 PPS业务。 注意用户销户后，所有用户数据将被删除，无法 再恢复。2. 操作前提（可选）用户阅读操作前提后，应该明确自己是否可 以执行任务。

14、操作前提可以包括但不限于以 下内容。操作权限要求例如，只有超级管理员才可以清除黑名单。 也可以包括技能要求，并给出参考信息的位一置。前置任务/执行环境要求例如，完成操作系统安装后才能安装数据 库。存在前置任务时，可以给出参考路径。【样例】处于正常使用状态的用户才可以销户；处于 欠费停机状态的用户需要恢复至正常状态 才能销户。停机状态用户恢复至正常状态的方法请参 见“ 2.5复机”。3. 操作步骤（可选）如果操作界面较为简单，基本不涉及操作步 骤，可以不提供本部分内容。此时，参数说 明部分扩展为界面元素说明。对步骤的说明应该简单，采用动宾结构的语 句，基本风格参考样例。如果采用联机帮助的形式提供

15、本指南，需要注意以下两点：无需提供操作界面截图同一页面中如果存在多个子操作任务，使 用折叠形式并列提供。例如：“增加用户数据”和“查询用户数据” 的详细步骤作为“用户管理数据”页面中的 两个折叠。【样例】选择业务管理/业务用户数据管理菜单项， 进入业务数据管理页面。这里插入操作界面截图。在该页面中，您可以执行以下操作：查询用户信息1在“电话号码"文本框中输入12345678。这里插入操作界面截图2单击 查询按钮。8增加用户信息1单击 增加按钮。4. 参数说明/界面元素说明在没有提供操作步骤一节内容时，本节提供 当前界面所有元素的说明，包括参数和按钮 等用户可操作控件的说明。提供这些说

16、明的 同时需要提供界面供用户参考。在提供操作步骤一节内容时，本节提供当前 界面上所有参数的详细说明。参数描述次序 依据界面排列情况决定，一般遵循如下原 则：(1)从左至U右从上到下参数描述的详细要求参见参考-03-07-参数描述写作模板 说明：如果以联机帮助形式提供本指南，参数说明 使用单独的页面提供。操作说明界面提供到 该页面的链接。5. 相关主题（可选） 本节介绍当前操作相关的一些信息，包括但 不限于：背景知识执行任务需要掌握的原理或概念。可以说 明，也可以提供信息的参考路径。操作结果可以供当前操作参考的操作 例如，“查询帐号信息”作为“开户”相关 主题；因为操作员可能需要了解一下还有那

17、些空闲帐号。与当前操作近似的操作例如，停机保号作为销户的相关主题。影响当前操作结果的操作2.3这类操作并非执行当前操作的前提条件，但 是会对当前操作产生影响。例如，“调整报 表结构”作为“打印报表”的相关主题。【样例】如果觉得报表风格不能满足你的需要，可以 参考“ 2.8调整报表结构”修改报表的风格客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。第3章业务数据操作3.13.1.1PPS业务数据操作PPS业务用户数据操作1操作说明2. 操作前提（可选）3. 操作步骤（可选）4. 参数说明/界面元素说明3.1.25. 相关主题（可选）手工充值1. 操作说明2. 执行

18、前提（可选）3. 操作步骤（可选）4. 参数说明/界面元素说明5. 相关主题（可选）23.23.2.1客户端操作指南错误!文档中没有指定样式的文字。 错误!文档中没有指定样式的文字。附录A参数汇总如果本指南以联机帮助形式提供，本附录属 于必选内容；其他方式提供，本附录作为可 选内容。本章按照菜单次序依次介绍各个界面上的 参数。二级标题和菜单根目录对应，三级标 题和各个菜单项对应。参数描述的详细要求参见：参考-03-07-参数 描述写作模板。每个界面的参数说明需要同时提供一个不 包含任何数据的截图。说明：如果以联机帮助形式提供本指南，参数汇总 单独作为一页，提供到各个界面参数说明业 务的链接即可。4引言简要说明本章的主要内容，反映本章的