客户端操作指南写作模板.docx

资源描述

客户端操作指南写作模板.docx

《客户端操作指南写作模板.docx》由会员分享，可在线阅读，更多相关《客户端操作指南写作模板.docx（17页珍藏版）》请在冰点文库上搜索。

客户端操作指南写作模板.docx

客户端操作指南写作模板

产品线业务与软件产品线

密级

话音域

机密

共22页

客户端操作指南写作模板

拟制

日期

2005-9-8

评审人

项目组成员

日期

批准

日期

签发

日期

华为技术有限公司

（仅供内部使用）

修订记录

日期

修订

版本

修改

章节

修改描述

作者

2005-09-09

试用稿

初稿完成

杨健

写作总指导

写作侧重点

定位

作为客户端使用者的参考书，提供所有客户端界面信息。

特点

同业务操作手册相比，本手册有以下特点：

●基于客户端界面组织，不关注任务；

●需要详细说明界面上的各个元素，包括参数说明。

特别声明

客户端使用指南通常以联机帮助的形式提供。

写作难点/注意事项

参数说明信息需要完整、详细，具有指导意义。

关于本手册

写作模板采用资料部统一的aboutthismanual模板。

如果资料部未统一推行该部分，删除本节。

第1章快速入门（可选）

本章属于可选写作内容，由作者根据实际情况选择写作。

本章的介绍业务的基本定。

读者阅读本章后应该了解业务的核心特征。

引言简要说明本章的主要内容，反映本章的写作目的。

读者阅读该概述后，应该明确是否还需要继续阅读本章的内容。

需要特别注意或声明的内容可酌情写在此处。

【样例】

本章首先介绍了PPC_SMAP的功能，然后详细介绍PPC_SMAP的界面以及登录注销方法。

通过阅读本章，您可以快速掌握操作PPC_SMAP需要了解的基本信息。

1.1了解PPC_SMAP

这里简单说明客户端和业务的关系。

【样例】

PPC_SMAP是PPC业务的核心管理工具，您可以通过该终端管理所有PPC业务的业务数据。

下面首先介绍什么是PPC业务，然后详细介绍PPC_SMAP的主要功能。

1.1.1PPC业务定义

本节给出业务的详细定义，重点说明业务的核心特征。

本节的介绍要求通俗易懂，少用专业词汇。

尽量采用类比、举例等方式，避免突然引入太多的新概念。

【样例】

PPS业务是基于CDMA（codedivisionmultipleaccess）网络或者GSM（globalsystemformobilecommunication）网络的一种智能业务。

同传统的移动网络用户相比，PPS用户需要预先缴纳一定的费用才可以发起呼叫或者使用其它的业务特性。

每次呼叫结束时，系统会从PPS用户预先缴纳的费用扣除通话费用。

1.1.2PPC_SMAP的主要功能

这里应该给出PPC_SMAP功能的概要介绍。

描述尽量概要简短，从用户应用角度适当提炼，不应该仅仅是菜单的罗列。

例如：

分为系统管理（操作员权限管理等）、业务受理（enduser需求的处理）和数据统计（报表等）。

【样例】

PPC_SMAP是PPC业务的业务数据管理终端。

您可以通过该终端维护PPC用户的业务数据，受理各种PPC业务请求。

PPC业务的主要功能包括：

●系统管理

………………

●业务受理

………………

●数据统计

………………

1.2PPC_SMAP操作基础

1.2.1登录PPC_SMAP

本节以stepbystep的方式介绍客户端的登录方法。

【样例】

DoubleclickthePPC_SMAPshortcuticon

onthedesktop.

登录对话框出现，如图所示。

Entertheoperator’susernameandpassword.

ThedefaultusernameandpasswordareeppcadmandTELLIN.

ClickOK.

PPC_SMAP系统管理窗口出现，如图所示。

SelectServiceData>EPPCService.

