文档编写规则

1 source 下的子目录编号规划

• 按重要程度分列表，建立子目录，从 01 开始编号，最大到 87。示例： 01-foo/；

• 无具体分类的项目放到 88-misc/ 中；

• 构建本网站自身的相关文档放到 89-build-my-self/ 中；

• 文档链接的一些资源文件按文件类型分目录存放，从 90 开始编号，示例： 90-images/、 91-videos/ 等。

2 文档状态和版本号规则

2.1 版本号

格式为 x.y.z。

• x 为主版本号，有重大修改时发生变更。比如，当文档从草稿状态变为发布状态时，可将 x 从0升级为1。

• y 为次版本号，有小的内容修改，但文档主体无大的变化时，可更新次版本号，比如修改文档某一段落或某句话的描述。

• z 为发布版本号，用于描述文档格式修订变更，比如编码或修改标点、rst格式等。

第一个正式发行版为 1.0.0，第一个草稿版本为 0.1.0。

2.2 文档状态

如果文档标题带有 [WIP] 后缀，表示正在完善中。对应的文档版本号必须小于1.0.0，表示为非正式版本。