我先畅想一下这个给 AI 看的文档工具应该是怎样的。
组织清晰
它可以让我的文档组织清晰。
一个好的文档可能大体上是树状结构，但是实际上是图状结构。比如需要支持文档间的引用，而不只是一个 md 文件夹。
自动更新
我希望在编写程序的过程中自动更新这个文档集，不需要要用额外的精力去维护这个文档集。
因为有时候写好了文档以后，实现的过程中还是需要通过直接命令去调整程序。而这样会导致文档和代码之间脱节。我们不可能每次修改代码都先去修改文档。因为即使我们每次修改一个小功能，都去先修改文档，AI 也会很难从两份文档之间的 git 差异，得出直接有效的编码任务。
结合代码
因为这份文档是给 AI 看的，所以我们最好是文档和代码对应起来。那么或许我们还需要一个索引，从文档指向代码。当然，这个也需要自动更新。
 |
1
MHPSY 8 天前
我也想给项目维护一个很长的文档，写出来项目的结构以及目前的项目是怎么运作的，给 ai 看，方便生成代码，目前还没开始这个事情
|
 |
2
blanu 8 天前
我正在写这样的文档站，适配 Coding Agent 与人类交互，基于 VitePress ，可以期待一下
|
Select Language