知识转移矩阵管理培训-nc6产品帮助编写

NC6产品帮助——编写规范NC产品方案与国际化部2015.02编写规范总体说明模板及示例内容规范编写人自测一、总体说明编写工具编写环境编写语言帮助文件分类帮助文件命名图片格式及命名1.1编写工具1.推荐用户使用Dreamweaver5CS，所有模板都是通过该工具制作。2.如果编写者暂时无法使用Dreamweaver5CS软件，可以选择FrontPage等其他标准html网页编制工具。为了保证兼容性请务必使用新编辑工具，将模板文件进行预览，确认无问题后，再更换编辑工具。1.2编写环境-11.将附件压缩包NChome.rar下载到本地，解压后为编写环境。2.路径：..\NChome\hotwebs\help\simpchn\帮助示例，是6个类型的帮助示例。方便起见，建议直接复制后修改内容。3.帮助文档中的截图请以保存为PNG格式，并存放于“..\hotwebs\help\simpchn\imges”目录中。4.术语文件、参数文件存放于“..\hotwebs\help\simpchn”目录中。1.3编写环境-2领域号领域领域号领域07XBRL60人力资本10动态建模平台80商业分析11Web应用平台C0质量管理12集成平台CA客户关系管理13应用管理平台CH渠道管理14计划平台CR零售管理18企业绩效管理E1网上报销20财务会计E2HR自助服务36资金管理E3协同办公38管理会计EC电子商务40供应链G0企业治理45资产管理MC媒体接入48项目管理UM统一会员管理4S供应商管理simpchn公共帮助50生产制造5.各领域功能节点帮文件存放于“..\hotwebs\help\simpchn\帮助示例”目录中，此级目录正式环境用领域功能注册号前两位代替。各个领域目录名称如下:1.3编写语言-31.所有帮助文件编写语言全部采用简体中文，专有名词除外。2.繁体中文、英文翻译均有NC产品方案与国际化部处理。1.4帮助文件分类非末级功能节点末级功能节点领域级模块级功能分类级基础档案类查询与报表类非档案、报表类1.帮助文档共分为2大类：公共帮助、功能节点帮助。2.公共帮助为抽取各个领域、模块中具有共性的，重复率较高的知识、要点，例如：常用功能按钮、操作风格、公式编辑器、术语、参数等。公共帮助可由功能节点帮助进行链接。3.功能节点帮助分为6类：领域级、模块级、功能分类级、基础档案类、查询与报表类、非档案、报表类。4.每一类功能节点帮助均有必须编写和可以选择编写的内容，具体参见后文描述。2.功能节点帮助1.公共帮助1.5帮助文件命名1.末级功能节点帮助文档以系统功能注册编码命名。2.非末级功能节点帮助文件以系统菜单注册号命名。3.所有帮助文档后缀为html，例如：2004030201.html。1.6图片格式及命名所有图片都保存为png格式。图片所属以帮助文件名称+两位流水号命名，例如2004030201.html帮助文档中的图片，按照从上到下的浏览次序，可分别命名为：2004030201-01.png、2004030201-02.png、2004030201-03.png等。注意：如果原始图片为viso格式，在转成PNG格式后请保留同名viso格式图片，在提交帮助的时候一并提交。二、模板及示例模板说明示例说明模板说明非末级功能节点末级功能节点领域级模块级功能分组级基础档案类非档案、报表类查询与报表类模板类型模板编号100210031004100110051006帮助模板类型分为6类：领域级、模块级、功能分类级、基础档案类、查询与报表类、非档案、报表类。每一类帮助模板均有必须包括的编写内容，具体参见后文描述。1.概述￭必选￭对该产品领域业务范围、特点进行简要描述，并绘制领域架构图。模板说明领域级10022.目标￭必选￭按照该领域的解决方案组合方式，对解决方案目标进行描述。￭例如：供应链可分为采购库存解决方案、销售分销解决方案；资产管理可以分

为资产价值管理、资产实物管理、维修维护管理。3.模块介绍￭必选￭对领域内模块进行简要介绍，重点描述业务功能特点。4.相关术语￭可选￭对领域内的重要术语进行链接。此模板适用于领域级帮助文档的编写，例如：财务会计、资产管理、资金管理。共包括4部分内容：1.概述￭必选￭对该模块的业务功能范围进行简要描述。模板说明模块级10032.基本业务流程￭必选￭对模块内所有业务流程（场景）进行罗列，并链接到相关功能节点帮助页面。3.注意￭可选￭模块的依赖关系，应用过程中特别注意的事项。4.相关术语￭可选￭模块内相关术语的链接。该模板适用于模块级帮助文档的编写，例如：库存管理、销售管理、采购管理等，共包括4个部分内容：1.概述￭必选￭该功能分组的主要业务范围的简单介绍。模板说明功能分组级10042.操作指引￭可选￭如果该功能分组下的功能节点，基于业务场景有一定的先后关系的情况下，建

议绘制操作指引图。3.相关术语￭可选￭本功能组相关术语链接。适用于功能分组菜单的帮助编写，此类节点并没有实体功能界面，共包括3个部分内容：1.概述￭必选￭以业务介绍为重点，简要介绍该档案的业务含义、重要性。模板说明基础档案类10012.关键应用￭必选￭详细介绍档案查询、维护界面的功能按钮、字段。￭例如：删除、新增、启用、停用、禁用、查询等常用功能按钮，若没有特殊业

