kb-article by anthropics/knowledge-work-plugins
npx skills add https://github.com/anthropics/knowledge-work-plugins --skill kb-article如果您看到不熟悉的占位符或需要检查连接了哪些工具,请参阅 CONNECTORS.md。
根据已解决的支持问题、常见问题或已记录的变通方案,起草一篇可发布的知识库文章。为内容构建结构,以提高可搜索性和自助服务能力。
/kb-article <已解决的问题、工单参考或主题描述>
示例:
/kb-article 如何配置与 Okta 的 SSO — 上个月为 3 位客户解决了此问题/kb-article 工单 #4521 — 客户无法导出超过 1 万行的数据/kb-article 常见问题:如何设置 webhook 通知/kb-article 已知问题:Safari 16 上仪表板图表无法加载解析输入内容以识别:
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
如果提供了工单参考,则查找完整上下文:
使用以下文章结构、格式标准和可搜索性最佳实践:
呈现带有元数据的草稿:
## 知识库文章草稿
**标题:** [文章标题]
**类型:** [操作指南 / 故障排除 / 常见问题解答 / 已知问题 / 参考文档]
**类别:** [产品领域或主题]
**标签:** [可搜索的标签]
**受众:** [所有用户 / 管理员 / 开发者 / 特定计划]
---
[完整的文章内容 — 使用下方相应的模板]
---
### 发布说明
- **来源:** [工单 #、客户对话或内部讨论]
- **需要更新的现有文章:** [如果与现有内容重叠]
- **需要审核的人员:** [如果需要验证技术准确性,则为 SME 或团队]
- **建议审核日期:** [何时重新检查准确性]
生成文章后:
每篇知识库文章都应包含:
如果客户找不到,文章就毫无用处。优化每篇文章以提高搜索效果:
| 好标题 | 差标题 | 原因 |
|---|---|---|
| “如何配置与 Okta 的 SSO” | “SSO 设置” | 具体,包含客户搜索的工具名称 |
| “修复:仪表板显示空白页面” | “仪表板问题” | 包含客户遇到的症状 |
| “API 速率限制和配额” | “API 信息” | 包含客户搜索的具体术语 |
| “错误:导入数据时出现‘连接被拒绝’” | “导入问题” | 包含确切的错误信息 |
每篇文章都以一句用通俗语言重述问题或任务的句子开头:
目的 : 完成某项任务的分步说明。
结构 :
# 如何[完成任务]
[概述 — 本指南涵盖的内容以及何时使用]
## 先决条件
- [开始前需要准备什么]
## 步骤
### 1. [操作]
[包含具体细节的说明]
### 2. [操作]
[说明]
## 验证是否成功
[如何确认成功]
## 常见问题
- [问题]:[解决方法]
## 相关文章
- [链接]
最佳实践 :
目的 : 诊断并解决特定问题。
结构 :
# [问题描述 — 用户看到的情况]
## 症状
- [用户观察到的现象]
## 原因
[为什么会发生这种情况 — 简要、非术语的解释]
## 解决方案
### 选项 1:[主要修复方法]
[步骤]
### 选项 2:[如果选项 1 无效的替代方案]
[步骤]
## 预防措施
[如何避免将来出现此问题]
## 仍有问题?
[如何获取帮助]
最佳实践 :
目的 : 对常见问题的快速解答。
结构 :
# [问题 — 用客户原话表述]
[直接答案 — 1-3 句话]
## 详细信息
[如果需要,提供额外的背景、细微差别或解释]
## 相关问题
- [指向相关常见问题解答的链接]
- [指向相关常见问题解答的链接]
最佳实践 :
目的 : 记录已知的 bug 或限制,并提供变通方案。
结构 :
# [已知问题]:[简要描述]
**状态:** [调查中 / 有变通方案 / 修复进行中 / 已解决]
**影响范围:** [受影响的对象]
**最后更新:** [日期]
## 症状
[用户遇到的现象]
## 变通方案
[绕过问题的步骤,或“暂无变通方案”]
## 修复时间线
[预计修复日期或当前状态]
## 更新记录
- [日期]:[更新内容]
最佳实践 :
知识库没有维护就会失效。遵循以下时间表:
| 活动 | 频率 | 负责人 |
|---|---|---|
| 新文章审核 | 发布前 | 同行评审 + 技术内容 SME |
| 准确性审核 | 每季度 | 支持团队审核高流量文章 |
| 过时内容检查 | 每月 | 标记 6 个月以上未更新的文章 |
| 已知问题更新 | 每周 | 更新所有未解决的已知问题的状态 |
| 分析报告审查 | 每月 | 检查哪些文章的有用性评分低或跳出率高 |
| 缺口分析 | 每季度 | 识别没有知识库文章的热门工单主题 |
更新现有文章的情况:
创建新文章的情况:
将文章组织成符合客户思维方式的层次结构:
入门指南
├── 账户设置
├── 首次配置
└── 快速入门指南
功能与操作指南
├── [功能领域 1]
├── [功能领域 2]
└── [功能领域 3]
集成
├── [集成 1]
├── [集成 2]
└── API 参考
故障排除
├── 常见错误
├── 性能问题
└── 已知问题
计费与账户
├── 计划和定价
├── 计费问题
└── 账户管理
每周安装量
202
代码仓库
GitHub Stars
10.3K
首次出现
12 天前
安全审计
安装于
gemini-cli191
opencode191
codex190
cursor190
cline189
kimi-cli189
If you see unfamiliar placeholders or need to check which tools are connected, see CONNECTORS.md.
Draft a publish-ready knowledge base article from a resolved support issue, common question, or documented workaround. Structures the content for searchability and self-service.
/kb-article <resolved issue, ticket reference, or topic description>
Examples:
/kb-article How to configure SSO with Okta — resolved this for 3 customers last month/kb-article Ticket #4521 — customer couldn't export data over 10k rows/kb-article Common question: how to set up webhook notifications/kb-article Known issue: dashboard charts not loading on Safari 16Parse the input to identify:
If a ticket reference is provided, look up the full context:
Using the article structure, formatting standards, and searchability best practices below:
Present the draft with metadata:
## KB Article Draft
**Title:** [Article title]
**Type:** [How-to / Troubleshooting / FAQ / Known Issue / Reference]
**Category:** [Product area or topic]
**Tags:** [Searchable tags]
**Audience:** [All users / Admins / Developers / Specific plan]
---
[Full article content — using the appropriate template below]
---
### Publishing Notes
- **Source:** [Ticket #, customer conversation, or internal discussion]
- **Existing articles to update:** [If this overlaps with existing content]
- **Review needed from:** [SME or team if technical accuracy needs verification]
- **Suggested review date:** [When to revisit for accuracy]
After generating the article:
Every KB article should include:
Articles are useless if customers can't find them. Optimize every article for search:
| Good Title | Bad Title | Why |
|---|---|---|
| "How to configure SSO with Okta" | "SSO Setup" | Specific, includes the tool name customers search for |
| "Fix: Dashboard shows blank page" | "Dashboard Issue" | Includes the symptom customers experience |
| "API rate limits and quotas" | "API Information" | Includes the specific terms customers search for |
| "Error: 'Connection refused' when importing data" | "Import Problems" | Includes the exact error message |
Start every article with a sentence that restates the problem or task in plain language:
Purpose : Step-by-step instructions for accomplishing a task.
Structure :
# How to [accomplish task]
[Overview — what this guide covers and when you'd use it]
## Prerequisites
- [What's needed before starting]
## Steps
### 1. [Action]
[Instruction with specific details]
### 2. [Action]
[Instruction]
## Verify It Worked
[How to confirm success]
## Common Issues
- [Issue]: [Fix]
## Related Articles
- [Links]
Best practices :
Purpose : Diagnose and resolve a specific problem.
Structure :
# [Problem description — what the user sees]
## Symptoms
- [What the user observes]
## Cause
[Why this happens — brief, non-jargon explanation]
## Solution
### Option 1: [Primary fix]
[Steps]
### Option 2: [Alternative if Option 1 doesn't work]
[Steps]
## Prevention
[How to avoid this in the future]
## Still Having Issues?
[How to get help]
Best practices :
Purpose : Quick answer to a common question.
Structure :
# [Question — in the customer's words]
[Direct answer — 1-3 sentences]
## Details
[Additional context, nuance, or explanation if needed]
## Related Questions
- [Link to related FAQ]
- [Link to related FAQ]
Best practices :
Purpose : Document a known bug or limitation with a workaround.
Structure :
# [Known Issue]: [Brief description]
**Status:** [Investigating / Workaround Available / Fix In Progress / Resolved]
**Affected:** [Who/what is affected]
**Last updated:** [Date]
## Symptoms
[What users experience]
## Workaround
[Steps to work around the issue, or "No workaround available"]
## Fix Timeline
[Expected fix date or current status]
## Updates
- [Date]: [Update]
Best practices :
Knowledge bases decay without maintenance. Follow this schedule:
| Activity | Frequency | Who |
|---|---|---|
| New article review | Before publishing | Peer review + SME for technical content |
| Accuracy audit | Quarterly | Support team reviews top-traffic articles |
| Stale content check | Monthly | Flag articles not updated in 6+ months |
| Known issue updates | Weekly | Update status on all open known issues |
| Analytics review | Monthly | Check which articles have low helpfulness ratings or high bounce rates |
| Gap analysis | Quarterly | Identify top ticket topics without KB articles |
Update existing when:
Create new when:
Organize articles into a hierarchy that matches how customers think:
Getting Started
├── Account setup
├── First-time configuration
└── Quick start guides
Features & How-tos
├── [Feature area 1]
├── [Feature area 2]
└── [Feature area 3]
Integrations
├── [Integration 1]
├── [Integration 2]
└── API reference
Troubleshooting
├── Common errors
├── Performance issues
└── Known issues
Billing & Account
├── Plans and pricing
├── Billing questions
└── Account management
Weekly Installs
202
Repository
GitHub Stars
10.3K
First Seen
12 days ago
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
gemini-cli191
opencode191
codex190
cursor190
cline189
kimi-cli189
Skills CLI 使用指南:AI Agent 技能包管理器安装与管理教程
31,600 周安装
MoE训练专家混合模型教程:降低5倍成本实现SOTA模型(Mixtral/DeepSeek)
197 周安装
Perplexity AI搜索工具使用指南 - 精准选择Search/Ask/研究代理,提升开发效率
197 周安装
滚动体验设计指南:GSAP、Framer Motion与CSS实现视差动画与交互式叙事
197 周安装
React Native 项目架构与最佳实践指南 | 函数式组件、状态管理、TypeScript
197 周安装
Auth0 React Native 集成指南:为移动应用快速添加身份验证功能
197 周安装
policy-lookup:AI 公司政策查询工具,快速解答员工福利、休假、薪酬等 HR 问题
197 周安装