Skip to main content

文档与命名标准

目标：降低多功能并发下的文档与文件查找成本，减少同名歧义和误用。

文件命名​

  • 使用小写连字符：module-domain-scope.md
  • 避免同名多义文件（如 standard.md、config.md 在多个目录内重复）。
  • 文件名应体现功能域与层级关系。

文档 frontmatter 要求​

  • 必须包含字段：title / sidebar_label / slug / package_key / doc_type / status。
  • 标准类文档 doc_type 建议为 development_standard。
  • slug 使用可读短路径，避免过深嵌套。

术语与缩写​

  • 缩写首次出现需定义：如 MR、Handoff、A/B。
  • 对同一概念保持单一中文名，减少跨文档分歧。

变更与维护​

  • 文档更新需同步证据链接、日期与责任人。
  • 已废弃标准保留历史但明确标注 deprecated。
  • 无法追踪来源/责任的文档条目需要重建并补齐上下文。