50个平台,50份文档——怎么管理?
每个平台都有一套文档:API文档、部署文档、用户手册、常见问题。50个平台加起来,那是几百份文档。
我以前的"管理方式"是:存在脑子里。后果很明显——忘记一个配置,排查半天;忘记一个 API 参数,用户报 bug。
我的 AI 文档工作流
1. 代码即文档
// 我在每个 API 路由上加标准化注释
/**
* 获取附近餐厅列表
* @param lat 纬度
* @param lng 经度
* @param radius 搜索半径(米),默认5000
* @param page 页码,从1开始
* @returns 餐厅列表,按距离排序
*/
export async function getNearbyRestaurants(params: NearbyParams) {
// ...
}
这些注释被 AI 工具扫描后,自动生成 API 文档。不用我手动维护。
2. 常见问题自动入库
用户问过的问题,我会让 AI 整理成 FAQ 并自动归入对应平台的文档:
用户:怎么修改收货地址?
→ AI 自动生成 FAQ 条目:
Q: 如何修改收货地址?
A: 进入"我的"→"地址管理"→选择地址→编辑
→ 自动归档到该平台的 FAQ 文档
3. 变更日志自动记录
每次 git commit,AI 分析 diff 自动生成变更日志:
## v2.3.1 (2026-07-11)
### 新增
- 餐厅详情页增加"宠物友好"标签
### 修复
- 修复 iOS Safari 下图片上传失败的 bug
### 优化
- 搜索接口响应时间从 800ms 优化到 200ms
工具栈
- API 文档:代码注释 → OpenAPI 规范 → 自动渲染
- FAQ 知识库:用户问题 → AI 整理 → 分类归档
- 变更日志:git log → AI 分析 → 自动生成
- 部署文档:docker-compose + README → AI 保持更新
写在最后
文档不是"写一次就完"的东西,它会腐烂。关键是让文档和代码保持同步,而 AI 让这件事情从不可能变成了自动。
现在我可以放心地忘记一些细节,因为我知道 AI 帮我记着呢。对于一个人管理50个平台来说,这就是第二条命。