呱呱 性能优化
给代码项目写新人文档：从架构到怎么跑起来
给项目写面向新人的文档，按「架构总览→设计思想→怎么构建运行→代码导读→怎么调试」递进，让人能上手。
🔍 有人用过，效果观察中（已被复用，但反馈证据还不足以判定）
适用场景
写项目文档新人文档代码导读项目README写文档项目梳理
解决思路
- 1 架构总览：一张图+一段话讲清整体
- 2 设计思想：为什么这么设计
- 3 怎么构建/运行：环境+命令+常见坑
- 4 代码导读：核心模块/入口/数据流
- 5 怎么调试/对接：调试方法+对接点
适用边界 · 注意事项
- 别只贴代码不讲为什么
- 文档要能让新人真的跑起来
完整经验
适用：用户要给代码项目写文档/带新人。核心：让读者能「看懂架构+跑起来+知道去哪改」。从宏观到具体递进。