mcpField
H
help-center-article-generator

help-center-article-generator

github.com/gooseworks-ai文档处理1.3k48 次安装3 天前更新
代码仓库

关于 help-center-article-generator

这项技能面向支持和产品团队,可将重复工单、常见问题、功能文档及操作说明整理成结构化帮助中心文章,并支持单篇或批量生成与质量检查。

主要功能

  1. 01按主题归类支持工单
  2. 02按出现频率排列常见问题
  3. 03生成多种类型的文章
  4. 04按受众和格式调整结构
  5. 05检查文章的完整性与清晰度
  6. 06输出 Markdown 文章及目录

适用场景

  1. 01根据重复工单创建常见问题解答
  2. 02为客户撰写功能文档
  3. 03改写现有帮助文章
  4. 04批量制作自助支持内容

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/gooseworks-ai/goose-skills --skill help-center-article-generator

安装后在 Claude Code 中输入/help-center-article-generator确认已加载。

附带文件skill.meta.json

详细介绍

帮助中心文章生成器

将支持工单转化为自助解答。根据重复出现的问题、功能文档或产品规格生成帮助中心文章,减少工单量。

适用对象: 处于早期阶段的团队:相同的 20 个问题占了 80% 的支持工单,却没人有时间撰写帮助文档。目标是用一个下午生成文章,让它们在之后数月持续减少工单。

适用场景

  • “为我们最常见的支持问题撰写帮助中心文章”
  • “把这些支持工单转化为 FAQ 文章”
  • “为 [功能] 生成文档”
  • “完善我们的知识库”
  • “我们的支持量太大了——帮我创建自助内容”

阶段 0:信息收集

内容来源(可提供任意或全部内容)
  1. 支持工单导出文件 — 最近工单的 CSV 文件或列表(主题、描述、解决方案)。此技能会将其聚类,找出最常见的主题。
  2. FAQ 列表 — 已经知道最常见的问题?直接提供即可。
  3. 功能文档 — 需要撰写面向客户的文章的功能相关内部文档、PRD 或规格说明。
  4. 产品操作说明 — 按步骤描述工作流,此技能会据此生成文章。
  5. 需要改进的现有文章 — 需要重写的现有帮助文章的 URL 或文本。
配置
  1. 产品名称 — 产品叫什么?
  2. 受众 — 谁会阅读这些内容?(技术用户、非技术用户、混合受众)
  3. 语气 — 轻松友好、专业,还是偏技术/开发者文档风格?
  4. 文章结构偏好:
    • 标准 — 概述 → 步骤 → 故障排除 → 相关文章
    • 开发者 — 概述 → API 参考 → 代码示例 → 错误
    • 快速入门 — 是什么 → 为什么 → 如何操作(最多 3 步)→ 后续步骤
  5. 截图惯例 — 是否使用截图?(此技能会插入 [Screenshot: description] 占位符)
  6. 批量还是单篇? — 撰写一篇文章,还是根据工单导出文件生成多篇文章?

阶段 1:主题聚类(批量模式)

如果提供了工单导出文件,请将工单聚类为文章主题:

聚类方法
  1. 按相似度分组 — 将主题/描述相似的工单归为一组
  2. 按频率排序 — 最常见的聚类 = 优先级最高的文章
  3. 为每个聚类确定文章类型:
类型适用场景示例
操作指南“如何做 X?”“如何设置电子邮件集成”
故障排除“X 无法正常工作”“修复:邮件无法发送”
概念/概述“X 是什么?”“了解计费方案”
参考文档“X 有哪些选项?”“API 速率限制和配额”
入门指南首次设置“快速入门:创建你的第一个营销活动”
聚类结果
TOPIC CLUSTERS (ranked by ticket frequency):

1. [Topic] — [N tickets] — Type: [How-to]
   Common phrasing: "[How customers ask this question]"
   Resolution pattern: [What support typically tells them]

2. [Topic] — [N tickets] — Type: [Troubleshooting]
   ...

3. ...

阶段 2:文章生成

文章模板 — 操作指南
# [Action-oriented title — e.g., "How to Set Up Email Integration"]

