product-documentation

产品文档技能

目的

确保产品文档清晰、全面并以用户为中心，帮助用户了解功能、解决问题，并充分发挥产品的价值。

规则

文档类型

用户指南（必须包含）：

• 入门指南
• 功能文档
• 故障排查指南
• 常见问题
• 术语表

发布文档：

• 发行说明（新功能、错误修复、重大变更）
• 迁移指南
• 升级说明
• 弃用通知

参考文档：

• 功能规格
• 配置选项
• 键盘快捷键 / 命令行命令
• 系统要求

写作标准

必须：

• 使用清晰、简洁的语言
• 面向目标受众（技术水平）
• 使用主动语态（“点击保存”，而不是“应点击保存”）
• 添加视觉内容（截图、图表、视频）
• 提供示例
• 确保内容与产品保持同步

结构：

# Feature Name

## Overview
[What it does and why it's useful]

## Prerequisites
[What users need before starting]

## How to Use
### Step 1: [Action]
[Detailed instructions with screenshots]

### Step 2: [Action]
[More instructions]

## Examples
[Real-world use cases]

## Troubleshooting
[Common problems and solutions]

## Related
[Links to related documentation]

示例

功能文档模板

# Email Notifications

## Overview
Receive automatic email alerts when important events occur in your account.

## Setting Up Notifications

1. Go to **Settings** → **Notifications**
2. Toggle the events you want to be notified about
3. Verify your email address
4. Click **Save Preferences**

## Available Notification Types

- **Security Alerts**: Login attempts, password changes
- **System Updates**: Maintenance windows, feature releases
- **Account Activity**: Billing changes, user additions

## Troubleshooting

**Problem**: Not receiving notifications  
**Solution**: Check spam folder, verify email address

## Related
- [Email Configuration](./email-config.md)
- [Security Settings](./security.md)

相关规范

• 文档体系 SKILL
• 品牌语调与风格 SKILL

相关文档

• hagbard-celine Agent