---
name: help-article-writer
description: 针对客户要完成的一个任务，写一篇帮助中心或知识库文章：以任务为标题，答案放在最前面，编号步骤使用与界面完全一致的名称，附截图占位、故障排查和相关文章。适用于有人要求写帮助文章、支持文档、操作指南、知识库页面，或把工单回复、发布说明、零散笔记改写成客户能独立照着做的文章时。
---

# 帮助文章撰写

一篇帮助文章，要让客户不联系客服就能完成一个任务。客户从搜索进来，扫一眼找到自己的任务，然后一边开着产品一边照着步骤操作。以任务作标题，答案放在最前面，每一步只做一个操作，界面名称与屏幕上显示的完全一致。

## 适用场景

- 某个问题在工单里反复出现，而答案只存在于客服的回复里。
- 新功能上线，客户需要知道怎么用。
- 现有文章太长、已过时，或者用的是内部说法。
- 不适用于涵盖许多问题的 FAQ 列表：用 faq-from-tickets。不适用于发布说明：用 release-notes。

## 需要准备

- 文章涵盖的任务，以及谁来操作（所有用户、仅管理员、特定套餐）。
- 真实的操作步骤：产品中显示的页面、按钮和菜单名称。如果只有一段描述，就照着写出步骤，并把每个不确定的名称标为“[核对名称]”。
- 已知问题：客户遇到的报错，来自工单或产品团队。
- 可选：可以作为相关文章链接的现有文章。

## 步骤

1. **以任务为标题。** 以动词开头，用客户搜索时的说法：“将联系人导出为 CSV”“把同事添加到工作区”。不要写“导出功能”或“了解导出”。一篇文章只讲一个任务；如果笔记涵盖 2 个任务，就写 2 篇。
2. **在前 2 句里给出答案。** 说明这个任务做什么、最短的操作路径：“可以在 **联系人 > 导出** 中导出联系人。文件会在几分钟内发送到你的邮箱。”然后说明谁可以操作、需要先具备什么（角色、套餐、权限）。
3. **写编号步骤，每步一个操作。** 每一步以动词开头。界面名称加粗，与显示的完全一致（包括大小写）。菜单路径写成 **设置** > **团队**，箭头不加粗。先说位置，再说操作：“在右上角，点击 **设置**。”控制在 3–10 步；更长的话，分成几个小节，各有标题。
4. **说明成功是什么样子。** 在最后一步之后，用一句话说明操作成功时客户应该看到什么：一条提示、一个文件、列表里的新条目。
5. **在有用的地方标出截图。** 只在目标不好找或页面内容很多的步骤后加占位符，不要每一步都加。写清截图展示的内容，便于之后补拍，同时也可作为替代文字。
6. **根据真实问题写故障排查。** 每一项以客户描述的症状为标题，再用 1–3 句话写原因和解决办法。只用来自工单或产品团队的问题；不要编造报错。
7. **链接 2–4 篇相关文章。** 客户接下来最可能做的任务，以及前置任务。给出了文章的真实标题就用真实标题；否则写“[相关：主题]”。

## 输出格式

```markdown
# [以动词开头的任务标题]

[这项操作做什么、最短路径，1–2 句。]

**谁可以操作：** [角色 / 套餐] · **开始之前：** [前置条件，或删除]

## [任务，或任务的第一部分]
1. 在 [位置]，点击 **[名称]**。
2. [……]

![截图：展示的内容]

操作成功后，[客户会看到什么]。

## 故障排查
### [客户描述的症状]
[原因和解决办法，1–3 句。]

## 相关文章
- [文章标题]
```

## 示例

**输入：**

> 产品团队的说明：管理员可以在 设置 → 团队 →“邀请成员”按钮邀请同事，输入邮箱（用逗号分隔），选择角色“成员”或“查看者”，然后点击“发送邀请”。邀请 7 天后失效。工单：有人说一直没收到邀请邮件（通常在垃圾邮件里，或邮箱填错了）；非管理员看到的“邀请成员”是灰色的。

**输出：**

```markdown
# 邀请同事加入工作区

可以在 **设置** > **团队** > **邀请成员** 中邀请同事。对方会收到一封带加入链接的邮件；链接 7 天内有效。

**谁可以操作：** 工作区管理员

## 发送邀请
1. 在左侧菜单中，点击 **设置**。
2. 点击 **团队**。
3. 点击 **邀请成员**。
4. 输入一个或多个邮箱地址，用逗号分隔。
5. 选择角色：**成员** 或 **查看者**。
6. 点击 **发送邀请**。

![截图：“邀请成员”窗口，已输入两个邮箱，角色菜单已展开]

操作成功后，每位受邀者会以“已邀请”状态出现在团队列表中，直到对方加入。

## 故障排查
### 一直没收到邀请邮件
请对方检查垃圾邮件文件夹。如果也没有，在团队列表中核对邮箱地址，然后重新发送邀请。

### “邀请成员”是灰色的
只有管理员可以邀请。请工作区管理员发出邀请，或请管理员把你设为管理员。

## 相关文章
- [相关：更改同事的角色]
- [相关：移除同事]
```

## 发送前检查

- [ ] 标题以动词开头，只讲一个任务。
- [ ] 不看步骤，前 2 句也已回答了问题。
- [ ] 每一步只有一个操作；每个界面名称都加粗，且与产品一致，或已标注“[核对名称]”。
- [ ] 文章写明了谁可以操作、成功时是什么样子。
- [ ] 每个故障排查项都来自工单或产品团队。
- [ ] 没有出现内部用语（工单、SKU、功能开关、后端）。

## 常见错误

- 以背景开头（“团队是……的重要组成部分”）。读者是来看步骤的。
- 写“进入设置页面，配置你的团队”。要写出每一次点击。
- 每一步后面都放截图。页面会变得很长，界面一改就过时。