码字规范

自成体系、尊重规范但不盲从。

Follow the master, follow the Tao, follow the Zen.

关于协议

• 协议干嘛？
• 协议有哪些？
• 如何选择协议？

写作规范

(A similar repo on github: Chinese Copywriting Guidelines | 中文文案排版指北)

标点符号

• 标点符号，不能随意使用。不同的标点表达的情感不同，随意使用容易让人困惑。
• 中文引用使用 “引用的内容”
• 英文引用使用 "Quoted"
• 英文：使用 , . ... ? ' " @ # $ % ^ & * ( ) [ ] { } 等
• 中文：使用 ， 。 ？ ‘ ’ “ ” （ ） 【 】 { } 、 等
• 对于中文中使用 。。。 争议较大，我们认为觉得可以接受
• 英文标点后必须添加空格；中文标点后不添加
• 包含英文的中文句子使用中文标点。比如：Emacs 是最好用的编辑器。
• 包含中文的英文句子使用英文标点。比如：In China, people say "你好", just like we say "Hello".

英文大小写

• 一般情况下，句子使用首个单词大写，其余小写。
• 关键词，特殊名词使用 Capitalized。
• 强调内容使用 Upper-Case。
• 避免偷懒使用全小写英文，这给日后的文字维护带来很大麻烦。不要依赖 Emacs 的后期修改，务必手工处理好。
• 编码中应遵循相关规范。

中英文混排，数字，链接及其他

• 中文和英文之间加空格，除了：
  • 专有名词，举例：“我最爱的产品是简书和豆瓣FM”，不要写成“我最喜欢的产品是简书和豆瓣 FM”。“我在喜欢的产品是 简书 和 豆瓣FM” 也不错。
  • 中英文组合词，举例：“我在做饭ing”，不要写成 “我在做饭 ing”。还可以使用 “我在 做饭ing”，把整个当成一个英文单词处理。
  • 其他造成含义割裂的情况（这个比较泛，本不该算在【规范】里，应该是【Philosophy】）
• 标点符号遵循标点符号规范
• 数字可按照一个单词处理
• 链接与前后字空一格，比如：“这个 链接 在句子中间。”

文件命名

首要规则

• 除特殊情况，不可因为偷懒而使用模糊含义的文件名，比如：001.txt
• 文件名中除了没有不合法字符，还应尽量少用非字母字符，可以使用中文，英文，加上这些符号：-._，不使用空格
• 中英文混合，使用 GRE-单词，而不是 GRE单词

英文文件

• 使用 CamelCase，Camel-Case-with-Hyphen，lowercase-with-hyphen，或者 Uppercase-with-Hyphen
• 不使用 terribleFileNameExample.txt 这类

中文文件

• 用 Hyphen 连接，不使用空格

一则笑话

在 Yihui 的 博客 上看到：

Never use spaces (or other odd characters) in directory or file names. They make your teeth and hair fall out, start nuclear wars, and stop the trains running on time. Stick to A-Z, a-z, 0-9, “.”, “-”, and “_" for best results.

计算机操作指示

• 如何用文字表达计算机按键？c-c 等

【青年科学家的养成】： 1）青年科学家的毛病； 2）英文论文写作：三方面入手，学术术语套话、APA格式 与英语美文； 3）实验技术； 4）21世纪科学新进展：复杂性研究与网络科学； 5）TRIZ 创新的三本奠基之书； 6）大牛怎么创立学派； 7）自编经典论文美文集。

• rule