AI / 写作与编辑
新人入职一周还在问「这个服务是干什么的」,缺的是一张全景图
我们系统包含 [服务或模块清单]。请写一份新人上手文档:一张文字版全景图(谁调用谁、数据往哪流)、每个模块一句话职责、本地跑起来的最短步骤、改代码前后必须知道的三个坑、出问题先看哪里、找谁问什么。控制在两页内。
中文原文
上手文档要写「先看哪三个文件」,比讲架构分层更救命。