程序员延寿指南

原文：https://github.com/geekan/HowToLiveLonger
issue：https://github.com/geekan/HowToLiveLonger/issues/143

最佳操作包括：

  1. 饮食方面：多吃蔬果和白肉，少吃蛋黄和超加工食物；中量碳水、多吃植物蛋白；多吃辣和坚果；少喝或不喝甜味饮料，喝咖啡、茶和牛奶；戒酒或每周饮酒量不超过100g。

  2. 运动方面：每周进行3次45分钟的挥拍运动。

  3. 日常生活方面：每天刷牙，睡眠时间为7小时，最好在22-24点间睡觉。

  4. 其他方面：保持健康体重，不吸烟，晒太阳，服用二甲双胍、复合维生素、亚精胺和葡萄糖胺等药物。

以上操作可以降低全因死亡率，增加预期寿命，从而稳健地活得更久。但是需要注意，各个变量之间并不符合独立同分布假设，变量之间的实际影响也并不明确，因此需要谨慎实践。

反向面试

原文：https://github.com/yifeikong/reverse-interview-zh

预期使用方式

  • 检查一下哪些问题你感兴趣

  • 检查一下哪些是你可以自己在网上找到答案的

  • 找不到的话就向面试官提问

绝对不要想把这个列表里的每个问题都问一遍。（尊重面试官的时间，而且你可以通过查找已经发布的答案来显示
你的主动性）

请记住事情总是灵活的，组织的结构调整也会经常发生。拥有一个 bug 追踪系统并不会保证高效处理 bug。
CI/CD （持续集成系统） 也不一定保证交付时间会很短。

职责

  • On-call （电话值班）的计划或者规定是什么？值班或者遇到问题加班时候有加班费吗？

  • 我的日常工作是什么？

  • 有给我设定的特定目标吗？

  • 团队里面初级和高级工程师的比例是多少？（有计划改变吗）

  • 入职培训 (onboarding) 会是什么样的？

  • 每个开发者有多大的自由来做出决定？

  • 在你看来，这个工作做到什么程度算成功？

  • 你期望我在最初的一个月 / 三个月能够完成什么？

  • 试用期结束的时候，你会怎么样衡量我的绩效？

  • 自己单独的开发活动和按部就班工作的比例大概是怎样的？

  • 一个典型的一天或者一周的工作是怎样安排的？

  • 对我的申请你有什么疑虑么？

  • 在这份工作上，我将会和谁紧密合作？

  • 我的直接上级他们的上级都是什么样的管理风格？（事无巨细还是着眼宏观）

  • 我在这个岗位上应该如何发展？会有哪些机会？

  • 每天预期 / 核心工作时间是多少小时？

  • 我入职的岗位是新增还是接替之前离职的同事？（是否有技术债需要还）？(zh)

  • 入职之后在哪个项目组，项目是新成立还是已有的？(zh)

技术

  • 公司常用的技术栈是什么？

  • 你们怎么使用源码控制系统？

  • 你们怎么测试代码？

  • 你们怎么追踪 bug?

  • 你们怎样监控项目？

  • 你们怎么集成和部署代码改动？是使用持续集成和持续部署吗 (CI/CD)？

  • 你们的基础设施搭建在版本管理系统里吗？或者是代码化的吗？

  • 从计划到完成一项任务的工作流是什么样的？

  • 你们如何准备故障恢复？

  • 有标准的开发环境吗？是强制的吗？

  • 你们需要花费多长时间来给产品搭建一个本地测试环境？（分钟 / 小时 / 天）

  • 你们需要花费多长时间来响应代码或者依赖中的安全问题？

  • 所有的开发者都可以使用他们电脑的本地管理员权限吗？

  • 介绍一下你们的技术原则或者展望。

  • 你们的代码有开发文档吗？有没有单独的供消费者阅读的文档？

  • 你们有更高层次的文档吗？比如说 ER 图，数据库范式

  • 你们使用静态代码分析吗？

  • 你们如何管理内部和外部的数字资产？

  • 你们如何管理依赖？

  • 公司是否有技术分享交流活动？有的话，多久一次呢？(zh)

  • 你们的数据库是怎么进行版本控制的？(zh)

  • 业务需求有没有文档记录？是如何记录的？(zh)

