AI协同提示词模板库:技术文档

技术文档岗位 4 条核心提示词模板:README 生成、API 文档生成、Changelog 生成、文档巡检。

Posted by WuQingBao on October 12, 2026

11-技术文档 · 提示词模板

📌 来源:11-技术文档 × AI 协同 · 索引与用法见 00-模板库索引 · 系列总纲 AI协同开发规范 占位符(xxx / 粘贴处)填好后使用;使用前过一遍总纲五条红线:不贴密钥、不贴真实用户数据、新依赖走白名单。

模板 A · README 生成/重写

1
2
3
4
5
6
7
【输入】项目代码结构与入口文件:(粘贴);启动相关配置:(粘贴,脱敏);本次变更:xxx
【任务】重写 README,结构:一句话简介 / 技术栈(带版本)/ 快速开始(可复制的命令块)/
配置说明(环境变量表格,值用占位符)/ 常见报错 Top3
【约束】
1. 只写你从输入材料中能确认的内容,推断的部分标【需确认】
2. 命令必须是完整可复制的,禁止"根据实际情况调整"这种话
3. 篇幅克制:能在 3 屏内讲完就不写 5 屏

模板 B · API 文档生成

1
2
3
4
5
【输入】接口代码/契约:(粘贴);错误码表:(粘贴)
【任务】为每个接口生成文档:路径与方法 / 鉴权要求 / 请求参数表(名称/类型/必填/说明/示例)/
响应结构(成功+每种失败)/ curl 示例(可直接运行,域名用占位符)
【约束】示例值用假数据;代码里没有的行为禁止补充"通常应该有"的内容;
发现代码与既有文档矛盾处,单独列出来给我。

模板 C · Changelog 生成

1
2
3
4
5
6
【输入】上次发版以来的 commit 记录:(粘贴)
【任务】生成面向用户的 changelog:新增 / 优化 / 修复 / 破坏性变更(置顶加粗)
【约束】
1. 用户视角说人话:"重构了xxx模块"→ 不提;"下单支持保存多个地址"→ 提
2. 破坏性变更必须写明"用户需要做什么"
3. 拿不准用户是否可感知的 commit,列入【待我确认】区

模板 D · 文档巡检

1
2
3
4
【输入】现有文档:(粘贴);当前代码事实:(粘贴关键配置/接口/结构)
【任务】找出文档与代码不一致的地方,输出表格:
文档位置 / 文档说法 / 代码事实 / 严重度(误导用户/轻微过时/无伤大雅)/ 修改建议
【约束】只报告有把握的不一致;怀疑但不确定的单列【疑似】区。