乐于分享
好东西不私藏

用 AI 管理项目文档

用 AI 管理项目文档

接前面的文章:和 AI 讨论需求与设计:Chat 还是 Agent,继续分享项目中如何管理文档。文末有干货小结,方便打包带走。


为何讨论这个话题
文档不仅是项目过程的重要记录,也是每一项工作的原始上下文。完善的文档便于 AI 快速理解项目的背景和要求。
在旅行规划工具这个项目里,文档基本都是 AI 生成的,文档种类多,版本也多,于是我尝试了一种文档管理模式,让 AI 更容易管理项目的文档。
这样做起来最大的好处是跟 AI 交流更方便了,其次是 AI 自己也能找上下文了。

文档目录的结构

我们的文档都在项目的 docs 目录下,按功能分成了 7 个目录:
docs/---  requirements/ :需求和用户故事  tech-design/  :技术设计文档  ui-ux/        :UI 和体验设计  meetings/     :会议和协作记录  management/   :项目管理文档  releases/     :发布和快照  feedback/     :外部反馈
这样的结构既方便人理解,也让 AI 知道去哪个目录找什么类型的文档。

如何管理这些文档

文档管理不是简单地存取文件,我们构建了一套基础设施,让 AI 能高效地理解和维护文档。

文档 ID 编号

每个文档都有个唯一的ID,比如 US-101-user-login.md 的ID是 US-101 。这些 ID 有固定的前缀:
需求类:US-用户故事、PRD-产品需求、CHG-变更
技术类:ARCH-架构、TECH-模块设计、API-接口
协作类:MEET-会议、REVIEW-评审
管理类:PLAN-计划、RPT-报告
为了避免 AI 写文档的时候随意发挥,我们特意要求不让 AI 使用新的前缀。
基于这个规则,AI 能快速定位文档。比如我说:“基于 US-101 设计技术方案”,AI 就知道去找到用户故事 101,然后开始工作,并把文档写好放在 2-tech-design 目录里,文件名会是 TECH-002-user-login.md。

类似地还可以说:“让产品经理招集技术专家和设计师,根据 REVIEW-002 重新评审 PRD-003”。

这样沟通起来简单直接,也避免了因为文件名太长或路径复杂带来的误会。

元数据和自动更新

每个文档开头都有 YAML 格式的元数据:
---title: 用户登录需求id: US-101version: 2.3.0status: approvedlast-modified: 2026-03-07related: - TECH-003-auth-module - UI-login-screen---
AI 可以读取这些信息来了解文档状态,追踪版本变化,发现相关文档的关联,自动更新目录的索引文件等。

README 作为工作导航

每个目录下都有 README.md 文件,里面写清楚了这个目录的作用,文档怎么命名,有什么规范和流程,当前有哪些文档等。当然“当前有哪些文档”是需要 AI 自己来维护的。只要 README.md 里写的清楚,AI 自己知道怎么办。

开始任务时,我让 AI 先读 docs/README.md,它就知道怎么在这个项目里工作了。这减少了很多解释,让 AI 能更自主地做事。

版本管理

Git 版本控制

所有文档都用 Git 管理,保证任何修改都能追溯,如果有多人一起做事,也比较容易处理内容冲突。用 Git 做版本管理还有一个好处就是你不必为文档的每个版本每个状态都留存一份文件。

想象一下打开一个目录,里面有第一版、第二版、评审版、评审修改版、VP 评审版等等。人都要崩溃了。

另一点,我们项目文档都是 markdown 格式的,这种纯文本文件是 Git 最擅长管理的。

如果你还没用上版本管理系统,建议尽快尝试。

元数据状态管理

文档的状态有 draft / reviewing / approved / deprecated 这些,这些状态不会出现在文件名里,而是记录在文档的元数据里。

虽然我们需要打开每个文件才能知道文档的状态,但是别忘了,这些文档多数情况下还是给 AI 看的。AI 自己能管理好文档状态,自己能知道该找哪个版本就好了。作为人类参与者,我们最想看到的还是当前状态,如果真需要查历史,我们还有 Git 来兜底。

干货小结

以上就是这次的全部内容了,总结成下面这几句干货,以便打包带走:

  1. 清晰的目录结构 + 文档 ID 编号系统,让 AI 能快速找到需要的文档。

  2. 关联关系放进 YAML 元数据,并由 AI 自动维护状态与索引。

  3. 用 Git 管理文档版本,而无须保留每一个历史版本的副本。


这次的分享大致就是这些。如果你也想用 AI 做类似的事,希望这些记录能有点用。如果你有想法或建议,也欢迎交流。
欢迎关注,期待下次见面