团队

  • 工作是怎么组织的？

  • 团队内 / 团队间的交流通常是怎样的？

  • 你们使用什么工具来做项目组织？你的实际体会是什么？

  • 如果遇到不同的意见怎样处理？

  • 谁来设定优先级 / 计划？

  • 如果团队没能赶上预期发布日期怎么办？

  • 每周都会开什么类型的会议？

  • 会有定期的和上级的一对一谈话吗？

  • 产品 / 服务的规划是什么样的？（n 周一发布 / 持续部署 / 多个发布流 / …)

  • 生产环境发生事故了怎么办？是否有不批评人而分析问题的文化？

  • 有没有一些团队正在经历还尚待解决的挑战？

  • 你们如何跟踪进度？

  • 预期和目标是如何设定的？谁来设定？

  • Code Review 如何实施？

  • 给我介绍下团队里一个典型的 sprint

  • 你们如何平衡技术和商业目标？

  • 你们如何共享知识？

  • 团队有多大？

  • 公司技术团队的架构和人员组成？(zh)

  • 团队内开发、产品、运营哪一方是需求的主要提出方？哪一方更强势？(zh)

问未来的同事

  • 开发者倾向于从哪里学习？

  • 你对在这里工作最满意的地方是？

  • 最不满意的呢？

  • 如果可以的话，你想改变哪里？

  • 团队最老的成员在这里多久了？

  • 在小团队中，有没有出现成员性格互相冲突的情况？最后是如何解决的？

公司

  • 公司为什么在招人？（产品发展 / 新产品 / 波动…)

  • 有没有会议 / 旅行预算？使用的规定是什么？

  • 晋升流程是怎样的？要求 / 预期是怎样沟通的？

  • 绩效评估流程是怎样的？

  • 技术和管理两条职业路径是分开的吗？

  • 对于多元化招聘的现状或者观点是什么？

  • 有公司级别的学习资源吗？比如电子书订阅或者在线课程？

  • 有获取证书的预算吗？

  • 公司的成熟度如何？（早期寻找方向 / 有内容的工作 / 维护中 / …)

  • 我可以为开源项目做贡献吗？是否需要审批？

  • 你认为公司未来五年或者十年会发展成什么样子？

  • 公司的大多数员工是如何看待整洁代码的？

  • 你上次注意到有人成长是什么时候？他们在哪方面成长了？

  • 在这里成功的定义是什么？如何衡量成功？

  • 有体育活动或者团建么？

  • 有内部的黑客马拉松活动吗？

  • 公司支持开源项目吗？

  • 有竞业限制或者保密协议需要签吗？

  • 你们认为公司文化中的空白是什么？

  • 能够跟我说一公司处于不良情况，以及如何处理的故事吗？

  • 您在这工作了多久了？您觉得体验如何？(zh)

  • 大家为什么会喜欢这里？(zh)

  • 公司的调薪制度是如何的？(zh)

社会问题

  • 你们关于多元化招聘什么看法？

  • 你们的公司文化如何？你认为有什么空白么？

  • 这里的工作生活平衡地怎么样？

  • 公司对气候变化有什么态度吗？

冲突

  • 不同的意见如何处理？

  • 如果被退回了会怎样？（“这个在预计的时间内做不完”）

  • 当团队有压力并且在超负荷工作的时候怎么处理？

  • 如果有人注意到了在流程或者技术等其他方面又改进的地方，怎么办？

  • 当管理层的预期和工程师的绩效之间有差距的时候如何处理？

  • 能给我讲一个公司深处有毒环境以及如何处理的故事吗？

  • 如果在公司内你的同事因涉嫌性侵犯他人而被调查，请问你会如何处理？

  • 假设我自己很不幸是在公司内被性侵的受害者，在公司内部有没有争取合法权益的渠道？

商业

  • 你们现在盈利吗？

  • 如果没有的话，还需要多久？

  • 公司的资金来源是什么？谁影响或者制定高层计划或方向？

  • 你们如何挣钱？

  • 什么阻止了你们挣更多的钱？

  • 公司未来一年的增长计划怎样？五年呢？

  • 你们认为什么是你们的竞争优势？

  • 你们的竞争优势是什么？

  • 公司未来的商业规划是怎样的？有上市的计划吗？(zh)

