# Technical Writing

> 当需要编写技术文档、API文档、操作手册时使用。

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

---


# 技术文档能力 (Technical Writing)

技术文档方法论。让复杂的技术变得清晰易懂。

**核心原则: 准确性 > 可读性 > 简洁性。技术文档的首要任务是正确。**

## 文档类型

| 类型 | 结构 | 受众 |
|------|------|------|
| API 参考 | 端点/参数/响应/示例 | 开发者 |
| 操作手册 | 步骤/截图/注意事项 | 终端用户 |
| 架构文档 | 组件/流程/决策 | 技术团队 |
| 故障排查 | 症状/原因/解决 | 运维人员 |

## 技术文档规范

```
代码示例:
  ✅ 可直接运行
  ✅ 包含完整上下文
  ✅ 标注语言和版本

参数说明:
  ✅ 类型 + 是否必填 + 默认值 + 说明
  ✅ 枚举值列出所有选项

版本标注:
  ✅ API 版本号
  ✅ 最后更新日期
  ✅ 废弃项标注 @deprecated
```

## NEVER

- NEVER 代码示例无法运行
  替代: 所有示例都经过验证可执行
- NEVER 省略参数的类型和必填说明
  替代: 使用标准参数表格