• 请不要在回答技术问题时复制粘贴 AI 生成的内容
pabno
V2EX  ›  程序员

进行 vibe coding 时,要如何维护 to agent 的文档

  •  
  •   pabno · 3h 47m ago · 1559 views
    现在大家使用 ai 进行 coding 时,都在维护哪些给 ai 使用的文档,又是怎么进行维护的。

    我们项目之前维护了 agent.md, readme.md 和一些编码规范。
    - agent.md 做项目地图,说明项目目录结构,技术栈
    - readme.md 是从手戳时代遗留下来的,包括 编码规范引用,接口协议规范引用,代码生成工具使用
    - 规范文档 编码规范/设计规范

    现在团队内慢慢有人在人工的或者 ai 自动化的给项目增加面向 agent 的文档,但是每个人都有自己的做法。

    那么问题来了,为了提高 ai 的产出,应该给项目添加哪些 to agent 的文档?后面这些文档又应该怎么持续维护?
    6 replies  •  2026-10-12 17:59:14 +08:00
    alphaply
        1
    alphaply  
       3h 45m ago
    用 spec 呀,github 官方的 spec-kit 好久了,不给我喜欢方便一些的 openspec 。
    pabno
        3
    pabno  
    OP
       3h 24m ago
    @alphaply 会不会导致生成一堆后续不用的文档啊,我感觉他的功能和 codex plan 高度重合
    pabno
        4
    pabno  
    OP
       3h 5m ago
    @xxxxxl 把决策过程写进文档中感觉有点意思,我原来的想法,写进文档的内容应该是“应该是什么”的内容,ds-harness 文档保存的则是 “为什么是这样”
    charsunny
        5
    charsunny  
       1h 45m ago
    我这边主要就留几条硬规矩给人看:改哪些文件要先问、内核里不许出现产品专属逻辑,这类。文档写太细 AI 反而容易照着走偏,我更常让它先出一版,自己过 diff ,不对再改规矩。为什么这么定的决策,偶尔补一句在旁边,比堆一堆“应该是什么”有用。
    zsyevan
        6
    zsyevan  
       14 mins ago
    1. prd ,用户故事 进入 git 管理
    2. skill + subagent 要明确说明查阅 ... prd 、用户故事 文档
    3. 定期整理 prd 、 用户故事文档, 确保和代码实现具有一致性

    From 我自己维护的 AI 自动化 Web 开发 skills https://github.com/timzaak/web-dev-skills)
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   4510 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 10:13 · PVG 18:13 · LAX 03:13 · JFK 06:13
    ♥ Do have faith in what you're doing.