远程工作

  • 远程工作和办公室工作的比例是多少？

  • 公司提供硬件吗？更新计划如何？

  • 使用自己的硬件办公可以吗？现在有政策吗？

  • 额外的附件和家具可以通过公司购买吗？这方面是否有预算？

  • 有共享办公或者上网的预算吗？

  • 多久需要去一次办公室？

  • 公司的会议室是否一直是视频会议就绪的？

办公室布局

  • 办公室的布局如何？（开放的 / 小隔间 / 独立办公室）

  • 有没有支持 / 市场 / 或者其他需要大量打电话的团队在我的团队旁边办公？

终极问题

  • 该职位为何会空缺？

  • 公司如何保证人才不流失？

  • 这份工作 / 团队 / 公司最好和最坏的方面是？

  • 你最开始为什么选择了这家公司？

  • 你为什么留在这家公司？

待遇

  • 如果有奖金计划的话，奖金如何分配？

  • 如果有奖金计划的话，过去的几年里通常会发百分之多少的奖金？

  • 有五险一金(zh)/401k(us)或者其他退休养老金等福利吗？

  • 五险一金中，补充公积金一般交多少比例？/401k一般交多少比例？我可以自己选择这一比例吗？

  • 有什么医疗保险吗？如果有的话何时开始？

  • 有额外商业保险吗？例如人寿保险和额外的养老/医疗保险？

  • 更换工作地点，公司付费吗？

休假

  • 带薪休假时间有多久？

  • 病假和事假是分开的还是一起算？

  • 我可以提前使用假期时间吗？也就是说应休假期是负的？

  • 假期的更新策略是什么样的？也就是说未休的假期能否滚入下一周期

  • 照顾小孩的政策如何？

  • 无薪休假政策是什么样的？

  • 学术性休假政策是怎么样的？

技术文档写作规范

摘自 https://www.forvs.com/231.html

作者 https://github.com/ruanyf/document-style-guide

标题

层级

标题分为四级。

  • 一级标题：文章的标题

  • 二级标题：文章主要部分的大标题

  • 三级标题：二级标题下面一级的小标题

  • 四级标题：三级标题下面某一方面的小标题

下面是示例。

1
2
3
4
5
6
7
# 一级标题

## 二级标题

### 三级标题

#### 四级标题

原则

（1）一级标题下，不能直接出现三级标题。

示例：下面的文章结构，缺少二级标题。

1
2
3
# 一级标题

### 三级标题

（2）标题要避免孤立编号（即同级标题只有一个）。

示例：下面的文章结构，二级标题 A只包含一个三级标题，完全可以省略三级标题 A。

1
2
3
4
5
## 二级标题 A

### 三级标题 A

## 二级标题 B

（3）下级标题不重复上一级标题的名字。

示例：下面的文章结构，二级标题与下属的三级标题同名，建议避免。

1
2
3
## 概述

### 概述

（4）谨慎使用四级标题，尽量避免出现，保持层级的简单，防止出现过于复杂的章节。

如果三级标题下有并列性的内容，建议只使用项目列表（Item list）。

示例：下面的结构二要好于结构一。结构一适用的场景，主要是较长篇幅的内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
结构一

### 三级标题

#### 四级标题 A

#### 四级标题 B

#### 四级标题 C

结构二

### 三级标题

**（1）A**

**（2）B**

**（3）C**

文本

字间距

（1）全角中文字符与半角英文字符之间，应有一个半角空格。

1
2
3
错误：本文介绍如何快速启动Windows系统。
 
正确：本文介绍如何快速启动 Windows 系统。

（2）全角中文字符与半角阿拉伯数字之间，有没有半角空格都可，但必须保证风格统一，不能两种风格混杂。

1
2
3
正确：2011年5月15日，我订购了5台笔记本电脑与10台平板电脑。
 
正确：2011 年 5 月 15 日，我订购了 5 台笔记本电脑与 10 台平板电脑。

半角的百分号，视同阿拉伯数字。

1
2
3
正确：今年我国经济增长率是6.5%。
 
正确：今年我国经济增长率是 6.5%。

（3）英文单位若不翻译，单位前的阿拉伯数字与单位符号之间，应留出适当的空隙。

1
2
3
例1：一部容量为 16 GB 的智能手机
 
例2：1 h = 60 min = 3,600 s