务逻辑和含义，不必赘述。此类功能按钮会在公共帮助中集中说明。该模板适用编写UAP基础数据、业务模块的基础设置中的基础档案功能节点，共包括6部分内容：3.注意￭可选￭操作中容易出错的、特别重要的内容。4.常见问题￭可选￭操作中容易出错的内容，并给出解决方案，可以适度截图。模板说明基础档案类10016.相关操作￭可选￭此功能节点的关联操作，通常具备业务关联、因果、时间关系。5.相关术语￭可选￭术语必须为产品界面中出现的，同时具有业务含义。￭如果为业界公用术语，尽量使用标准描述。模板说明末级功能节点-非档案、报表类10053.关键应用￭必选￭重点描述功能按钮、字段，可以分为两个显示模式描述：单据卡片、单据列表。

对于在卡片和列表显示模式下都能使用的按钮、字段，建议在单据卡片模式下

进行描述。1.概述￭必选￭该功能节点的主要功能或者业务介绍，可以基于某个重要业务场景再展开说明。2.操作指引￭可选￭如果该功能节点功能操作比较多，并且很多功能按钮之间有先后业务或者操作

次序，建议绘制操作指引图。4.典型应用￭可选￭对于某些需要多个功能按钮、操作步骤一起配合才能顺利完成的业务操作，或

者业务本身就比较复杂的业务操作，客户在使用过程中容易忽略、犯错误，建

议在此部分以向导的方式进行介绍描述，可以适度截图辅助说明。适用于除基本档案、报表查询之外的，所有末级功能节点的帮助文档编写。共包括8部分内容：模板说明5.注意￭可选￭操作中容易出错的、特别重要的内容。8.相关操作￭可选￭在某些业务场景下与此功能节点相关的节点链接。6.常见问题￭可选￭操作中容易出错的内容，并给出解决方案，可以适度截图。7.相关术语￭可选￭与此功能节点相关的术语链接。末级功能节点-非档案、报表类10051.概述￭必选￭该功能节点的主要功能或者业务介绍，可以基于某个重要业务场景再展开说明。模板说明查询与报表类10062.关键应用￭可选￭对于重要查询条件、字段、功能操作进行描述。常用的条件编辑功能、快速查

询、查询方案不需要描述，此部分在公共帮助中进行描述。3.常见问题￭

可选￭用户容易忽略，并容易产生操作错误的内容提醒。4.相关术语￭可选￭报表查询相关术语的链接。此模板适用于报表及查询功能节点的帮助编写，共包括4部分内容：示例说明1.模板更多的是方向性指导，鉴于不同领域产品的特点不同，可对模板进行适度删减进行使用。2.为了方便编写者快速编写帮助文档，我们提供了6类帮助模板示例，编写者可以直接在帮助示例上直接修改。三、内容规范符号规范命名规范表述规范产品截图规范操作指引图规范符号规范编写时必须统一使用下列符号：序号符号名称符号样式举例说明1功能节点【】【资产管理】→【资产使用管理】→【申请管理】→【领用申请】2按钮〖〗〖新增〗、〖辅助功能-冻结〗3快捷键[]新增[Ctrl+N]命名规范产品帮助中对于控件的描述需统一，如下图所示：表述规范1.语句通顺流畅，无错字、丢字、歧义。2.标点符号正确，如果为条目类内容，每个条目后标点请保持一个帮助文档内一致。3.尽可能使用通俗的、业务的、直白的语言。4.不可直接拷贝详细需求内容。5.不可以用名词解释名词，例如：“固定提前期：当前库存组织＋物料的固定提前期”。6.帮助描述内容如果涉及到产品界面上的文字内容，例如：功能节点名称、字段名称、报表抬头等，必须与界面文字完全一致。产品截图规范1.原则上帮助文件不出现产品界面截图，如果在“典型应用”部分有必要配合图片说明，可截取产品局部截图。2.不允许出现产品界面全屏截图。3.图片格式一律保存为PNG格式。操作指引图规范（1）示例一：现金管理-单据管理功能节点操作指引图规范（2）示例二：销售管理-销售订单功能节点操作指引图规范（3）操作指引图中各图形含义如下表：序号图形名称图形样式说明1列表表示列表状态，在列表状态下的关键功能按钮、页签在左图方框内列示。2卡片表示卡片状态，在卡片状态下的关键功能按钮、页签在左图方框内列示。3按钮表示按钮，只列示关键的功能按钮。操作指引图规范（4）操作指引图中各图形含义如下表：序号图形名称图形样式说明4联查按钮表示联查按钮。5页签（小图标）表示页签，列示在方框内的时候使用。6页签（大图标）表示页签，可列示页签上关键功能的操作指引在左图五边形方框中。操作指引图规范（5）操作指引图中各图形含义如下表：序号图形名称图形样式说明7功能组表示一组相关联的功能，在左图方框内列示。8连接箭头表示流程连接线。9子界面表示点击按钮弹出的子界面，子界面的关键功能按钮、页签在左图方框内列示。四、编写人自测自测方法格式验证条目自测方法将帮助文件（包括