什么叫做优秀版本

我是社区第58814位番薯,欢迎点我头像关注我哦~
本帖最后由 susie 于 2017-3-3 09:48 编辑

“优秀版本”是指被标记优秀的文档版本。是文档的典范之作,具有较强的知识性和专业性,且步骤详细、逻辑清晰、用词规范、排版美观、阐释适度、通俗易懂,符合互联网阅读习惯。

1.对于新建的文档
基本只要符合编写帮助文档里的要求(分类、标题、描述、步骤、逻辑、示例),同时文档解决率需要超过84%(后台可以看到每个点击是否的用户、时间、ip等),即可获得优秀版本;
示例:常用函数集合插件
2.对于编辑的文档
a.重新讲述
您认为帮助文档某个功能讲述的不清楚,或者环境/软件版本较旧,就可以自己验证后重新讲述。
在符合编写帮助文档里的要求的前提下,逻辑比原文档更加清晰,描述的更加完善,同时文档解决率需要超过84%,即可获得优秀版本;

示例:权限细粒度之模板内容控制
此篇文档进行了整体的重新验证和补充,这种文档重新讲述就可以获得优秀版本

b.补充
对于文档里没有包含的内容,进行全面的补充,在符合编写帮助文档里的要求的前提下,同时文档解决率需要超过84%,即可获得优秀版本;

示例:填报校验后返回错误信息
           forever对返回多个报错进行了扩展讲述(不过步骤还不够详细,我后续进行了完善),这种文档补充就可 以获得优秀版本,如下图:


注:对于文档里没有包含的内容,进行简短的补充和注释,不作为优秀版本,作为普通版本进行奖励,如下图:








发表于 2017-2-11 20:52:51
版主图片加载不出来,一直在转啊
发表于 2017-2-13 10:44:48
{:8_206:}我看的也是图片一直在转,就是不出来
发表于 2017-2-15 13:33:32
我现在看见的也是图片位置在转,加载不上
发表于 2018-5-5 12:16:01
发表于 2019-1-10 13:42:47
发表于 2019-12-12 12:05:09
估计是太优秀,我不配看啊,一直转
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

返回顶部 返回列表