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

你们是怎么将文档和代码对齐的?

  •  
  •   bwnjnOEI · Aug 1 · 3499 views
    This topic created in 113 days ago, the information mentioned may be changed or developed.

    以及修改代码后如何保证文档不被改烂,还有就现在 agent 的输出都能读下去吗?如何应对高信息密度的输出和那些令人抓狂的内容。

    13 replies  •  2026-08-02 14:00:08 +08:00
    gausszhou
    1
    只看结论
    Anarchy
    Anarchy
    Aug 1
    2
    Agent 最后会有一个结论报告,看那个就可以。文档和代码做好分层,思想和 skill 的概念是差不多的,另外文档属于 AI 写的 AI 看,你不用太介意文档本身质量,只关心 AI 工作的结果就可以了。
    avenger
    avenger
    Aug 1❤️1
    3
    好的代码
    就是最好的文档
    Godblessu
    4
    @avenger 好的文档亦是最好的代码,有好的文档可以写无数种可能
    ericguo
    ericguo
    Aug 1❤️1
    5
    文档少写就对齐了,文档是宪法,代码是条例
    redbule
    redbule
    Aug 1 via Android
    6
    有 ai 了,不需要文档。代码在不断变化,需要的时候就靠 ai 输出一次文档,每次都要最新的输出
    wetalk
    wetalk
    Aug 1
    7
    @Godblessu #4 好文档你也不可能逐字逐句看,信息过载时代,文档最大的价值就是对 ai 有用
    crocoBaby
    8
    创建一个 md,设置 agent 每次修改完成之后都同步更新 md
    Godblessu
    9
    @wetalk 日企都是面向文档开发
    SenseHu
    SenseHu
    Aug 1
    10
    每次改完代码 让他自己更新文档咯, 推荐个框架 trellis, 好用的很
    THESDZ
    THESDZ
    Aug 1
    11
    看你是文档导向还是代码导向,有完整的开发流程,就文档先行,然后测试用例+自动化测试+变更日志兜底,不关心代码本身。
    假如你的文档也就那样,那就代码即文档,用规范的设计(如接口代替细节,规范命名等),让代码自解释(即:开发人员或者 AI 不需要关注实现细节,只关注接口命名等),当然还是要配合测试用例和自动化测试兜底。
    xuanbg
    xuanbg
    Aug 1
    12
    不写文档
    liuxue
    liuxue
    Aug 2
    13
    对不齐,我这甚至功能和需求文档都对不齐,三手项目,现在反馈的需求和 bug 是用聊天工具给我的
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   869 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 38ms · UTC 21:40 · PVG 05:40 · LAX 13:40 · JFK 16:40
    ♥ Do have faith in what you're doing.