更新知识库
自动检测文档缺少的内容——并起草更新。
每次发布都会产生文档债务。该技能读取你最近交付的工单,将其与帮助中心和更新日志进行比对,并准确地告诉你哪些文章已过时、哪些功能缺少文档,以及需要写什么。
提示模板
/计划
### 步骤 1 — 读取最近交付的工作
检查 {{TICKET_SOURCES}} 在过去 {{TIME_WINDOW}} 内已交付、完成或合并的项。
对于每一项:功能名称、为用户带来的变化的一句话描述、受影响的产品领域。
### 步骤 2 — 读取当前文档
- 帮助中心:{{HELP_CENTER_URL}}
- 更新日志:{{CHANGELOG_URL}}
- 最近 90 天内修改的云端文档:{{DOCS_FOLDER}}
### 步骤 3 — 检测差距
**过时文章** — 描述已发生变化流程的文档
**缺失文章** — 已发布但无文档的功能
**失效的 UI 引用** — 提及已不存在的 UI 元素的文章
### 步骤 4 — 编写更新建议
针对每个差距:
**[文章标题或“需要新文章”]**
状态:过时 / 缺失 / 失效的 UI 引用
受影响的功能:[来自工单]
变化内容:[1 句话 —— 现在与文档描述之间的差异]
建议更新:[如果可能,起草更新的段落]
### 步骤 5 — 保存
将 DocUpdates_YYYY-MM-DD.md 保存到 {{OUTPUT_FOLDER}},顶部包含汇总表:
| 文章 | 状态 | 优先级 | 建议操作 |
优先级:主要功能缺少文档 = 高。过时的步骤 = 高。次要措辞 = 低。
完成后返回云端文档链接。
设置
| 字段 | 值 |
|---|---|
| 所需的 MCP | Linear / Jira / GitHub Issues、Google Drive、浏览器 |
| 输出 | DocUpdates_YYYY-MM-DD.md → /Product/Docs/Updates |
| 调度器 | 每周,或每次发布后 |
需要填写的占位符
{{TIME_WINDOW}}— 例如过去 7 天{{TICKET_SOURCES}}— 例如Linear、Jira、GitHub Issues{{HELP_CENTER_URL}}— 例如https://help.yourproduct.com{{CHANGELOG_URL}}— 例如https://yourproduct.com/changelog{{DOCS_FOLDER}}— 例如/Product/Docs{{OUTPUT_FOLDER}}— 例如/Product/Docs/Updates
提示
- 配合
release-notes-generator使用 —— 每次发布后同时运行两者。 - 优先级列有助于你的技术写作人员在不阅读每条建议的情况下进行分类。
- 如果你的帮助中心在 Notion 或 Confluence 上,将其连接为 MCP 以获得更丰富的读取权限。