看了一堆教程，说法都不一样。我自己试下来，这么分最实用：

必须写：

  • 项目一句话定位（它干什么，给谁用）
  • 技术栈和版本（尤其是有版本敏感的地方，比如 React 18 还是 19）
  • 常用命令（装依赖、起服务、跑测试、格式化）
  • 目录职责（一行一个目录）

建议写：

  • 禁止事项（别动哪些目录、别改哪个配置文件）
  • 代码风格上不能妥协的两三条
  • 输出要求（比如改完要给出改了哪些文件、为什么）

不用写：

  • 完整的架构文档（太长它会忽略中间部分）
  • 团队协作流程（跟写代码无关）
  • 「请写高质量代码」这种废话

写完之后我的判断标准是：新人照着这份文档能不能把项目跑起来。能，就够用了。

主楼