---
name: write-docs
description: 文档撰写。生成 API 文档、README、架构文档。
triggers:
  - 写文档
  - 更新 README
  - write docs
  - 文档生成
  - API 文档
tools: [Bash, Read, Write, Edit, Grep, Glob]
user-invocable: true
---

# write-docs

文档撰写。生成 API 文档、README、架构文档。

## 触发条件

- 新功能需要文档
- API 变更需要更新文档
- README 需要完善
- 架构文档需要补充

## 方法论

### Step 1: 确定文档类型

| 类型 | 适用场景 | 内容 |
|------|----------|------|
| API 文档 | 接口变更 | 参数、返回值、示例 |
| README | 项目介绍 | 安装、使用、贡献 |
| 架构文档 | 设计决策 | 模块、流程、数据 |
| 用户指南 | 功能使用 | 步骤、截图、FAQ |

### Step 2: 收集信息

1. 代码注释和 docstring
2. 函数签名和类型定义
3. 使用示例和测试用例
4. 相关设计文档

### Step 3: 撰写文档

1. 清晰的结构（标题、段落、列表）
2. 准确的描述（技术术语一致）
3. 实用的示例（可运行的代码）
4. 完整的覆盖（所有公开 API）

### Step 4: 验证文档

1. 代码示例可运行
2. 链接有效
3. 信息准确
4. 格式正确

## 输出格式

```
## 文档

### [文档标题]

[概述]

#### [章节 1]
[内容]

#### [章节 2]
[内容]

### 示例
[可运行的代码示例]
```

## 注意事项

- 文档要和代码同步更新
- 示例要可运行，不要只是伪代码
- 术语要一致，不要混用
- 结构要清晰，便于查找