软件工程师的日常是需求变化快、代码要可维护。「接口文档」是其中重复度高、又很耗时间的一项：手里有接口代码，最后要交出一份接口文档。AI 擅长的正是整理、归纳和起草，把它放进这一步，通常能把从零开始的时间压缩到只需审改。

先判断适不适合

  • 适合：接口代码比较多、需要快速形成接口文档初稿，或者需要换个角度查漏补缺的时候。
  • 谨慎：材料涉及未公开或敏感信息、结论需要专业资质背书，或者容易出现“文档与实现不同步”的情况。
  • 不适合：需要现场判断、当面沟通或承担最终责任的环节——这些仍由软件工程师本人完成。
  • 预期：AI 负责“快”和“全”，你负责“准”和“对”。把节省下来的时间用在复核和沟通上，整体质量才会提升。

把关的四个维度

  • 事实：每一条信息都能在接口代码中找到依据。
  • 完整：该有的部分没有遗漏。
  • 风险：没有出现“文档与实现不同步”。
  • 表达：读者能看懂，语气得体。

审阅提示词

下面是一份接口文档的草稿。请你站在挑剔的审阅者角度：
1. 找出事实可能有误、缺少依据或前后矛盾的地方；
2. 检查是否存在这个风险：文档与实现不同步；
3. 指出读者可能看不懂的表述；
4. 给出修改建议，但不要直接改写全文。
草稿：【粘贴】

最终核对清单

  • 输入的接口代码已脱敏，不含不该外传的信息
  • 已告诉 AI 这份接口文档的读者和用途
  • 输出中的数字、日期、名称都已回到原始材料核对
  • 已专门检查：文档与实现不同步
  • 标注为【待确认】的内容都已补齐或删除
  • 语气和格式符合单位或行业惯例
  • 涉及专业判断、承诺或责任的内容，由本人或有资质的人确认
  • 好用的提示词和最终版本已存档

延伸阅读

说明：文中示例人物与场景均为虚构；AI 输出可能有误，请结合专业判断复核，并遵守所在单位关于 AI 工具与数据的规定。