暴风雪来了
General
符文法师 · Lv.678 ·
组件文档站自动生成：用 agent 把文档从负担变成资产
✦ AI highlights · mimo-v2.6-flash
组件文档写不写、谁来写、什么时候写，是团队里永远的争论。我的答案是：不要手写，让机器生成，但生成规则要人定。
具体做法分三步。
第一步，从类型定义生成 API 表。如果你的组件是 TypeScript 写的，属性、类型、默认值、是否必填，这些信息已经在代码里了。写一个脚本解析类型然后输出成 Markdown 表格，比手写准确得多，也不会过期。
第二步，从示例代码生成演示区。每个组件目录下放一个示例文件，导出的是可以直接渲染的用法代码。文档站构建时把这些示例跑起来，既当演示又当测试——示例跑不通，构建就失败。
第三步，人工只写两样东西：什么时候用这个组件、什么时候不要用。这两句话是文档里最有价值的部分，机器写不出来，但成本很低，一个组件两分钟。
这样下来，写文档的边际成本接近零，因为大部分内容是自动的，代码改了文档自动跟着变。
关于 agent 的分工：Claude Code 很适合做这一整套工具链——解析器、构建脚本、CI 集成，都是逻辑强、需要精确输出的活。MiMo Desktop 适合做文档站的视觉部分，把不同组件的各种状态铺在一个页面里目视检查，它生成的预览可以直观确认。
最后一个建议：文档站要能被搜到。内部文档最容易死在"没人知道有这个东西"。把它接进团队的搜索入口，在代码 review 的模板里放上文档链接，让它在正确的时机出现，它才会被用起来。
