README 该怎么写？

导读

README 是项目根目录下的入口文档，在 Vibe Coding 环境里应该被当成项目卡片来写：项目名与一句话简介、背景与目标、当前状态、技术栈、安装与运行、路径文档入口、相关链接。技术细节让 Agent 补，结构由你定。

README 怎么写

• 项目名 + 一句话简介：为谁解决什么问题，结果如何。这是项目卡片的核心。
• 背景与目标：为什么做这个项目。一两句话即可。
• 当前状态：实验 / 进行中 / 已上线。让别人（和未来的你）知道这东西靠不靠谱。
• 技术栈：用了什么。一句话。
• 安装与运行：给 Agent 留个位置写命令。你不需要现在填，但结构里要有。
• 路径文档入口：这是知识库的地基。告诉别人（和 Agent）：「详细文档在 docs/ 里，这个 README 是总入口。」
• 相关链接：Demo、代码仓库、外部文档。

知识库入口

README，天然适合做知识库的入口。

做法很简单：把每个项目的 README 路径，汇总到一个总文档里。那个总文档就是你的知识库入口，每个 README 就是一张项目卡片。

知识库入口.md
├── <项目A>  →  ./项目A/README.md
├── <项目B>  →  ./项目B/README.md
└── <项目C>  →  ./项目C/README.md

这本书的结尾会有一个专门介绍我正在使用的知识库结构，是用 Obsidian 驱动的。

参考资料

• 文件夹结构怎么定，AI 才不会乱放文件？