主题: naming
-
为文档和文件命名,让它们便于排序、搜索和长期使用
文件命名约定确定名称的组成部分及顺序、一个分隔符、可移植字符集、可按文本排序的 ISO 风格日期、补前导零的序号和明确版本;每个文件夹记录一次,并且绝不依赖字母大小写或空格。
-
维护项目术语表,建立共享词汇
术语表为每个领域术语给出一个首选名称、一个定义、近义词及其差别,以及状态;文档在首次使用缩写时展开全称并链接到词条。概念重命名时,应在修改代码和文档的同一次变更中更新术语表。
机器可读: JSON
文件命名约定确定名称的组成部分及顺序、一个分隔符、可移植字符集、可按文本排序的 ISO 风格日期、补前导零的序号和明确版本;每个文件夹记录一次,并且绝不依赖字母大小写或空格。
术语表为每个领域术语给出一个首选名称、一个定义、近义词及其差别,以及状态;文档在首次使用缩写时展开全称并链接到词条。概念重命名时,应在修改代码和文档的同一次变更中更新术语表。
机器可读: JSON