指南编写使用手册.doc

《指南编写使用手册.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、文档编号密级内部公开文档版本共15页指南编写使用手册拟制日期评审人日期批准日期修订记录日期修订版本修改章节修改描述作者目录1目的52范围53术语和缩略语54指南编写54.1通用编写规则54.1.1通用事项54.1.2使用Word形式的要求64.1.3使用Excel形式的要求74.1.4使用Visio形式的要求84.1.5使用PPT形式的要求84.2工具指南的编写94.2.1通用事项94.2.2特殊事项94.3方法指南的编写104.3.1通用事项104.3.2特殊事项104.4Procedure的编写104.4.1通用事项104.4.2特殊事项104.5Criteria的编写134.5

2、.1通用事项134.5.2特殊事项134.6Regulation的编写144.6.1通用事项144.6.2特殊事项145模板与实例145.1模板145.2实例146相关过程157参考文献158附录15表目录表1术语和缩略语5图目录图1跨职能流程图样例113图2跨职能流程图样例2131目的为保证公司的指南、规程、规范、制度编写能够采用有效和科学的方法进行，编写本指南。1范围适用于组织内所有指南、规程、规范、制度的编写。2术语和缩略语表1术语和缩略语缩略语中文名英文名解释备注PPT幻灯片PowerPointOffice常用的一种文档类型3指南编写3.1通用编写规则3.1.1通用事项1.不

3、论是用哪种工具、哪种格式书写指南、规程、规范、制度，都不可缺少以下部分的说明：@文档目的F把握好文档的定位：是给出指导供参考还是强制性的规程、规范和制度。F区分是使用型文档，还是指导性文档。@文档范围F清楚主要受众对像是谁，次要受众对像是谁F在哪些范围内使用@术语与缩略语F术语：当撰写技术条目时，对于某些特定的领域，通常会有很多“术语”或者“行话”。这些术语应该是由定义的或者至少存在一种另外的语言的对应，所以非技术性的读者可以同时学到术语并且了解在该领域这些术语是怎么使用的。F术语标准：以各种专用术语为对象所制定的标准，称为术语标准。术语标准中一般规定术语、定义（或解释性说明）和对应

4、的外文名称。F文档中术语和缩略语表中的术语应遵从行业标准或规范。F缩略语：u行业(专业)缩略语是指一个行业或领域所运用的特定缩略语。这些缩略语不会引起释意混乱。如，在化学领域用字母c代表carbon，用字母ca代表calcium。u在行文中，把英语词的音节加以省略或简化而产生的词。u在行文中，把原来复杂的中文词语用相同意义的简短中文词表达。F文档术语和缩略语表中，涉及行业、领域的缩略语，应遵从行业标准或规范。F术语和缩略语表应覆盖文中所有的仅在本文档内出现的局部术语及缩略语。全局性的术语和缩略语，可以引用OSSP中的《标准名词术语表》。F全文中术语及缩略语的使用必须与术语和缩略语表中

5、的一致。1.书写指南、规程时，最好做到图文并茂，能够显得生动、易于理解。2.标题应准确、简练、醒目，能够方便读者定位及吸引读者阅读。1.1.2使用Word形式的要求1.编写文档说明@根据4.1.1通用事项中第1条的说明，Word文档中应当有专门的章节，来描述文档的一些基本信息，包括：F文档目的F文档范围F术语与缩略语@这些基本信息的书写，请参考4.1.1通用事项的说明和要求。2.帮助信息的编写@不推荐在Word中通过添加批注的方式，书写帮助信息。因为Word会把批注放在文档的右边，显得较凌乱。@需要对某一个字、词、句子做出进一步说明时：F方法1：可以使用添加尾注的形式进行说明，或者F

6、方法2：当文中的术语很多时，可以不将术语纳入术语和缩略语表中，而专门建立一个“Glossary”附录，以保证阅读的连贯性。推荐使用方法2，而不推荐使用方法1。F当使用方法1来书写尾注时，要有“关键词/Keywords”，方便读者根据关键词进行全文检索。@对于步骤类条目，推荐图文并茂进行描述，不要只有文字说明或者只有流程图。1.1.1使用Excel形式的要求1.编写单独的IntroductionSheet@根据4.1.1通用事项中第1条的说明，Excel文档中可以并应当有一个单独的IntroductionSheet，来说明文档的一些基本信息，包括：F文档目的F文档范围F术语与缩略语@这

7、些基本信息的书写，请参考4.1.1通用事项的说明和要求。2.通过增加单元格批注来编写帮助@当Excel中一个Sheet内，需要为单元格增加批注的情况比较少时，可以直接通过为单元格增加批注的方式，来指导用户的阅读和使用。@增加批注后，可以根据对一些重要的批注进行显示：右键点击单元格，选择“显示批注”。@显示的批注尽量放置在不影响阅读的位置。@显示的批注可以选择有对比的填充颜色，以方便引起读者的注意。3.编写单独的HelpSheet页来编写帮助@当Excel中