选型指南 架构设计 含可复制代码

AI 功能的文档怎么写:能力、限制与示例

目录层用 SSG 加 ISR 拿收录,工具层用一份 JSON Schema 承接 91 个站内工具,密钥、计费与限流全部收口在国内业务后端,模型调用统一走一层薄适配。这篇把我们真实的目录结构、Schema 字段定义、路由闸门、预扣结算伪代码和合规清单完整摊开。

陈
陈默架构组
2026-09-28 · 14 分钟阅读 · 8,432 次浏览

用户只看「不能做什么」那一节,能否避免最常见的误用?

文档写的是"能力清单",用户要的是"怎么用"

AI 功能的文档常见写法是罗列能力 ✗:"支持总结、支持问答、支持翻译" ✔。

用户读完仍然不知道:什么时候该用它、什么时候不该用、出错了怎么办 ✗。

好文档的结构应该是"能力 + 限制 + 示例" ✔。

一、能力(写清楚"能做什么",但要具体)

· 用用户语言描述("把长文档压成一页要点" ✔ 而不是"长文本摘要能力" ✗);

· 给出输入要求(格式、长度上限、语言 ✔);

· 说明典型耗时("约 5 秒" ✔),让用户有预期 ✔。

二、限制(最有价值、最常被省略)

必须写:

· 不适合的场景("不用于法律/医疗结论" ✔);

· 已知的失败模式("表格较多的文档可能丢格式" ✔);

· 输入上限与超限后的行为 ✔;

· 数据如何被处理(是否外发、保存多久 ✔ —— 合规要求 ✔)。

写清限制能显著降低支持成本 ✔,也能减少误用导致的事故 ✔。

三、示例(要用真实问题)

· 3~5 个真实示例 ✔(从日志里挑高频且答得好的 ✔,见空状态那篇 ✔);

· 每个示例给出:输入 → 输出要点 → 为什么这样用 ✔;

· 好例子之外,给 1 个反面例子 ✔("这样问效果不好,改成……" ✔)。

四、出错了怎么办(专章)

· 常见错误与处理(格式不符、超出上限、上游繁忙 ✔);

· 如何降级(换关键词、分批提交、改用人工 ✔);

· 怎么反馈问题(带上请求 id ✔ —— 见可复现那篇 ✔)。

五、三个写作纪律

1. 先说结论:第一段就写"这个功能适合什么、不适合什么" ✔;

2. 可执行:每条限制都给出"那该怎么办" ✔(见长尾输入那篇的拒绝文案对照 ✔);

3. 有版本:文档随功能版本更新 ✔(模型换代后旧说明会变成错误信息 ✔)。

六、一份文档的最小结构

```

1. 一句话说明(做什么、给谁用)

2. 能做什么(具体能力 + 输入要求 + 耗时)

3. 不能做什么(不适合场景 + 已知失败模式 + 上限)

4. 怎么用(3~5 个真实示例 + 1 个反面例子)

5. 出错怎么办(常见错误 + 降级路径 + 反馈方式)

6. 数据与合规(如何处理、保存多久)

```

一条判据

> 用户只看第 3 节(不能做什么) ✔,能否避免最常见的误用 ✔?

> 不能,说明限制写得太笼统 ✗。

本文由云枢 AI导航整理,内容以官方来源为准。

相关文章

顺序阅读

← 上一篇:检索与生成的分工契约:谁负责什么
下一篇:把提示词里的约束变成程序里的校验 →

第 78 / 171 篇

术语速查 · 本页出现的 12 个词展开看中文名与一句话解释,点术语看完整条目
  • token词元:模型处理文本的最小单位,中文约 1–2 个汉字;计费与上下文长度都按它算。
  • 转写 / 字幕Transcription:把音视频人声逐句变成带时间戳的文字稿,便于做字幕与章节切分。
  • SSE服务器发送事件:服务器通过长连接持续推送增量文本,是对白逐字出现的常见实现。
  • API应用编程接口:程序之间约定的调用方式;站内工具由服务端调用,浏览器里不出现密钥。
  • CDN内容分发网络:把静态资源缓存到离用户更近的节点,缩短加载时间。
  • 缓存Cache:把结果暂存复用,复用得越多平均耗时越低;需要约定过期与刷新策略。
  • 限流Rate Limit:限制单位时间内的请求次数,防止单用户或异常流量打满服务端。
  • SSG静态站点生成:构建阶段就生成 HTML,访问时直接返回,不必每次请求都渲染。
  • ISR增量静态再生:先返回静态页,再在后台按需重新生成,兼顾速度与更新时效。
  • 灰度发布Canary Release:先让一小部分用户用新版本,确认无误再放量,出问题的爆炸半径最小。
  • 提示词Prompt:交给模型的指令文本;写清角色、任务、输入与输出格式比反复试更省。
  • 积分Credits:站内计费单位:按工具单价预扣,调用失败自动退还;单价以定价页为准。

完整解释与站内出现处见 AI 术语表(40 条)。