[1-2 sentence overview: What this article covers and who it's for]

**Time to complete:** [X minutes]
**Prerequisites:** [What they need before starting — e.g., "Admin access, API key"]

---

## Step 1: [Action verb + what to do]

[1-2 sentences explaining this step]

[Screenshot: Description of what the user should see — e.g., "Settings page with Integrations tab highlighted"]

> **Tip:** [Helpful context or shortcut]

## Step 2: [Action verb + what to do]

[Instructions]

[Screenshot: Description]

## Step 3: [Action verb + what to do]

[Instructions]

---

## Verify It Worked

[How to confirm the setup was successful]

[Screenshot: Description of success state]

---

## Troubleshooting

### [Common problem 1]
**Symptom:** [What the user sees]
**Cause:** [Why this happens]
**Fix:** [Step-by-step resolution]

### [Common problem 2]
**Symptom:** [...]
**Cause:** [...]
**Fix:** [...]

---

## FAQ

**Q: [Common follow-up question]**
A: [Answer]

**Q: [Another common question]**
A: [Answer]

---

## Related Articles

- [[Article title]] — [1-line description of when to read it]
- [[Article title]] — [...]
文章模板 — 故障排除
# Fix: [Problem description — e.g., "Emails Not Sending"]

[1-2 sentences: When you'd encounter this problem]

---

## Quick Fix

Try this first (resolves ~80% of cases):

1. [Most common fix — step 1]
2. [Step 2]
3. [Verify]

---

## If That Didn't Work

### Check 1: [First thing to verify]
[How to check + what to look for]

✅ If [expected result] → This isn't the issue. Move to Check 2.
❌ If [unexpected result] → [Specific fix for this case]

### Check 2: [Second thing to verify]
[How to check]

✅ If OK → Move to Check 3.
❌ If not → [Fix]

### Check 3: [Third thing to verify]
[How to check]

✅ If OK → Move to "Still Not Working?"
❌ If not → [Fix]

---

## Still Not Working?

If none of the above resolved your issue:

1. [What information to gather — e.g., "Screenshot of the error message"]
2. [Where to get help — e.g., "Email [email protected] with the above info"]
3. [Expected response time]

---

## Why This Happens

[2-3 sentences explaining the root cause for curious users. Optional but builds trust.]

## Related Articles

- [[Article]] — [Context]
文章模板 — 入门指南/快速入门
# Getting Started with [Feature/Product]

[1-sentence: What you'll accomplish by the end of this guide]

**Time:** [X minutes] | **Difficulty:** [Beginner/Intermediate]

---

## What You'll Need

- [Prerequisite 1]
- [Prerequisite 2]

---

## Step 1: [First thing to do] (2 min)

[Clear instructions]

[Screenshot: Description]

## Step 2: [Second thing] (3 min)

[Instructions]

## Step 3: [Third thing] (2 min)

[Instructions]

---

## You're All Set! 🎉

[What they can now do]

**Next steps:**
- [Logical next action — link to next article]
- [Power user tip — link to advanced article]
- [Join community — link if applicable]

阶段 3:文章质量检查

对每篇生成的文章,检查以下内容:

  • 标题以行动为导向 — 以“如何”、“修复:”、“入门”或“了解”开头
  • 便于浏览 — 使用标题、编号步骤和加粗的关键词。避免大段文字。
  • 内容完整 — 涵盖完整工作流,而不仅是理想情况
  • 包含故障排除内容 — 至少涵盖 2 种常见故障场景
  • 避免行话 — 使用客户熟悉的语言,而非内部术语
  • 截图占位符 — 每个涉及 UI 操作的步骤都包含占位符
  • 链接相关文章 — 添加交叉引用,引导用户留在帮助中心
  • 便于搜索 — 标题和第一段包含客户实际搜索的关键词

阶段 4:输出

单篇文章模式

将文章保存到当前工作目录,文件名为 [article-slug].md。

批量模式

将所有文章保存到当前工作目录下的 help-center/ 子目录,并创建 _index.md 目录页。

索引模板
# Help Center — [Product Name]
Generated: [DATE] | Articles: [N]

## Getting Started
- [[getting-started-guide.md]] — First-time setup walkthrough
- [[quick-start.md]] — 5-minute quick start

## How-To Guides
- [[how-to-setup-email.md]] — Set up email integration
- [[how-to-invite-team.md]] — Invite team members
- ...

## Troubleshooting
- [[fix-emails-not-sending.md]] — Emails not sending
- [[fix-login-issues.md]] — Can't log in
- ...

## Reference
- [[api-rate-limits.md]] — API limits and quotas
- [[billing-plans.md]] — Plan comparison and billing FAQ

费用

组件费用
所有文章生成免费(大模型推理)
总计免费

所需工具

无。纯推理技能——接收原始输入并生成结构化文章。

触发短语

  • “根据我们的支持工单撰写帮助中心文章”
  • “为 [功能] 生成文档”
  • “完善我们的知识库”
  • “将我们的常见问题解答改写为帮助文章”
  • “运行帮助中心文章生成器”

评论

支持 Markdown