Help Article Writer

帮助文章撰写者

专家级帮助中心内容创作系统，可将复杂的产品知识转化为清晰、易于浏览且方便用户使用的文档。此技能提供结构化工作流，用于规划、撰写、排版和优化真正能帮助用户取得成功的帮助文章。

帮助文章是连接产品与用户成功的桥梁。编写良好的文档可以减轻支持负担、加快用户采用速度，并增强用户对产品的信心。此技能可帮助你创建用户能够找到、理解并付诸行动的帮助内容。

此技能基于技术写作最佳实践和用户体验原则，结合内容策略、清晰写作和持续优化，打造可扩展的帮助中心。

核心工作流

工作流 1：内容规划

梳理需要记录的内容并确定优先级

1. 内容审查

   • 清点现有帮助内容
   • 找出内容与产品功能之间的缺口
   • 标记需要更新的过时内容
   • 将内容映射到用户旅程
   • 根据支持工单数量确定优先级

2. 用户旅程映射

   • 记录关键用户流程
   • 找出需要指导的决策点
   • 标注需要文档说明的复杂环节
   • 将入门引导与文档需求对应起来
   • 与功能采用目标保持一致

3. 内容层级

   • 入门指南：首次使用用户的需求
   • 核心功能：主要功能指南
   • 高级功能：高级用户文档
   • 集成：第三方连接
   • 账户与账单：管理需求
   • 故障排除：问题解决

4. 优先级矩阵

   优先级	标准
   紧急	工单数量多、核心功能、入门引导
   高	工单数量适中、重要功能
   中	工单数量少、锦上添花的功能
   低	边缘情况、很少使用的功能

工作流 2：文章结构

设计便于浏览和理解的文章

1. 标准文章模板

   # [Clear, Action-Oriented Title]
   
   [One-sentence summary of what this article covers]
   
   ## Overview
   [Brief context - what, why, who needs this]
   
   ## Prerequisites
   [What users need before starting - optional]
   
   ## Steps / How It Works
   [Numbered steps or explanation]
   
   ## Examples
   [Concrete examples if helpful]
   
   ## Common Issues
   [Troubleshooting section if relevant]
   
   ## Related Articles
   [Links to related content]
   

2. 文章类型

   • 概念型：说明某个事物是什么以及它为何重要
   • 流程型：分步骤的操作指南
   • 参考型：技术规范、API 文档
   • 故障排除型：问题与解决方案格式
   • 教程型：以学习为重点的操作指南

3. 排版标准

   • H1 仅用于标题
   • H2 用于主要章节
   • H3 用于子章节
   • 按顺序执行的步骤使用编号列表
   • 无顺序要求的项目使用项目符号列表
   • 使用提示框标注警告、技巧和说明

工作流 3：写作流程

创作清晰、以用户为中心的内容

1. 写作前准备

   • 明确用户是谁，以及他们的目标
   • 确定用户的起始知识水平
   • 明确成功标准
   • 收集技术信息
   • 亲自测试操作流程

2. 起草

   • 从用户目标入手，而非功能本身
   • 使用第二人称（“你”）
   • 使用主动语态
   • 将句子控制在 25 个词以内
   • 每段只表达一个观点
   • 以行动为先

3. 编辑环节

   • 清晰度检查：简化术语，缩短句子
   • 准确性检查：确认所有步骤都有效
   • 排版检查：添加标题、列表和提示框
   • 链接检查：添加内部和外部链接
   • 视觉检查：添加截图和图表

4. 质量检查清单

   • 标题清楚说明用户将完成什么
   • 概述用 2-3 句话提供背景信息
   • 步骤有编号且具体明确
   • 截图展示当前 UI
   • 术语均有解释
   • 包含常见问题的故障排除说明
   • 链接到相关内容
   • 由非专家测试

工作流 4：视觉内容

使用有效的图像增强文章

1. 截图指南

   • 仅截取相关的 UI 区域
   • 使用一致的浏览器和设备
   • 使用编号标注进行说明
   • 突出显示可点击元素
   • 保持尺寸一致
   • UI 发生变化时及时更新

2. 图表指南

   • 用于展示复杂流程或架构
   • 保持视觉风格一致
   • 根据需要添加图例
   • 确保文字在较小尺寸下仍清晰可读
   • 提供替代文本以便无障碍访问

3. 视频指南

   • 时长控制在 3 分钟以内
   • 用于展示复杂的多步骤流程
   • 添加字幕
   • 提供文本替代内容
   • 托管在可靠的平台上

4. 视觉内容放置

   • 截图放在其说明步骤之后
   • 图表放在相关概念首次介绍处
   • 视频作为可选增强内容，而非替代内容

工作流 5：优化与维护

保持内容新鲜且有效

1. SEO 优化

   • 在标题和标题栏中包含关键词
   • 撰写描述性元描述
   • 使用自然语言（与搜索查询相符）
   • 构建内部链接结构
   • 为图像添加替代文本

2. 分析跟踪

   • 页面浏览量和独立访客数
   • 页面停留时间
   • 跳出率
   • 引导用户访问文章的搜索词
   • “这是否有帮助？”反馈
   • 转至支持工单的比率

