[存档] 掘金基本法

8,703 阅读10分钟

说明:最新版本请见掘金基本法,本文已经停止维护。

1. 倡导的价值观

1.1 倡导

  • 原创文章、开源内容
  • 在技术上提供有价值的信息
  • 一个干净的技术讨论环境

1.2 不欢迎

  • 不文明的讨论和人身攻击
  • 夸张的标题党

1.3 不允许

  • 违反中国或者用户所在地法律法规的行为和内容
  • 对网站的运营安全有潜在威胁的内容
  • 色情、激进时政、意识形态方面的话题

2. 掘金的不同用户角色

2.1 普通用户

用户注册并登录掘金后即成为了掘金的普通用户

普通用户拥有的权限: 阅读文章 收藏文章 点赞、评论文章/回复评论 投稿文章

2.2 原创作者

原创作者是掘金官方最优秀的内容生产者,可直接在掘金内发表文章。原创作者全部由掘金官方邀请

原创作者的权限: 阅读文章 收藏文章 点赞、评论文章/回复评论 分享文章 写作(原创)

3. 掘金功能及准则

3.1 投稿

**投稿入口:**掘金 web 端导航栏 投稿内容标准

  • URL规范 URL 需要有完善的 HTTP 或者 HTTPS 头。 不好的链接:http://www.zhihu.com/23234234?utm_source=bala&utm_medium=20160102&&utm_campaign=weibo 好的链接:http://www.zhihu.com/23234234

  • 标题规范

  • 标题尽量简单、简约、不夸张

  • 不要出现标题党

  • 建议前半部分是技术相关关键字,后半部分指明意图

  • 标题内要出现主要的技术名词

  • 掘金官方有权利根据规范修改标题

  • 描述规范

  • 总结概括文章内容,通过一两句话介绍文章的主要内容,使读者可以快速了解文章核心思想

  • 自己的推荐语和读后感悟,表达自己的感悟以及为什么你会推荐这篇文章

  • 尽量避免照抄原文

  • 掘金官方有权利根据规范修改描述 好的描述: Deep Link 是什么?Deep Link,译作深层链接,可以使 App 和网页一样,被搜索引擎直接索引并在搜索结果中展示,点击后直接在手机浏览器里打开 app 里的结果对应页面。甚至可以像现在使用 site 指定搜索目标一样,去指定要搜索的 app 不好的描述: 善用工具, 就会轻松很多

  • 配图规范

  • 一定要图文相关,图片与文章内容有强相关联系,突出主题,并包含与主题强相关的技术名词

  • 图片背景简单,图片背景是单一的颜色或者纯色

  • 不要选择太大众化的内容,文章封面配图尽量选择独特、新颖的图片,有利于吸引读者

  • 必须遵守掘金图片政策

  • 掘金官方有权利根据规范修改描述

  • 分类/标签规范 为文章添加合适的标签和分类能够帮助用户方便快速的找到和发现某一标签下的内容,也能够帮助文章得到更多的用户反馈,为了内容的传播更加高效和合理,在掘金添加标签请遵从以下原则:

  • 添加具体、细分的标签,如 iOS 而不是 移动开发

  • 添加数量合理的标签,使内容分发更加通畅

  • 要根据文章的中心思想添加标签,而不是完全根据标题中的关键字来添加,标签主要是用来提供对文章内容有价值的信息

  • 掘金官方有权利根据规范修改文章的标签及分类

  • 分享的其他信息

除了前面的分享信息以外,还有其他的额外三个标注,分别是「原创」、「墙外」、「英文」

  • 原创: 如果 co-editor 分享的文章是此作者原创,则需要选中此标注

  • 墙外: 如果此文章所在网站被墙,则需要添加「墙外」标签来提示用户此网站不翻墙则打不开,此标签还会配合后面的文章抓取

  • 英文: 如果此分享是英文文章,则需要添加此标注

  • 投稿评审者 掘金编辑组

  • 流程时间 1-2个工作日审核

  • 反馈 在web端收到通知

稀土圈 你推荐的 ***** 通过审核 稀土圈 你推荐的 ***** 未通过审核

3.2 分享

分享入口: 掘金 Web 端导航栏、各移动端主页右上角 分享指南

分享的文章必须符合社区规则与价值观,且必须符合掘金内容规范

  • URL规范 URL 的要求是,不包含 GET 参数,有完善的 HTTP 或者 HTTPS 头。 不好的链接:http://www.zhihu.com/23234234?utm_source=bala&utm_medium=20160102&&utm_campaign=weibo 好的链接:http://www.zhihu.com/23234234

  • 标题规范

  • 标题尽量简单、简约、不夸张

  • 推崇前半部分是技术相关关键字,后半部分指明意图

  • 标题内要出现主要的技术名词

  • 描述规范

  • 总结概括文章内容,通过一两句话介绍文章的主要内容,使读者可以快速了解文章核心思想

  • 自己的推荐语和读后感悟,表达自己的感悟以及为什么你会推荐这篇文章

  • 尽量避免照抄原文。 好的描述: Deep Link 是什么?Deep Link,译作深层链接,可以使 App 和网页一样,被搜索引擎直接索引并在搜索结果中展示,点击后直接在手机浏览器里打开 app 里的结果对应页面。甚至可以像现在使用 site 指定搜索目标一样,去指定要搜索的 app 不好的描述: 善用工具, 就会轻松很多

  • 配图规范

  • 一定要图文相关,图片与文章内容有强相关联系,突出主题,并包含与主题强相关的技术名词

  • 图片背景简单,图片背景是单一的颜色或者纯色

  • 不要选择太大众化的内容,文章封面配图尽量选择独特、新颖的图片,有利于吸引读者

  • 必须遵守掘金图片政策

  • 分类/标签规范 为文章添加合适的标签和分类能够帮助用户方便快速的找到和发现某一标签下的内容,也能够帮助文章得到更多的用户反馈,为了内容的传播更加高效和合理,在掘金添加标签请遵从以下原则:

  • 添加具体、细分的标签,如iOS而不是移动开发

  • 添加数量合理的标签,使内容分发更加通畅

  • 要根据文章的中心思想添加标签,而不是完全根据标题中的关键字来添加,标签主要是用来提供对文章内容有价值的信息

  • 分享的其他信息

