Skip to content

维护规则

1. 新项目接入

  1. docs/projects/ 下新建英文目录
  2. 创建 index.md
  3. 补齐至少 3 篇核心文档
  4. docs/projects/index.md 中登记入口

2. 文档命名

  • 目录名用英文短名,例如 weiban-chatmsg
  • 文件名保持固定语义,例如 requirement.mdtechnical-design.md
  • 不再使用零散、临时、带版本后缀的文件名作为正式归档

3. 更新要求

  • 需求变化时同步更新 requirement.md
  • 技术路线变化时同步更新 technical-design.md
  • 关键风险变化时同步更新 roi-risk.md
  • 文档页头必须体现更新时间

4. 发布要求

  • 正式对内共享时,只共享文档站链接
  • 不直接分享本地路径、IDE 截图或个人目录
  • 历史文档失效后移入 archive/

内部使用文档,请按项目和专题归档维护。