# API Documentation

> ---

- Skill: `zhaoxuya520/api-documentation` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add zhaoxuya520/api-documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/zhaoxuya520/api-documentation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: zhaoxuya520 (https://skillmd.com/u/zhaoxuya520)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/zhaoxuya520/api-documentation

---

---
name: api-documentation
description: API 文档编写时使用。适用于 OpenAPI 说明 / 示例 / 错误码文档。
---

# api-documentation

## 适用场景

- API 文档编写时使用。适用于 OpenAPI 说明 / 示例 / 错误码文档。

## 核心原则

```text
1. 读者优先（不是作者方便）
2. 可搜索 / 可导航
3. 保持更新（过期文档 = 误导）
4. 示例 > 描述
5. 图表辅助理解
```n
## 配套模板

- `templates/api-doc-template.md`
- `templates/api-documentation-template.md`

## 质量自检

```text
[] 读者明确
[] 结构清晰
[] 示例完整
[] 可搜索
[] 保持更新
```n
## 常见坑

1. 写完不更新
2. 没有示例
3. 太长没导航
4. 术语不一致
5. 敏感信息泄露

## 与其他 skill 的协作

```text
上游：各工作流 → 技术输入
下游：用户 / 团队 → 消费文档
```n