# Doc Generator

> 技术文档生成技能。当用户需要编写 README、API 文档、项目文档、技术规范、使用指南或任何技术文档时使用此技能。

- Skill: `enoch-robinson/doc-generator` (Agent Skill)
- Install (CLI): `npx skillmds@latest add enoch-robinson/doc-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/enoch-robinson/doc-generator/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: enoch-robinson (https://skillmd.com/u/enoch-robinson)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/enoch-robinson/doc-generator

---


# Doc Generator

生成专业、清晰、结构化的技术文档。

## 文档类型

### README.md 结构
```markdown
# 项目名称
简短描述（一句话）

## 功能特性
- 特性1
- 特性 2

## 快速开始
### 安装
### 使用

## 配置说明

## API 文档（如适用）

## 贡献指南

## License
```

### API 文档结构
```markdown
## 接口名称
简要描述

### 请求
- Method: GET/POST/...
- URL: /api/v1/resource
- Headers: ...
- Body: ...

### 响应
- 成功响应示例
- 错误响应示例

### 示例代码
```

## 文档原则

1. **用户优先**：从读者角度出发
2. **示例驱动**：代码示例胜过长篇描述
3. **保持更新**：文档与代码同步
4. **结构清晰**：使用标题层级组织内容

## 写作规范

- 使用主动语态
- 句子简短明确
- 专业术语首次出现时解释
- 代码块标注语言类型
- 重要信息使用提示框

## 提示框格式

```markdown
>⚠️ **警告**：重要警告信息

> 💡 **提示**：有用的建议

> 📝 **注意**：需要注意的事项