标准答案
- 覆盖 Node、包管理器、环境变量、启动命令、常见错误和本地调试方式。
- 说明目录结构、模块边界、代码规范、分支规范和提交规范。
- 列出 lint、typecheck、test、build、preview 等质量命令和触发时机。
- 说明发布流程、灰度、回滚、监控、日志和故障联系路径。
- 文档要随工程变化更新，并尽量用脚本或模板减少人工步骤。
题目解析
新人接入慢通常不是新人能力问题，而是工程知识散落：版本不清楚、命令不清楚、环境变量不清楚、出错没人知道该查哪里。
好的工程化文档要可执行。与其写长篇理念，不如给出从 clone 到跑通第一条页面的最短路径，以及常见失败分支。
文档也要有维护机制。过期文档比没有文档更危险，因为它会把新人带到错误路径。
常见误区
- 文档只写项目介绍，不写实际启动、检查和排障路径。
- 命令和真实 package scripts 不一致，长期无人维护。
- 新人接入完全靠口口相传，团队知识不可复制。