除了前面的分享信息以外,还有其他的额外三个标注,分别是「原创」、「墙外」、「英文」

  • 原创: 如果 co-editor] 分享的文章是此作者原创,则需要选中此标注
  • 墙外: 如果此文章所在网站被墙,则需要添加「墙外」标签来提示用户此网站不翻墙则打不开,此标签还会配合后面的文章抓取
  • 英文: 如果此分享是英文文章,则需要添加此标注

3.3 原创

写作入口: 掘金 Web 端导航栏 **编辑器:**富文本编辑器、Markdown编辑器

3.4 沸点

沸点活动规则

掘金官方目前每周一和每周四会发布一期沸点,话题范围包括:时事热点、技术讨论、调查建议收集等。用户在沸点下可评论、对他人点赞、收藏沸点、分享沸点等行为

沸点行为规范

  • 用户评论须紧紧围绕话题展开
  • 严格遵照掘金社区原则和价值观,不准进行不文明的讨论和人身攻击行为
  • 严格遵守掘金的图片政策

4. 内容规范

4.1 文章规范

  • 好文章标准 技术文章是指涉及技术(这里是指程序设计)的文章,与开发相关的技术分享开发技巧工具介绍技术设想业界评论职业心得等 技术文章可以是:
  • 技术细节型 技术细节型的文章侧重于解决某个具体的问题,比如某个开源库中存在什么bug?如何解决这个bug?如何使用某个具体的技术?等等

CocoaPods 都做了什么? 3 分钟搞定 Vue 2.0 服务端渲染

  • 干货型 这类文章是作者对于某一块的内容进行的总结,具有较高的收藏价值,是属于较为受欢迎的一类文章,也更加容易在社区内和社区外传播。

关于RxJava最友好的文章 iView:一套基于Vue的高质量UI组件库

  • 翻译文章,如翻译英文的技术文章 将好的外文文章翻译为中文也是具有很高的价值,比如目前掘金官方在运营的[掘金翻译计划]。当然,给予我们对原创的尊重,如果是翻译的文章,尽量在文章前面加一个[译],并在文章的显要位置注明原作出处

[译]Swift 3 中实现Dispatch once扩展 Android7.0写给开发者的一封信(官网同步翻译)

  • 实践总结型 实践总结型的文章更像是技术细节型和干货型的结合,面向特定领域的技术,也属于干货。对于这一类型的文章,更依赖于代码,读者需要根据代码一步步往下深入

Android和iOS开发中的异步处理(一)——开篇 Android和iOS开发中的异步处理(二)——异步任务的回调 Android和iOS开发中的异步处理(三)——执行多个异步任务

  • 文章的封面图和内容中的配图必须遵守掘金图片政策
  • 文章内容须遵守掘金社区原则和价值观
  • 不受欢迎的内容
  • 很水的帖子式文章 做个人备忘、记录、笔记类的内容更应该是草稿而不是正式发表的文章
  • 杂乱无序的内容 排版混乱,文章结构不清晰,内容逻辑不符都可以被定义为垃圾文章
  • 任何推广(招聘、广告、SEO等)方面的内容 广告如:“个人视频教程、书籍推广等内容”,这类内容属于不允许用户发布的内容范围,是对其他用户危害最大的内容。一经发现,立即删除,并对发布者给予处理
  • 线下活动类 请勿私自发布线下活动类内容,如有需要请联系掘金市场部工作人员,发邮件至 bd@xitu.io

4.2 文章评论规范

  • 任何用户都可对掘金内的任何文章进行评论
  • 评论需要紧紧围绕文章的主要内容展开
  • 对文章内容或者部分观点提出疑问、回复和解答其他用户的疑问、对文章内容拓展延伸、对文章中的错误观点友善的指正等行为都是掘金所倡导的
  • 评论内容必须客观、公正,不得对他人有不文明的言语和人身攻击行为
  • 不能发布任何推广(招聘、广告)方面的内容
  • 须遵守掘金社区原则和价值观
  • 但凡违反上述规则的评论会被删除,甚至采取封号处理

违规内容的处理

  • 但凡属于不受欢迎的内容,或违反社区指导原则优质内容定义的文章给予隐藏、甚至删除的处理
  • 对于发布违规内容的用户,则将收回原创作者的相关权限,情节严重者则给予封号处理

掘金图片政策

  • 请勿上传涉及他人隐私、淫秽色情、暴力、血腥、违反国家法律法规的任何图片
  • 用户需要对自己所上传的图片版权负责,掘金不承担因此带来的任何第三方责任及法律风险
  • 违反使用规则的内容在被发现后立即删除,并对涉及的用户账号进行相应的处理,甚至采取封号处理