（4）半角英文字符和半角阿拉伯数字，与全角标点符号之间不留空格。

1
2
3
错误：他的电脑是 MacBook Air 。
 
正确：他的电脑是 MacBook Air。

句子

（1）避免使用长句。

不包含任何标点符号的单个句子，或者以逗号分隔的句子构件，长度尽量保持在 20 个字以内；20～29 个字的句子，可以接受；30～39 个字的句子，语义必须明确，才能接受；多于 40 个字的句子，任何情况下都不能接受。

1
2
3
错误：本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
 
正确：本产品适用于多种体系结构。无论是由一台服务器（单一节点结构），还是由多台服务器（并行处理结构）进行动作控制，均可以使用本产品。

逗号分割的长句，总长度不应该超过 100 字或者正文的 3 行。

（2）尽量使用简单句和并列句，避免使用复合句。

1
2
3
并列句：他昨天生病了，没有参加会议。
 
复合句：那个昨天生病的人没有参加会议。

（3）同样一个意思，尽量使用肯定句表达，不使用否定句表达。

1
2
3
错误：请确认没有接通装置的电源。
 
正确：请确认装置的电源已关闭。

（4）避免使用双重否定句。

1
2
3
错误：没有删除权限的用户，不能删除此文件。
 
正确：用户必须拥有删除权限，才能删除此文件。

写作风格

（1）尽量不使用被动语态，改为使用主动语态。

1
2
3
错误：假如此软件尚未被安装，
 
正确：假如尚未安装这个软件，

（2）不使用非正式的语言风格。

1
2
3
错误：Lady Gaga 的演唱会真是酷毙了，从没看过这么给力的表演！！！
 
正确：无法参加本次活动，我深感遗憾。

（3）不使用冷僻、生造或者文言文的词语，而要使用现代汉语的常用表达方式。

1
2
3
错误：这是唯二的快速启动的方法。
 
正确：这是仅有的两种快速启动的方法。

（4）用对“的”、“地”、“得”。

1
2
3
4
5
6
7
8
她露出了开心的笑容。
（形容词＋的＋名词）
 
她开心地笑了。
（副词＋地＋动词）
 
她笑得很开心。
（动词＋得＋副词）

（5）使用代词时（比如“其”、“该”、“此”、“这”等词），必须明确指代的内容，保证只有一个含义。

1
2
3
错误：从管理系统可以监视中继系统和受其直接控制的分配系统。
 
正确：从管理系统可以监视两个系统：中继系统和受中继系统直接控制的分配系统。

（6）名词前不要使用过多的形容词。

1
2
3
错误：此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。
 
正确：此设备必须在技师的指导下使用，且指导技师必须接受过由本公司举办的正式设备培训。

英文处理

（1）英文原文如果使用了复数形式，翻译成中文时，应该将其还原为单数形式。

1
2
3
英文：⋯information stored in random access memory (RAMs)⋯
 
中文：……存储在随机存取存储器（RAM）里的信息……

（2）外文缩写可以使用半角圆点(.)表示缩写。

1
2
U.S.A.
Apple, Inc.

（3）表示中文时，英文省略号（⋯）应改为中文省略号（……）。

1
2
3
英文：5 minutes later⋯
 
中文：5 分钟过去了……

（4）英文书名或电影名改用中文表达时，双引号应改为书名号。

1
2
3
英文：He published an article entitled "The Future of the Aviation".
 
中文：他发表了一篇名为《航空业的未来》的文章。

（5）第一次出现英文词汇时，在括号中给出中文标注。此后再次出现时，直接使用英文缩写即可。

1
2
3
4
5
IOC（International Olympic Committee，国际奥林匹克委员会）。这样定义后，便可以直接使用“IOC”了。

（6）专有名词中每个词第一个字母均应大写，非专有名词则不需要大写。

1
2
3
“American Association of Physicists in Medicine”（美国医学物理学家协会）是专有名词，需要大写。
 
“online transaction processing”（在线事务处理）不是专有名词，不应大写。

段落

原则

  • 一个段落只能有一个主题，或一个中心句子。

  • 段落的中心句子放在段首，对全段内容进行概述。后面陈述的句子为核心句服务。

  • 一个段落的长度不能超过七行，最佳段落长度小于等于四行。

  • 段落的句子语气要使用陈述和肯定语气，避免使用感叹语气。

  • 段落之间使用一个空行隔开。

  • 段落开头不要留出空白字符。

