Skip to content

Commit

Permalink
[Chinese-translation]add writing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mattjin committed Feb 27, 2018
1 parent a31dba4 commit f923b62
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions writing-guidelines.chinese.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 我们的内容写作声明
如何提高访问者的阅读和学习体验

## 1. 越简单越好

<br/>
我们的使命, 我们管理内容是为了使阅读和吸收知识更容易。因此, 我们专注于将复杂和无趣的话题转化为一个简化的清单, 用缩短和不那么精确的细节来交易超载信息, 避免 ‘易燃’ 和有争议的话题, 摆脱主观想法, 赞成普遍接受做法

<br/>

## 2. 以证据为基础并且可靠

<br/>
我们的读者应该有很大的信心, 他们浏览的内容是可靠的。我们通过包括引用、数据和本主题可用的其他资源等证据来实现这一点。实际上, 努力包括可靠来源的引用, 显示基准, 相关的设计模式或任何科学措施, 以证明您的主张


## 3. MECE (Mutually Exclusive and Collectively Exhaustive)
除了大量编辑和可靠的内容, 通过它略读也应该提供全面覆盖的主题。不应排除重要的子主题

## 4. 一致的格式
内容是使用固定模板显示的。任何将来的内容都必须符合同一模板。如果希望添加新项目符号, 请从现有项目符号复制项目符号格式, 并将其扩展以满足您的需要。有关其他信息, 请查看[模版](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md)

## 5. 关于Node.js
每个建议都应直接与Node.js相关, 而不是一般软件开发。当我们建议在Node.js中实现通用模式/规则时, 内容应该集中在Node的实现上。例如, 当我们建议将所有请求的输入为了安全原因进行处理时, 应使用Node行话 - '使用中间件来处理请求输入'

## 6. 仅限主要的vendor
有时, 包括可以解决某些挑战和问题 (如 NPM 软件包、开源工具甚至商业产品) 的供应商名称是很有用的。为了避免极长的列表或推荐信誉不好和不稳定的项目, 我们提出了以下规则:

- 只有排名前3的vendor应该被推荐 – 对于一个给定的相关关键词,如果某个vendor出现在搜索引擎结果中排名前3(谷歌或GitHub通过人气排序),那么它可以包含在我们的推荐里
- 如果它是一个NPM包,它必须平均一天下载至少750次
- 如果它是一个开源项目,它必须在过去的6个月里至少更新一次

0 comments on commit f923b62

Please sign in to comment.