文档写的是"能力清单",用户要的是"怎么用"
AI 功能的文档常见写法是罗列能力 ✗:"支持总结、支持问答、支持翻译" ✔。
用户读完仍然不知道:**什么时候该用它、什么时候不该用、出错了怎么办** ✗。
**好文档的结构应该是"能力 + 限制 + 示例"** ✔。
一、能力(写清楚"能做什么",但要具体)
二、限制(最有价值、最常被省略)
必须写:
**写清限制能显著降低支持成本** ✔,也能减少误用导致的事故 ✔。
三、示例(要用真实问题)
四、出错了怎么办(专章)
五、三个写作纪律
1. **先说结论**:第一段就写"这个功能适合什么、不适合什么" ✔;
2. **可执行**:每条限制都给出"那该怎么办" ✔(见长尾输入那篇的拒绝文案对照 ✔);
3. **有版本**:文档随功能版本更新 ✔(模型换代后旧说明会变成错误信息 ✔)。
六、一份文档的最小结构
```
1. 一句话说明(做什么、给谁用)
2. 能做什么(具体能力 + 输入要求 + 耗时)
3. 不能做什么(不适合场景 + 已知失败模式 + 上限)
4. 怎么用(3~5 个真实示例 + 1 个反面例子)
5. 出错怎么办(常见错误 + 降级路径 + 反馈方式)
6. 数据与合规(如何处理、保存多久)
```
一条判据
> 用户**只看第 3 节(不能做什么)** ✔,能否避免最常见的误用 ✔?
> 不能,说明限制写得太笼统 ✗。