PPC_SMAPservicemanagementwindow出现，如图所示.

1.2.2PPC_SMAP界面简介

简要介绍管理界面的结构、菜单、快捷按钮等。

如果系统提供管理权限控制功能，需要介绍界面操作同操作员权限的关系。

●对于首次使用客户端的用户

可以通过该部分介绍熟悉界面，了解系统功能。

●对于比较熟悉客户端的用户

可以参考这部分内容迅速查找到任务的入口。

【样例】

EPPC_SMAP的界面由菜单、工具条和操作区三个部分组成，如图1-1所示。

图1-1EPPC_SMAP操作界面

各个部分的详细说明如下：

菜单

这里需要详细说明菜单结构、功能及权限。

如果不涉及权限问题，可以删除权限一列。

【样例1】

菜单结构

说明

权限

系统

密码更改

选择该菜单修改自己的密码。

系统管理员

日志浏览

选择该菜单查看日常的操作日志。

系统管理员

返回主界面

选择该菜单注销，进入登录界面。

操作员

业务数据

PPS用户数据管理

………………

……

PPS业务用户数据

………………

……

手工充值

………………

……

用户挂失

………………

……

【样例2】

表1-1［业务管理］菜单功能说明

[业务管理]菜单展开项

操作员级别

工具条

这里要详细介绍工具条每个图标的功能。

【样例】

图标

名称

功能

用户数据查询

查询PPS用户的数据

手工充值

操作员对用户的帐户进行手工充值

挂失

挂失PPS用户的储值卡

解挂失

解挂失用户的储值卡，使其用户状态返回挂失前的状态

激活

激活PPS用户数据

去激活

去激活PPS用户数据

批量开户

进行批量开户操作

批量销户

进行批量销户操作

关于SMAP

查看SMAP的版本、版权信息

返回主界面

退出PPS业务的操作界面，返回SMAP平台界面

操作区

这里需要给出典型的操作界面以及按钮说明。

【样例】

选择某一菜单后，操作区会显示对应的数据管理对话框，供您管理业务数据。

图1-2给出了典型的PPS_SMAP操作界面。

图1-2PPS_SMAP典型操作界面

图1-2中各个按钮的说明如表1-1所示。

表1-1典型按钮说明

按钮

功能

条件

执行查询操作前，您需要单击<条件>按钮，然后才可以输入查询条件。

查询

输入查询条件后，单击<查询>按钮，可以查询到符合要求的信息。

插入

………………………………

……

………………………………

……

………………………………

1.2.3注销

本节以stepbystep的方式介绍客户端的注销方法。

【样例】

确认光标停留在PPC_SMAP业务managementwindow.

SelectSystem>Return或者Click

onthetoolbar.

PPC_SMAPsystemmanagementwindow出现。

SelectSystem>Exit.或者Click

onthetoolbar.

Adialogboxwillappear,saying"AreyousuretostoprunningtheSMAP?

ClickYes.

第2章系统操作

按照菜单结构介绍各个界面的操作，目录结构和导航树对应。

导航树上的每个根节点对应一章，然后依次向下安排二级标题和三级标题。

引言简要说明本章的主要内容，反映本章的写作目的。

读者阅读该概述后，应该明确是否还需要继续阅读本章的内容。

需要特别注意或声明的内容可酌情写在此处。

【样例】

本章详细介绍system菜单下所有各个子菜单的功能。

通过阅读本章，您可以了解到System类界面操作的详细说明。

2.1更改密码

1.操作说明

…………

2.操作前提（可选）

………………

3.操作步骤（可选）

………………

4.参数说明/界面元素说明

………………

5.相关主题（可选）

………………

2.2查看日志

1.操作说明

用户阅读操作说明后，可以明确是否执行该操作。

操作说明可以包括但不限于以下内容。

●什么情况下执行该操作

可以采用说明操作目的、意义的方式提供该类信息。

●执行结果

操作执行结果、执行后的状态等说明信息。

