# write-docs

> 编写文档 - 生成代码文档和 API 文档

- Author: shihao-hub
- Repository: shihao-hub/202601-use_claude_code
- Version: 20260203000443
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/shihao-hub/202601-use_claude_code
- Web: https://mule.run/skillshub/@@shihao-hub/202601-use_claude_code~write-docs:20260203000443

---

---
name: write-docs
description: 编写文档 - 生成代码文档和 API 文档
disable-model-invocation: true
---

请为以下代码编写完整文档：

## 文档要求

1. **代码注释**
   - 函数/方法说明
   - 参数说明（类型、含义）
   - 返回值说明
   - 异常说明
   - 使用示例

2. **API 文档**
   - 功能描述
   - 接口签名
   - 参数详情
   - 返回值详情
   - 使用示例
   - 注意事项

3. **README/指南**
   - 功能概述
   - 安装说明
   - 快速开始
   - 使用示例
   - 配置说明
   - 常见问题

请提供：
- 带注释的代码
- API 文档（Markdown 格式）
- 使用示例
- 必要的图表说明

代码：
$ARGUMENTS