技术文档生成 Prompt：让 AI 写出人能看懂的文档

用法

把代码 / API / 功能描述粘进来，配合下面的 prompt。

Prompt

帮我把以下内容写成技术文档。不要写成说明书（「X 是一个用于 Y 的工具」），写成任务指南（「你想做 Z？这样做」）。

## 文档结构

### 这个文档解决什么问题
（1 句话：读者看完能做什么）

### 30 秒上手
（最小可运行示例，不超过 5 步，能 copy-paste 直接跑）

### 常用操作
（按使用频率排序，不是按功能分类排序。每个操作格式：）
- **做 X**：`命令或代码` → 预期结果
- **做 Y**：`命令或代码` → 预期结果

### 常见问题
（列出 3 个最可能遇到的报错，每个给解决方案。不要列「什么是 X」这种概念问题）

### 进阶
（只给链接和一句话描述，不要在这里展开。读者需要时会自己点进去）

## 规则
- 不要写「概述」「背景」「设计理念」——没人看
- 代码示例必须能直接运行，不能有伪代码
- 如果某个操作需要前置条件，在步骤里写明
- 中文输出，代码注释也用中文

---

内容来源：
（粘贴你的代码 / API 定义 / 功能描述）

效果

不加 prompt 时 AI 写的文档通常是：「X 是一个强大的工具，它提供了 A、B、C 功能……」——正确但没人看。

加了这条 prompt 后输出变成任务导向：「你想部署？这样做。你想调试？这样做。」——读者可以直接找到自己要做的事。