不可逆转或危险性操作要给出警告说明。

【样例】

当用户提出不再使用PPS业务时，可以为用户销户。

销户成功后，用户的业务数据将被删除，用户将不能再使用PPS业务。

注意

用户销户后，所有用户数据将被删除，无法再恢复。

2.操作前提（可选）

用户阅读操作前提后，应该明确自己是否可以执行任务。

操作前提可以包括但不限于以下内容。

●操作权限要求

例如，只有超级管理员才可以清除黑名单。

也可以包括技能要求，并给出参考信息的位置。

●前置任务/执行环境要求

例如，完成操作系统安装后才能安装数据库。

存在前置任务时，可以给出参考路径。

【样例】

处于正常使用状态的用户才可以销户；处于欠费停机状态的用户需要恢复至正常状态才能销户。

停机状态用户恢复至正常状态的方法请参见“2.5复机”。

3.操作步骤（可选）

如果操作界面较为简单，基本不涉及操作步骤，可以不提供本部分内容。

此时，参数说明部分扩展为界面元素说明。

对步骤的说明应该简单，采用动宾结构的语句，基本风格参考样例。

如果采用联机帮助的形式提供本指南，需要注意以下两点：

●无需提供操作界面截图

●同一页面中如果存在多个子操作任务，使用折叠形式并列提供。

例如：

“增加用户数据”和“查询用户数据”的详细步骤作为“用户管理数据”页面中的两个折叠。

【样例】

选择[业务管理/业务用户数据管理]菜单项，进入业务数据管理页面。

这里插入操作界面截图。

在该页面中，您可以执行以下操作：

查询用户信息

在“电话号码”文本框中输入12345678。

这里插入操作界面截图。

单击<查询>按钮。

…………

增加用户信息

单击<增加>按钮。

填写用户信息。

这里插入操作界面截图。

单击<保存>按钮。

4.参数说明/界面元素说明

在没有提供操作步骤一节内容时，本节提供当前界面所有元素的说明，包括参数和按钮等用户可操作控件的说明。

提供这些说明的同时需要提供界面供用户参考。

在提供操作步骤一节内容时，本节提供当前界面上所有参数的详细说明。

参数描述次序依据界面排列情况决定，一般遵循如下原则：

（1）从左到右

（2）从上到下

参数描述的详细要求参见《参考-03-07-参数描述写作模板》。

&说明：

如果以联机帮助形式提供本指南，参数说明使用单独的页面提供。

操作说明界面提供到该页面的链接。

5.相关主题（可选）

本节介绍当前操作相关的一些信息，包括但不限于：

●背景知识

执行任务需要掌握的原理或概念。

可以说明，也可以提供信息的参考路径。

●操作结果可以供当前操作参考的操作

例如，“查询帐号信息”作为“开户”相关主题；因为操作员可能需要了解一下还有那些空闲帐号。

●与当前操作近似的操作

例如，停机保号作为销户的相关主题。

●影响当前操作结果的操作

这类操作并非执行当前操作的前提条件，但是会对当前操作产生影响。

例如，“调整报表结构”作为“打印报表”的相关主题。

【样例】

如果觉得报表风格不能满足你的需要，可以参考“2.8调整报表结构”修改报表的风格。

2.3……

……

第3章业务数据操作

……………………

3.1PPS业务数据操作

3.1.1PPS业务用户数据操作

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缩略语表

如果有术语，也需要有术语表，术语表在缩略语表前，单独一个附录。

CAA

ClientAccessAgent

客户接入代理

C/S

Client/Server

客户机/服务器体系结构

CMP

CardManagementPoint

资源管理台

DNS

DomainNameServer

域名服务器

HTTP

HyperTextTransportProtocal

超文本传输协议

HTML

HyperTextMarkupLanguage

超文本标识语言

HLR

HomeLocationRegister

归属位置寄存器

展开阅读全文