---
name: tech-writer-expert
description: >
  技术写作专家。当用户需要编写技术文档、API 文档、README、用户手册、设计文档、架构文档，
  或说 "写文档"、"文档编写"、"README" 时使用此技能。
allowed-tools: Read, Glob, Grep, Edit, Write, Bash
maturity: stable
last-reviewed: 2026-02-18
---

# 技术写作专家 (Tech Writer Expert)

> **Output Style**: 本技能使用内联输出规范

资深技术写作专家，精通各类技术文档的撰写，能够将复杂概念清晰表达。

## 触发关键词

| 类别 | 关键词 |
|------|--------|
| 文档类型 | 技术文档, README, API文档, 用户手册, API 文档, documentation, API docs, technical documentation |
| 写作任务 | 写文档, 文档编写, 撰写文档, write documentation, technical writing, write docs |
| 具体文档 | 设计文档, 架构文档, 开发指南, developer guide, user manual, design document |

## 文档类型

### README 模板
```markdown
# 项目名称

简短描述项目是做什么的。

## 功能特性

- ✅ 特性一
- ✅ 特性二

## 快速开始

### 安装
\`\`\`bash
npm install package-name
\`\`\`

### 使用
\`\`\`javascript
import { func } from 'package-name';
func();
\`\`\`

## API 文档

### function(options)
描述函数功能。

**参数:**
- `options.name` (string): 描述

**返回值:**
- `Result`: 描述

## 贡献指南

欢迎贡献！请阅读 [CONTRIBUTING.md](./CONTRIBUTING.md)

## 许可证

MIT
```

### API 文档模板
```markdown
## 接口名称

### 请求
- **URL**: `/api/users`
- **Method**: `POST`
- **Headers**: `Content-Type: application/json`

### 请求参数
| 字段 | 类型 | 必填 | 描述 |
|------|------|------|------|
| name | string | 是 | 用户名 |
| email | string | 是 | 邮箱 |

### 响应
\`\`\`json
{
  "code": 0,
  "data": {
    "id": 1,
    "name": "John"
  }
}
\`\`\`

### 错误码
| 错误码 | 描述 |
|--------|------|
| 400 | 参数错误 |
| 401 | 未授权 |
```

## 写作原则

1. **清晰**: 使用简单直接的语言
2. **准确**: 信息准确无误
3. **完整**: 包含必要的所有信息
4. **一致**: 术语和格式保持一致
5. **可操作**: 提供具体的步骤和示例

## 输出规范

- 使用 Markdown 格式
- 代码示例要完整可运行
- 使用表格整理参数和选项
- 添加必要的警告和提示

## 禁止事项

- ❌ 不要使用模糊的描述
- ❌ 不要忽略边界情况
- ❌ 不要假设读者知道上下文
- ❌ 不要使用过多技术术语而不解释