现在的 AI 编程越来越需要维护一份持续更新的可复用的文档。有什么优雅的方案维护这个文档? - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
oldcai
0.01D
V2EX    问与答

现在的 AI 编程越来越需要维护一份持续更新的可复用的文档。有什么优雅的方案维护这个文档?

  •  
  •   oldcai
    PRO
    46 天前 1095 次点击
    这是一个创建于 46 天前的主题,其中的信息可能已经有所发展或是发生改变。

    我先畅想一下这个给 AI 看的文档工具应该是怎样的。

    组织清晰

    它可以让我的文档组织清晰。

    一个好的文档可能大体上是树状结构,但是实际上是图状结构。比如需要支持文档间的引用,而不只是一个 md 文件夹。

    自动更新

    我希望在编写程序的过程中自动更新这个文档集,不需要要用额外的精力去维护这个文档集。

    因为有时候写好了文档以后,实现的过程中还是需要通过直接命令去调整程序。而这样会导致文档和代码之间脱节。我们不可能每次修改代码都先去修改文档。因为即使我们每次修改一个小功能,都去先修改文档,AI 也会很难从两份文档之间的 git 差异,得出直接有效的编码任务。

    结合代码

    因为这份文档是给 AI 看的,所以我们最好是文档和代码对应起来。那么或许我们还需要一个索引,从文档指向代码。当然,这个也需要自动更新。

    2 条回复    2025-08-25 19:36:23 +08:00
    MHPSY
        1
    MHPSY  
       46 天前
    我也想给项目维护一个很长的文档,写出来项目的结构以及目前的项目是怎么运作的,给 ai 看,方便生成代码,目前还没开始这个事情
    blanu
        2
    blanu  
       46 天前
    我正在写这样的文档站,适配 Coding Agent 与人类交互,基于 VitePress ,可以期待一下
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     5546 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 27ms UTC 08:51 PVG 16:51 LAX 01:51 JFK 04:51
    Do have faith in what you're doing.
    ubao snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86