---
name: tech-doc
description: >
  技术文档编写。
  Use when: 写 README、设计说明、API 文档、操作手册
  Do not use when: 写业务代码（产品线 skill）；无文档目标的闲聊
---

# 技术文档编写

细则与检查清单：[references/details.md](references/details.md)

## When / Do not

**Use when**：写 README、设计说明、API 文档、操作手册  
**Do not use when**：写业务代码（产品线 skill）；无文档目标的闲聊

## Input / Output

| Input | Output |
|-------|--------|
| 目标代码/需求/约束 | 可执行改动建议或产出物 + 验证方式 |

## Steps

```
- [ ] 1. 读者与文档类型
- [ ] 2. 大纲
- [ ] 3. 正文（步骤可执行）
- [ ] 4. 示例与边界
- [ ] 5. 审阅清单
```

## 失败策略

| 失败 | 动作 |
|------|------|
| 范围过大 | 拆任务，先交付最小可验证切片 |
| 信息不足 | 列出最小待确认项，不臆造业务事实 |

## 验证

- 说明改了什么、如何验证、剩余风险