3. 更新触发条件

   • 产品 UI 发生变化
   • 功能更新或弃用
   • 用户反馈表明存在困惑
   • 支持工单模式
   • 有帮助程度评分较低

4. 审核频率

   • 发布时：更新受影响的文章
   • 每月：审核反馈和指标
   • 每季度：全面审核内容
   • 每年：根据需要全面重构

快速参考

操作	命令/触发语
规划帮助内容	"Create help center content plan"
撰写新文章	"Write help article for [feature]"
改进现有文章	"Optimize help article for [topic]"
创建截图指南	"Generate screenshot guidelines"
审核帮助内容	"Audit help center coverage"
简化文章	"Simplify article for [topic]"
添加故障排除内容	"Add troubleshooting to [article]"
转换为视频脚本	"Create video script from [article]"
检查文章指标	"Analyze help article performance"
生成系列文章	"Create article series for [workflow]"

最佳实践

写作风格

• 使用八年级阅读水平的语言
• 优先使用熟悉的词语，而非技术术语
• 首次使用缩写时进行解释
• 每个步骤只包含一条指示
• 步骤以动词开头
• 避免使用“简单”“只需”“容易”等词

结构

• 将最重要的信息放在前面
• 聚焦每篇文章的内容（每篇文章一个主题）
• 在列表中使用平行结构
• 嵌套层级不超过 2 层
• 为较长的文章添加跳转链接

用户体验

• 确保用户可以通过搜索找到文章
• 提供多种导航路径
• 添加面包屑导航
• 链接相关内容
• 提供反馈机制
• 提供联系支持的升级途径

无障碍访问

• 为所有图像添加替代文本
• 使用描述性链接文本（不要使用“点击这里”）
• 确保颜色对比度充足
• 支持键盘导航
• 兼容屏幕阅读器
• 为视频添加字幕

维护

• 指定文章负责人
• 针对产品变更创建更新提醒
• 跟踪内容的最新更新时间
• 归档而非删除
• 对重要文章进行版本控制

文章模板

操作类文章

# How to [Accomplish Specific Goal]

Learn how to [brief description of what user will accomplish].

## Overview

[2-3 sentences explaining what this feature/process does and why a user would want to do this]

## Before You Start

- [Prerequisite 1]
- [Prerequisite 2]

## Steps

### Step 1: [Action]

[Explanation of what to do]

![Screenshot with annotation]

### Step 2: [Action]

[Explanation of what to do]

### Step 3: [Action]

[Explanation of what to do]

## Verify It Worked

You'll know you're successful when [observable outcome].

## Troubleshooting

**Issue**: [Common problem]
**Solution**: [How to fix it]

## What's Next

- [Related action 1]
- [Related action 2]

---
*Last updated: [Date] | [Feedback link]*

概念类文章

# Understanding [Concept]

[One-sentence definition of the concept]

## What Is [Concept]?

[2-3 paragraphs explaining the concept in user terms]

## Why It Matters

[Explain the benefit to the user - what problem it solves]

## How It Works

[Explain the mechanism at appropriate technical level]

![Diagram if helpful]

## Key Terms

| Term | Definition |
|------|------------|
| [Term 1] | [Definition] |
| [Term 2] | [Definition] |

## Examples

### Example 1: [Scenario]
[Concrete example of concept in action]

### Example 2: [Scenario]
[Another example]

## Related Topics

- [Related concept 1]
- [Related concept 2]

---
*Last updated: [Date] | [Feedback link]*

故障排除文章

# Fixing [Problem Description]

Having trouble with [problem]? Here's how to resolve it.

## Symptoms

You might see this issue if:
- [Symptom 1]
- [Symptom 2]
- [Symptom 3]

## Quick Fixes

Try these solutions in order:

### Solution 1: [Most Common Fix]

[Steps to try]

### Solution 2: [Second Most Common]

[Steps to try]

### Solution 3: [Less Common]

[Steps to try]

## Still Having Issues?

If none of the above worked:

1. [Gather this information]
2. [Contact support] with details

## Why This Happens

[Brief technical explanation for curious users - optional]

## Prevent It in the Future

[Tips to avoid this issue - if applicable]

---
*Last updated: [Date] | [Feedback link]*

危险信号

• 大段文字：没有标题、项目符号或视觉分隔
• 被动语态：“应点击该按钮”，而不是“点击该按钮”
• 以功能为中心：描述功能，而非用户目标
• 截图过时：界面与当前产品不符
• 缺少上下文：假设用户已掌握过多知识
• 没有后续指引：用户遇到问题后不知道下一步该怎么做
• 答案埋得太深：关键信息隐藏在正文中

内容风格指南

语气和风格

• 友好但不随意
• 自信但不傲慢
• 乐于助人但不居高临下
• 清晰但不过度简化

用词

使用	避免
选择	选取
点击	按（鼠标操作时）、按下
输入	键入
前往	导航到
确保	保证
使用	利用

格式

• 用 粗体 标示用户需要交互的 UI 元素
• 用 代码格式 标示用户输入、代码和路径
• 谨慎使用 斜体 强调内容
• 用 > 引用块标示重要提示