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

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

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

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

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

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

    From 我自己维护的 AI 自动化 Web 开发 skills https://github.com/timzaak/web-dev-skills)
    udtrokia
        7
    udtrokia  
       11h 54m ago
    我目前是固定一个 dir 管理 agent 相关的文档和看板,加入一些 references 的设计可以跨 sessions 使用 https://cydonia.sh/
    yesterdaysun
        8
    yesterdaysun  
       11h 8m ago
    可以用 LLM Wiki 的方式管理, 原始的各种需求文件放 raw, 经过决策的文件放进 wiki, 两边交叉引用, 用知识库的方式管理
    Dragonish3600
        9
    Dragonish3600  
       10h 50m ago
    不就几个规则的事?
    agent 的 global rule 里加上几条类似下面的:

    1.所有的相关文档都放入 docs 目录下,如果没有对应文档则创建。文档中要记录 task 的状态。
    2.执行任何操作后,都要更新 docs 文档并更行 task 状态
    3.更新 docs 文档后,询问是不是要 commit 对文档的更改
    Chuckle
        10
    Chuckle  
       10h 41m ago
    https://github.com/qxchuckle/lattice
    自用的一个,全局存储,跨项目维护
    woodchen
        11
    woodchen  
       9h 57m ago
    https://www.sunp.eu.org/t/1220892

    我用的方法是 skill, 并持续更新.目前用还可以, 虽然占了些上下文, 但是可控很多.
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1008 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 45ms · UTC 22:28 · PVG 06:28 · LAX 15:28 · JFK 18:28
    ♥ Do have faith in what you're doing.