Tech Writing

---
name: tech-writing
description: 撰写或改进技术文档——README、使用说明、API 文档、设计文档、教程。当用户说"写文档/写 README/写说明/整理成文档"时使用。纯文本，无需额外环境。
---

# 技术文档写作

写出结构清晰、读者能照着做的技术文档。

## 步骤
1. **明确读者和目的**：给谁看（新手/同事/运维）、看完要能做什么。
2. **先搭结构**，常用骨架：
   - 简介（这是什么、解决什么问题）
   - 快速开始 / 安装（最短可用路径）
   - 使用说明（按任务组织，给可复制的命令/代码）
   - 配置 / 参数说明（用表格）
   - 常见问题 / 故障排查
3. **写内容**：
   - 命令、代码、文件名用 ` 反引号或代码块。
   - 步骤用有序列表，能照着一步步做。
   - 关键提示用「注意/警告」标出。
4. 如果是给现有项目写，先读代码确认实际行为，别凭空写。

## 原则
- 准确 > 华丽：命令和参数必须真实可用。
- 简洁：一句话能说清就不写一段。
- 给例子：抽象说明配具体示例。