引用

引用第三方内容时，应注明出处。

1
2
3
4
5
One man’s constant is another man’s variable. — Alan Perlis

如果是全篇转载，请在全文开头显著位置注明作者和出处，并链接至原文。

1
2
3
4
5
本文转载自 WikiQuote

使用外部图片时，必须在图片下方或文末标明来源。

1
2
3
4
5
本文部分图片来自 Wikipedia

数值

半角数字

阿拉伯数字一律使用半角形式，不得使用全角形式。

1
2
3
错误：这件商品的价格是１０００元。
 
正确：这件商品的价格是 1000 元。

千分号

数值为千位以上，应添加千分号（半角逗号）。

1
2
3
4
5
XXX 公司的实收资本为 ￥1,258,000 人民币。

对于 4 位的数值，千分号是选用的，比如1000和1,000都可以接受。对于 4 位以上的数值，应添加千分号。

货币

货币应为阿拉伯数字，并在数字前写出货币符号，或在数字后写出货币中文名称。

1
2
$1,000
1,000 美元

英文的货币名称，建议参考国际标准 ISO 4217。

数值范围

表示数值范围时，用波浪线（～）或一字线（—）连接。参见《标点符号》一节的“连接号”部分。

带有单位或百分号时，两个数字建议都要加上单位或百分号。

1
2
3
132 kg～234 kg
 
67%～89%

变化程度的表示法

数字的增加要使用“增加了”、“增加到”。“了”表示增量，“到”表示定量。

1
2
3
4
5
增加到过去的两倍
（过去为一，现在为二）
 
增加了两倍
（过去为一，现在为三）

数字的减少要使用“降低了”、“降低到”。“了”表示增量，“到”表示定量。

1
2
3
4
5
降低到百分之八十
（定额是一百，现在是八十）
 
降低了百分之八十
（原来是一百，现在是二十）

不能用“降低 N 倍”或“减少 N 倍”的表示法，要用“降低百分之几”或“减少百分之几”。因为减少（或降低）一倍表示数值原来为一百，现在等于零。

标点符号

原则

（1）中文语句的标点符号，均应该采取全角符号，这样可以与全角文字保持视觉的一致。

（2）如果整句为英文，则该句使用英文/半角标点。

（3）句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。

（4）点号（句号、逗号、顿号、分号、冒号）不得出现在标题的末尾，而标号（引号、括号、破折号、省略号、书名号、着重号、间隔号、叹号、问号）可以。

句号

（1）中文语句的结尾处应该用全角句号（。）。

（2）句子末尾用括号加注时，句号应在括号之外。

1
2
3
错误：关于文件的输出，请参照第 1.3 节（见第 26 页。）
 
正确：关于文件的输出，请参照第 1.3 节（见第 26 页）。

逗号

（1）逗号（，）表示句子内部的一般性停顿。

（2）注意避免“一逗到底”，即整个段落除了结尾，全部停顿都使用逗号。

顿号

（1）句子内部的并列词，应该用全角顿号(、) 分隔，而不用逗号，即使并列词是英语也是如此。

1
2
3
错误：我最欣赏的科技公司有 Google, Facebook, 腾讯, 阿里和百度等。
 
正确：我最欣赏的科技公司有 Google、Facebook、腾讯、阿里和百度等。

（2）英文句子中，并列词语之间使用半角逗号（,）分隔。

1
2
3
4
5
例句：Microsoft Office includes Word, Excel, PowerPoint, Outlook and other components.

（3）中文句子内部的并列词，最后一个尽量使用（和）来连接，使句子读起来更加连贯，下面两个句子都可以，第二个更优。

1
2
3
正确：我最欣赏的科技公司有 Google、Facebook、腾讯、阿里，以及百度等。
 
正确：我最欣赏的科技公司有 Google、Facebook、腾讯、阿里和百度等。

分号

（1）分号（；）表示复句内部并列分句之间的停顿。

引号

（1）引用时，应该使用全角双引号（“ ”），注意前后双引号不同。

1
2
3
4
5
例句：许多人都认为客户服务的核心是“友好”和“专业”。

