V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
SilenceLL
V2EX  ›  程序员

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

  •  
  •   SilenceLL · 17 小时 53 分钟前 · 928 次点击

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

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

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

    7 条回复    2026-04-14 08:12:53 +08:00
    XuDongJianSama
        1
    XuDongJianSama  
       17 小时 2 分钟前
    我是全栈了,工作空间放个文档和所有项目,项目文件夹放项目文档和各端,各端文件夹下各端文档
    midraos
        2
    midraos  
       16 小时 51 分钟前
    还在探索,项目下放的文档太多会干扰上下文,出现 Agent 只是获取背景信息就把上下文窗口干没一半了
    teaguexiao
        3
    teaguexiao  
       16 小时 18 分钟前   ❤️ 1
    我们的做法是把文档分两层:一层是 project-level 的 CLAUDE.md (或者叫 AI.md ),专门给 AI 看的,包含架构决策、API 约定、常见陷阱;另一层才是面向人的完整文档库,放在 Notion 或者内部 Wiki 。关键是不要把面向人的文档全塞给 AI ,上下文会爆。AI 文档尽量精简,只放它真正需要的约束和规范,其他背景信息按需 @include 就好。
    xxlsize
        4
    xxlsize  
       15 小时 56 分钟前
    我也喜欢放在项目 docs 目录下,需要的时候,方便上下文检索
    SilenceLL
        5
    SilenceLL  
    OP
       12 小时 3 分钟前   ❤️ 1
    SilenceLL
        6
    SilenceLL  
    OP
       11 小时 58 分钟前
    @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
        7
    sampeng  
       2 小时 6 分钟前 via iPhone
    obsidian 简直是为 ai 而生,可以画图,可以头脑风暴,可以建表建索引。我现在都是给他个目录自己看
    关于   ·   帮助文档   ·   自助推广系统   ·   博客   ·   API   ·   FAQ   ·   Solana   ·   6081 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 02:19 · PVG 10:19 · LAX 19:19 · JFK 22:19
    ♥ Do have faith in what you're doing.