易点云知识库撰写规范
本页链接:https://kb.edianzu.cn:90/html/other-show-23.html

点击图片查看大图


点击查看或下载上面的大图


审核原则

1、是否重复。如果和现有知识库重复度非常高,一般不会通过审核。但不是绝对。如果排版精美,逻辑清晰,配图合理,比现有文档更容易被人读懂,也可能会被通过。总之,综合质量一定要高于现有版本。

2、是否原创。原创的更容易被通过审核。非原创的,不能照搬,必须重新编辑,按照自己的逻辑和思路重新分析,加上配图,得出一个完整结论。

3、政策性文档、非技术类的文档,或者供应商提供的产品参数、操作指导文档,可以发布,但不计入绩效总数内。

4、是否符合版式要求。这是一条硬性要求,不符合版式要求的会被驳回。具体版式要求请参考本文档最上面图片。

是否原创,拒绝搬运。

是否有实际参考价值。

是否偏门的知识,偏门的、东拼西凑为了赚取激励的,驳回。



规范,请详细阅读下面内容。


格式示例:

**********分**********隔**********线**********开**********始**********

问题描述:加粗,18号

简单描述本篇知识库需要解决的问题。正文部分不加粗,个别需要强调的内容可以加粗,但不能全部加粗。字号默认,14号。


问题分析:加粗,18号

问题描述部分,写问题分析思路,得出结论的依旧、操作步骤等。正文部分不加粗,个别需要强调的内容可以加粗,但不能全部加粗。字号默认,14号。



解决方案:加粗,18号

正文部分不加粗,个别需要强调的内容可以加粗,但不能全部加粗。字号默认,14号。

思路清晰,分步骤逐一说明,可以配截图更加形象地说明问题。要让阅读者能看得懂,能操作,能解决他遇到的问题。

如果插入截图,需图片在上,图片的说明文字在下

英文单词要注意书写规范,尤其专有名词。

如iPhone, iMac, iOS, ThinkPad, 注意大小写,以各自品牌官方网站拼写为准。

反例:Iphone, iphone,  Imac, thinkPad, Thinkpad,thinkpad 。

 知识正文结束。

**********分**********隔**********线**********结**********束**********


注意:知识库文档必须原创,且需配图,正文内容至少有一张配图不允许从外网复制,图片不能包含其他网站水印





撰写步骤,如何撰写你的第一篇知识库文档。

1、打开知识库,登录自己的帐号,点击网页右上角“发布知识”按钮,即可进入撰写页面。

1561002693.png

如上图,发布知识

1561003105.png

如上图,首选选择对应的栏目

1561003425.png

如上图,正确选择要发布的栏目,填写标题,缩略图建议上传,点击“快传”即可,也可以使用“上传”。关键字会自动提取,但提取可能不准确,可以点击“叉号”删除不准确的关键字,手动输入和此篇知识库最相关的关键字,直接按回车键,即可。

描述建议填写,比如把问题描述的内容复制到这里。也可以不填写。

内容部分,也就是知识的正文部分,请仔细用心编辑。最好配图,图文并茂的知识文档更容易吸引阅读者。图片尺寸不要太大。宽度不要超过650像素。高度随意,但也不要太高。


知识库撰写完发布后,会经过两次审核,并且审核通过后才能正常显示,供大家浏览。我们称之为一审和二审。一审由各自业务主管完成,二审由技术专家完成。


    一审职责:审核所发知识类型和所属栏目是否符合,知识是否原创,配图有无非易点云的水印,是否存在“凑数”行为。初步判断知识文档技术准确性,有无明显技术性错误。撰写人要对发布的知识文档技术准确性负责。


    二审职责:再次核对知识主题是否符合对应栏目主题。知识格式是否符合规范。验证技术准确性。同一个发布人,可以提醒一次,提醒后依旧不符的驳回。


2、知识库文档正文内容需包含两大部分,第一部分是“问题描述”,把故障背景场景说清楚,什么情况下出现的什么故障,还要加上复现步骤。第二部分是“解决方案”,可以把分析思路、判断逻辑等信息写清楚。

全文字号(字体大小)默认,“问题描述”和“解决方案”可以设置字体加粗。




本页链接:https://kb.edianzu.cn:90/html/other-show-23.html