README 与协作文档
你将学会什么
Section titled “你将学会什么”- 写出 README 的最小结构
- 让老师在 30 秒内看懂项目价值
- 保持协作文档的版本统一
课程项目、作品集、开源项目都适合这套最小 README 结构：
- 项目名称与一句话介绍
- 运行方式
- 核心功能或目录说明
- 依赖与版本要求
- 使用示例或截图
- 学习收获与可改进点
如果你要投简历或课程展示，这套结构能让老师在 30 秒内看懂你的项目价值。
多人协作时，文档最容易出问题的不是「写得太少」，而是「版本不统一」。最小建议是：
- README 只放当前版本最准确信息
- 过期说明移到历史文档或 changelog
- 不要把三种不同版本的配置说明混在同一份文档里
降低读者的认知负担，比展示你知道更多细节更重要。
先自己回答，再看答案：
- README 最小结构包含哪几类信息？
- 过期配置说明应该放在哪里？
- 为什么不要把三种版本的配置混在一份文档里？
参考答案
- 项目介绍、运行方式、核心功能、依赖版本、使用示例、学习收获。
- 移到历史文档或 changelog，README 只保留当前版本。
- 混在一起会提高读者的认知负担，读者无法判断哪条配置有效。
- README = 名称介绍 + 运行方式 + 核心功能 + 依赖 + 示例
- 过期说明进 changelog，README 只放当前版本
- 降低认知负担，比展示更多细节更重要