（2）引号里面还要用引号时，外面一层用双引号，里面一层用单引号（‘ ’），注意前后单引号不同。

1
2
3
4
5
例句：鲍勃解释道：“我要放音乐，可萨利说，‘不行！’。”

括号

（1）补充说明时，使用全角圆括号（（）），括号前后不加空格。

1
2
3
4
5
例句：请确认所有的连接（电缆和接插件）均安装牢固。

（2）几种括号的中英文名称。

英文中文
{ }braces 或 curly brackets大括号
``square brackets 或 brackets方括号
< >angled brackets尖括号
( )parentheses圆括号

冒号

（1）全角冒号（：）常用在需要解释的词语后边，引出解释和说明。

1
2
3
4
5
例句：请确认以下几项内容：时间、地点、活动名称和来宾数量。

（2）表示时间时，应使用半角冒号（:）。

1
2
3
4
5
例句：早上 8:00

省略号

（1）省略号（……）表示语句未完、或者语气的不连续。

（2）省略号占两个汉字空间、包含六个省略点，不要使用。。。或...等非标准形式。

（3）省略号不应与“等”这个词一起使用。

1
2
3
4
5
错误：我们为会餐准备了香蕉、苹果、梨…等各色水果。
 
正确：我们为会餐准备了各色水果，有香蕉、苹果、梨……
 
正确：我们为会餐准备了香蕉、苹果、梨等各色水果。

感叹号

（1）应该使用平静的语气叙述，尽量避免使用感叹号（！）。

（2）不得多个感叹号连用，比如！！和!!!。

破折号

（1）破折号————一般用于进一步解释。

（2）破折号应占两个汉字的位置。如果破折号本身只占一个汉字的位置，那么前后应该留出一个半角空格。

1
2
3
例句：直觉————尽管它并不总是可靠的————告诉我，这事可能出了些问题。
 
例句：直觉 —— 尽管它并不总是可靠的 —— 告诉我，这事可能出了些问题。

连接号

（1）连接号用于连接两个类似的词。

（2）以下场合应该使用直线连接号（-），占一个半角字符的位置。

  • 两个名词的复合

  • 图表编号

1
2
3
例句：氧化-还原反应
 
例句：图 1-1

（3）数值范围（例如日期、时间或数字）应该使用波浪连接号（～）或一字号（—），占一个全角字符的位置。

1
2
3
4
5
例句：2009 年～2011 年

注意，波浪连接号前后两个值都建议加上单位。

（4）波浪连接号也可以用汉字“至”代替。

1
2
3
4
5
例句：周围温度：-20 °C 至 -10 °C

文档体系

结构

软件手册是一部完整的书，建议采用下面的结构。

  • 简介（Introduction）： [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明

  • 快速上手（Getting Started）：[可选] [文件] 如何最快速地使用产品

  • 入门篇

    （Basics）： [必备] [目录] 又称”使用篇“，提供初级的使用教程

    • 环境准备（Prerequisite）：[必备] [文件] 软件使用需要满足的前置条件

    • 安装（Installation）：[可选] [文件] 软件的安装方法

    • 设置（Configuration）：[必备] [文件] 软件的设置

  • 进阶篇（Advanced)：[可选] [目录] 又称”开发篇“，提供中高级的开发教程

  • API（Reference）：[可选] [目录|文件] 软件 API 的逐一介绍

  • FAQ：[可选] [文件] 常见问题解答

  • 附录

    （Appendix）：[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容

    • Glossary：[可选] [文件] 名词解释

    • Recipes：[可选] [文件] 最佳实践

    • Troubleshooting：[可选] [文件] 故障处理

    • ChangeLog：[可选] [文件] 版本说明

    • Feedback：[可选] [文件] 反馈方式

下面是两个真实范例，可参考。

文件名

文档的文件名不得含有空格。

文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。

1
2
3
错误：名词解释.md
 
正确：glossary.md

文件名建议只使用小写字母，不使用大写字母。

1
2
3
错误：TroubleShooting.md
 
正确：troubleshooting.md

为了醒目，某些说明文件的文件名，可以使用大写字母，比如README、LICENSE。

文件名包含多个单词时，单词之间建议使用半角的连词线（-）分隔。

1
2
3
不佳：advanced_usage.md
 
正确：advanced-usage.md

参考链接