Skip to content

Latest commit

 

History

History
7 lines (4 loc) · 1.37 KB

md-edition.md

File metadata and controls

7 lines (4 loc) · 1.37 KB

文档版本设计说明

我们支持在文件名中使用 @ 字符后跟数字 来表示文档版本,例如 [email protected] 就是一个合法的、完整的文件名,语义上来说表示 sample-doc-20223 版文档,文档格式为 Markdown。

关于这里我们有必要多说一些:首先,如果使用了 @ 字符,那么 @ 后面必须紧跟一个正整数(1、2、3...);其次,版本信息必须是文件名(除后缀外)的最后一部分,且只出现一次,亦即在版本信息之后必须为 .md 后缀。例如,[email protected] 是一个合法的、完整的文件名,而 [email protected] / [email protected] / [email protected] / [email protected] / sample2022@[email protected] 都是不合法的。最后,从语义上来说,版本为 1 的文档与没有版本的文档不是一回事,例如 sample2022.md[email protected] 不是一回事,可以理解为 sample2022.md 是一篇通用的文档,而 [email protected] 是一篇特定版本的文档。

另外,关于文档版本化的最佳实践是不要使用文档版本,如果文档有一些错别字需要修正或内容需要完善,这些通常不需要另建一个版本,在原文档上修改即可,只有当新内容作出了重大不兼容的改变且新旧内容均需保留的情况下,才有必要建立一个新版本的文档。