大家现在 AI Coding 文档是怎么管理的

4 月 13 日
 SilenceLL

我们现在后端是:基于需求文档->领域文档(放在项目 docs 下)->TDD

我现在的问题是,这份文档只放在后端有点可惜。期望建立一份面向产品->后端开发->前端开发->测试->售前->售后->市场的完整的文档库。减少一部分内容的重复建设。

想了解一下大家现在都是怎么玩,看看有没有什么有意思的玩法

2677 次点击
所在节点    程序员
7 条回复
XuDongJianSama
4 月 13 日
我是全栈了,工作空间放个文档和所有项目,项目文件夹放项目文档和各端,各端文件夹下各端文档
midraos
4 月 13 日
还在探索,项目下放的文档太多会干扰上下文,出现 Agent 只是获取背景信息就把上下文窗口干没一半了
teaguexiao
4 月 13 日
我们的做法是把文档分两层:一层是 project-level 的 CLAUDE.md (或者叫 AI.md ),专门给 AI 看的,包含架构决策、API 约定、常见陷阱;另一层才是面向人的完整文档库,放在 Notion 或者内部 Wiki 。关键是不要把面向人的文档全塞给 AI ,上下文会爆。AI 文档尽量精简,只放它真正需要的约束和规范,其他背景信息按需 @include 就好。
xxlsize
4 月 13 日
我也喜欢放在项目 docs 目录下,需要的时候,方便上下文检索
SilenceLL
4 月 13 日
SilenceLL
4 月 13 日
@XuDongJianSama @midraos @teaguexiao @xxlsize 我现在是这么玩的,项目根目录下有个 docs 目录,然后顶层有 AGENT.md 包含了系统的主要体系架构,不到 200 行。CLAUDE.md 通过 @AGENT.md 引用。确保能够适配不同的 AGENT 工具。然后 AGENT.md 里面包含了不同业务的领域文档目录入口,告诉 AI 按需加载。然后再往下就是领域文档。 所以现在就是三层渐进式披露:
1. AI Context:AGENT.md CLAUDE.md
2. AI 开发业务索引: 告诉 AI 什么业务读什么文档
3. 领域文档:AI 改到特定业务读取文档
我现在想扩展到前端、APP 端、产品、售前售后、市场。因为很多内容都是相通的
sampeng
4 月 14 日
obsidian 简直是为 ai 而生,可以画图,可以头脑风暴,可以建表建索引。我现在都是给他个目录自己看

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1205517

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX