网易的《软件教程写作规范》

2010-08-28 10:49:27来源:西部e网作者:

今天看到网易投稿的写作规范,觉得还不错,可以一些常写教程的朋友做参考:

  写作规范:《名词术语统一

在计算机的使用过程中形成(或统一规定)了一批大家熟悉、认可的术语(或常用语)。为保证准确性、易读性、普及性及提高书稿质量,使用术语(或常用语)应严格做到标准化及全书一致、图文一致,对屏幕上各控件名称的引用和叙述尤其要准确无误。下面列出了Windows中常用术语的规范要求,未列部分及其他软件参照相应的工具书(如《英汉计算机词汇》第二版,清华大学出版社,1997年)。

(1)鼠标操作

单击:按一下鼠标左键。可统一为“选择”,但不用“点击”、“点取”等。

右击:按一下鼠标右键。

双击:连续快按两下鼠标左键。

拖动:按下鼠标左键同时移动鼠标,将屏幕界面中的对象移动到指定位置。

(2)键盘操作

按:在操作过程中,使用键盘上的按键执行某一命令时,叙述为“按某某键”(不应叙述为“键入某某键”),指输入单个键或一个组合键。

键(输)入:需要在界面上的文字编辑区或文本框中输入连续性的文字时,叙述为“键入某某”或“输入某某”,指输入字符串。

键盘上一般称为“键”,屏幕界面上一般称为“按钮”。

(3)屏幕信息分类

屏幕信息分为桌面、窗口、菜单、对话框等。

桌面:指计算机屏幕,如Windows的桌面由“开始”按钮、任务栏、图标、空白区组成。

窗口:指某一应用程序的使用界面,其中包括标题栏、菜单栏、工具栏、状态栏、最小化按钮、最大化/还原按钮、关闭按钮、滚动条(或称滑块)、窗口边框、编辑区、控制菜单图标等,如图1所示。

菜单:菜单是程序提供给用户执行功能的接口,典型的菜单如图2所示。菜单名列在菜单栏中,引用时应表达为如“打开‘编辑’菜单”的形式。

图2 典型菜单

1)菜单项:其类型包括普通菜单项,如图中“粘贴”命令;灰色菜单项,如图中“复制”命令,表示在当前情形下不能被选取;带“…”的菜单项,如图中“查找”命令,选择后会弹出一个相应的对话框;带三角的菜单项,如图中“排列图标”命令,选择后会弹出下一级菜单(称为级联菜单)。文中叙述时统一为只用其名称,不带“…”、三角等符号。

2)命令(或称为选项、菜单项,统一用一种):菜单中所列出的各种执行命令。

3)快捷键:指菜单项后面列出的组合键名,表示不打开菜单而直接按下该组合键即可执行该命令。

4)命令字母:指菜单项后面()中带下划线的英文字母,表示打开菜单后按该字母键也可执行该命令。

5)分隔线:对菜单按功能进行分组。

6)级联菜单:选择带三角符号的菜单项时弹出的下一级菜单(子菜单)。

7)快捷菜单:在Windows中用鼠标右键单击对象时弹出的菜单。

对话框:使用某一应用程序执行基本命令时弹出的矩形区域。对话框中包括标题栏、文本框、列表框、下拉列表框、选项区域(组)、按钮、单选按钮、复选框、微调按钮、标尺以及标签、选项卡等,如图3所示。

1)标题栏:位于对话框顶部,用于标识对话框的名称。

2)文本框:用于输入文本内容的空白区域。

3)列表框:列出已有文本选项供选择。

4)下拉列表框:单击右侧的下三角按钮后弹出一列表。

5)选项区域(组):将用于同一功能的所有选项用一个方框框住,形成一个区域,这个区域称为选项区域或选项组。

6)按钮:对话框中的一种控件,其上标有控件功能。有些按钮单击后会弹出相应的对话框。

7)单选按钮:一组选项中必须且只能选中一种,选中后其圆形按钮中出现黑点。

8)复选框:可同时选中多个选项或不选,选中后其方形框中出现“对号”标记。

9)微调按钮:一种特殊的文本框,其右侧有向上和向下两个按钮,用于对该文本框中的内容(一般为数字)进行调节。

10)标签:在Windows中有些对话框包含多组内容,用标题栏下的一排标签标识,标签上标有对应该组内容的名称。

11)选项卡:单击标签后出现的每一组内容称为选项卡,选项卡由标签命名。

12)标尺:指示数值变化大小的一种控件。

图3 对话框及其组成

2.文本约定

(1)键名

在文中描述键盘输入时应严格遵循以下规则:

键名的引用一定要与键盘上对该键的描述严格相符。有单词组成的按键书写方式如下:

Insert(Ins) Home PgUp(Page Up) PgDn(Page Down)Delete(Del) Num Lock End Esc

Caps Lock Shift Alt Ctrl

Space(空格键) Back Space(退格键) Print Screen

Sys Rq Scroll Lock Pause Break

Enter(回车键) Tab F1~F12

对组合键的描述:组合键是指在执行某一命令时,同时使用两个或两个以上键盘按键。在叙述组合键时,每个按键之间应用“+”号进行连接,例如:Alt+E键是指同时使用Alt和E键; Ctrl+Shift+E键则表示同时使用Shift、Ctrl、E键。组合键的书写顺序为Alt、Ctrl、Shift,比如Alt+Ctrl+Shift+E。

3.键名不要用任何标识符号进行标识,直接书写,即不要用引号、方括号标出。

(2)容易混淆的字、词

以下一些字、词很容易混淆,编辑、写作或翻译时应统一:

与“像”有关的词:图像、录像、摄像、像素、镜像、好像、像……一样

与“象”有关的词:对象、抽象、象征、象限、大象、景象、想象

“缺省设置”统一为“默认设置”;“你”统一为“您”

其他词:其他、分辨、通讯簿、账号、坐标,惟一

注意“的”、“地”、“得”的用法

(3)操作步骤

计算机类文章的主要特点之一是操作性强,这就要求文中操作的叙述一定要准确。叙述时应从大到小锁定所引用的对象:窗口→菜单→命令(菜单项);对话框→选项卡→选项区域→按钮(选项)等控件名。要求叙述完整,不要省略。

例如,在Word中打开一个已知的文件,其操作叙述过程如下:

1) 在桌面上双击Word应用程序图标,打开Word应用程序窗口。

2) 打开“文件”菜单,选择“打开”菜单项(或命令),出现“打开”对话框。

3) 在“打开”对话框中完成各种控件的选择和设置。

4) 单击“打开”按钮,打开指定的文件。

(4)标点符号

标点能起到明晰层次,易于理解,不致引起歧义和逻辑错误,保证句子完整的作用,因此,有关人员一定要多学习国标《标点符号用法》,用好每一个标点符号。例如:每一层次叙述完后用句号(。),尽量不用分号(;);列举并列内容时一般用分号(;);列举并列词语时一般用顿号(、)而不用逗号(,),英文单词参照此项或全书统一用逗号。低层次的标点中不能包含高层次的标点,如用分号(;)隔开的内容中不能包含句号(。)。

(5)外文单词拼写、大小写

关键词:规范

赞助商链接: