指南编写使用手册拟制日期评审人日期批准日期修订记录目录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，来帮助读者阅读和使用。

☞在书写帮助时，要指明这条是针对哪个Sheet页里的哪一个单元格、哪一行、哪一列进行的说明，或者通过增加超级链接来进行导航。

☞对于帮助条目，要有一列“关键词/Keywords”，方便读者根据关键词进行全文检索。

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

4.1.4 使用Visio形式的要求1. 编写单独的Introduction Sheet推荐使用Visio进行图的绘制，并不推荐全部使用Visio来编写指南类文档。

根据4.1.1 通用事项中第1条的说明，Visio文档中可以并应当有一个单独的Introduction Sheet，来说明文档的一些基本信息，包括：☞文档目的☞文档范围☞术语与缩略语这些基本信息的书写，请参考4.1.1 通用事项的说明和要求。

2. 编写单独的Help Sheet 页来编写帮助不推荐在Visio中通过添加批注的方式，书写帮助信息。

因为Visio本来就以图形居多，再增加批注，会显得很凌乱。

当读者需要按照某些步骤使用和填写时，增加一个单独的“Help”Sheet页，规则如下：☞在书写帮助时，要指明这条是针对哪个Sheet页的哪个部分说明。

☞对于帮助条目，要有“关键词/Keywords”，方便读者根据关键词进行全文检索。

对于步骤类条目，推荐图文并茂进行描述，不要只有流程图，以方便读者理解。

4.1.5 使用PPT形式的要求1. 编写文档的Introduction PagesPPT形式的文档，一般会应用于指南类文档中，用来指引读者使用某种工具或方法，更类似一种自学教材。

根据4.1.1 通用事项中第1条的说明，PPT文档中可以并应当有文档的Introduction Pages，来说明文档的一些基本信息，包括：☞文档目的☞文档范围☞术语与缩略语这些基本信息的书写，请参考4.1.1 通用事项的说明和要求。

2. 编写目录/Contents Page来导航对于PPT里介绍的信息，有且应该有一个专门的目录/Contents Page，来方便读者进行阅读跳转。

在每一个部分开始前，都应该有这个目录/Contents Page。

即将开始部分的目录，应不同于其他目录条目，进行显示。

3. 对于步骤讲解，推荐使用PPT里的动画效果，以方便读者再现步骤和理解。

4. 参考资料或信息，推荐写在该部分内容的所在页下方的备注里。

4.2 工具指南的编写4.2.1 通用事项请参考4.1 通用编写规则里的说明，根据文档的需要，灵活选取Word、Excel、Visio、PPT 的形式。

4.2.2 特殊事项1. 编写工具指南的目的是为了使读者能够学会如何使用某种工具，并规避使用工具时的常见问题。

2. 编写工具指南时，可以参考以下几点：需要明确是为工具的哪个版本、哪种语言而编写的使用指南。

推荐在文档的前部，为工具做一个简单的概况介绍，以方便读者理解工具背后所引用的思想，从而更好的使用工具。

在描述步骤的时候，建议不仅单描述操作，也增加一项“注意事项”，可以提醒读者注意使用中的问题。

在叙述如何使用时，推荐举例和图文并茂的方式来进行。

建议在需要的情况下，单列一个章节，描述工具使用中的常见错误，以帮助读者加深理解。

4.3 方法指南的编写4.3.1 通用事项请参考4.1 通用编写规则里的说明，根据文档的需要，灵活选取Word、Excel、Visio、PPT 的形式。

4.3.2 特殊事项1. 编写方法指南的目的是为了使读者能够理解方法的原理，并掌握其使用。

2. 编写方法指南时，可以参考以下几点：推荐在文档的前部，开辟一个单独的章节，阐述方法所引用的思想背景，以便于读者进一步理解。

在描述方法的时候，建议不仅描述方法，也增加一项“注意事项”，可以提醒读者注意使用中的问题。

在叙述方法的使用时，推荐举例和图文并茂的方式来进行。

当某种方法在不同场景有不同的使用时，推荐每一种场景举一个例子，以加深读者的理解。

当某种方法需要引用系数表或者常数表时，推荐将系数表或者常数表放入附录/ Appendix中。

4.4 Procedure的编写4.4.1 通用事项请参考4.1 通用编写规则里的说明，根据文档的需要，不推荐Excel、PPT形式进行书写，而推荐Word、Visio的形式。

4.4.2 特殊事项1. 规程：规则章程，指具体劳作所遵循的规范、程序和要领。

2. 编写的规程的目的是为了使我们的工作按照一定的步骤进行。

3. 编写规程时，可以参考以下几点：规程的书写类似过程的书写，但是没有过程的概念所含的内容广，往往是针对过程中某个子过程的补充说明。

推荐使用过程模板来编写规程，需要注意：☞Process Description 过程描述应变更为Procedure Description 规程描述。

☞Procedure Description 规程描述下应包括：◆Roles and Responsibilities 角色和职责：规程图中各个角色及其职责的定义，及在规程图里的互动关系。

◆Entrance Criteria 入口准则：需要说明规程的使用时机，即在什么情况下应引用此规程。

◆Inputs 输入◆Activities 活动◆Outputs 输出◆Exit Criteria 出口准则☞规程文档中需要包含Resources and Tools 资源和工具的描述。

☞规程文档中需要包含Configuration Management and Assets 配置管理和资产的描述。

☞规程文档中需要包含Training 培训的描述，本部分内容不可裁剪。