指南编写使用手册

指南编写使用手册

拟制日期评审人日期批准日期

修订记录

目录

1目的 (5)

2范围 (5)

3术语和缩略语 (5)

4指南编写 (5)

4.1通用编写规则 (5)

4.1.1通用事项 (5)

4.1.2使用Word形式的要求 (6)

4.1.3使用Excel形式的要求 (7)

4.1.4使用Visio形式的要求 (8)

4.1.5使用PPT形式的要求 (8)

4.2工具指南的编写 (9)

4.2.1通用事项 (9)

4.2.2特殊事项 (9)

4.3方法指南的编写 (10)

4.3.1通用事项 (10)

4.3.2特殊事项 (10)

4.4Procedure的编写 (10)

4.4.1通用事项 (10)

4.4.2特殊事项 (10)

4.5Criteria的编写 (13)

4.5.1通用事项 (13)

4.5.2特殊事项 (13)

4.6Regulation的编写 (14)

4.6.1通用事项 (14)

4.6.2特殊事项 (14)

5模板与实例 (14)

5.1模板 (14)

5.2实例 (14)

6相关过程 (15)

7参考文献 (15)

8附录 (15)

表目录

表1术语和缩略语 (5)

图目录

图1跨职能流程图样例1 (12)

图2跨职能流程图样例2 (13)

1 目的

为保证公司的指南、规程、规范、制度编写能够采用有效和科学的方法进行，编写本指南。

2 范围

适用于组织内所有指南、规程、规范、制度的编写。

3 术语和缩略语

表1术语和缩略语

4 指南编写

4.1 通用编写规则

4.1.1 通用事项

1. 不论是用哪种工具、哪种格式书写指南、规程、规范、制度，都不可缺少以下部

分的说明：

文档目的

☞把握好文档的定位：是给出指导供参考还是强制性的规程、规范和制度。

☞区分是使用型文档，还是指导性文档。

文档范围

☞清楚主要受众对像是谁，次要受众对像是谁

☞在哪些范围内使用

术语与缩略语

☞术语：当撰写技术条目时，对于某些特定的领域，通常会有很多“术语”或者“行话”。这些术语应该是由定义的或者至少存在一种另外的语言的对

应，所以非技术性的读者可以同时学到术语并且了解在该领域这些术语是怎

么使用的。

☞术语标准：以各种专用术语为对象所制定的标准，称为术语标准。术语标准中一般规定术语、定义（或解释性说明）和对应的外文名称。

☞文档中术语和缩略语表中的术语应遵从行业标准或规范。

☞缩略语：

◆行业(专业)缩略语是指一个行业或领域所运用的特定缩略语。这些缩略

语不会引起释意混乱。如，在化学领域用字母c代表carbon，用字母ca

代表calcium。

◆在行文中，把英语词的音节加以省略或简化而产生的词。

◆在行文中，把原来复杂的中文词语用相同意义的简短中文词表达。

☞文档术语和缩略语表中，涉及行业、领域的缩略语，应遵从行业标准或规范。

☞术语和缩略语表应覆盖文中所有的仅在本文档内出现的局部术语及缩略语。

全局性的术语和缩略语，可以引用OSSP中的《标准名词术语表》。

☞全文中术语及缩略语的使用必须与术语和缩略语表中的一致。

2. 书写指南、规程时，最好做到图文并茂，能够显得生动、易于理解。

3. 标题应准确、简练、醒目，能够方便读者定位及吸引读者阅读。

4.1.2 使用Word形式的要求

1. 编写文档说明

根据4.1.1 通用事项中第1条的说明，Word文档中应当有专门的章节，来描述文档的一些基本信息，包括：

☞文档目的

☞文档范围

☞术语与缩略语

这些基本信息的书写，请参考4.1.1 通用事项的说明和要求。

2. 帮助信息的编写

不推荐在Word中通过添加批注的方式，书写帮助信息。因为Word会把批注放在文档的右边，显得较凌乱。

需要对某一个字、词、句子做出进一步说明时：

☞方法1：可以使用添加尾注的形式进行说明，

或者

☞方法2：当文中的术语很多时，可以不将术语纳入术语和缩略语表中，而专门建立一个“Glossary”附录，

以保证阅读的连贯性。推荐使用方法2，而不推荐使用方法1。

☞当使用方法1来书写尾注时，要有“关键词/Keywords”，方便读者根据关键词进行全文检索。

对于步骤类条目，推荐图文并茂进行描述，不要只有文字说明或者只有流程图。

4.1.3 使用Excel形式的要求

1. 编写单独的Introduction Sheet

根据4.1.1 通用事项中第1条的说明，Excel文档中可以并应当有一个单独的Introduction Sheet，来说明文档的一些基本信息，包括：

☞文档目的

☞文档范围

☞术语与缩略语

这些基本信息的书写，请参考4.1.1 通用事项的说明和要求。

2. 通过增加单元格批注来编写帮助

当Excel中一个Sheet内，需要为单元格增加批注的情况比较少时，可以直接通过为单元格增加批注的方式，来指导用户的阅读和使用。

增加批注后，可以根据对一些重要的批注进行显示：右键点击单元格，选择“显示批注”。

显示的批注尽量放置在不影响阅读的位置。

显示的批注可以选择有对比的填充颜色，以方便引起读者的注意。

3. 编写单独的Help Sheet 页来编写帮助

当Excel中一个Sheet内，需要为单元格增加批注的情况比较多时，或者某条批注的字数过多而不适宜放在批注里时：

当读者需要按照某些步骤使用和填写时：

规则如下：

☞需要单开一个“Help”Sheet，来帮助读者阅读和使用。