Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →中文技术文档写作规范，包含 API 文档、架构文档、部署文档的写作模板与最佳实践
| Test case | Without → With | Effect | Δ tokens | Δ turns |
|---|---|---|---|---|
| case-07 | ✗→✓ | ▲ Improved | 1% | 0% |
| case-12 | ✗→✓ | ▲ Improved | 6% | 0% |
| case-18 | ✗→✓ | ▲ Improved | 9% | 0% |
| case-17 | ✗→✓ | ▲ Improved | 16% | 0% |
| case-04 | ✓→✓ | ＝ Same ✓ | 32% | 0% |
提供中文技术文档的写作规范和模板，涵盖 API 文档、架构设计文档、部署运维文档，帮助团队产出高质量技术文档。
技术文档应包含：标题、版本历史、概述、目录、正文、附录。正文按"是什么-为什么-怎么做"组织。
API 文档包含：接口名称、请求方法、URL、请求参数（表格：参数名/类型/必填/说明）、响应格式（JSON 示例）、错误码表、curl 和 Python 调用示例。
架构文档包含：系统背景、架构图（Mermaid）、模块说明、数据流图、技术选型理由、性能指标、扩展方案。
部署文档包含：环境要求、依赖安装、配置说明、启动命令、健康检查、常见问题排查。每步提供可复制命令。
| 问题 | 原因 | 解决方案 | |------|------|---------| | 文档过时 | 未及时更新 | CI 检查文档与代码同步 | | 代码示例不可运行 | 复制粘贴错误 | 实际运行验证 | | 架构图不清晰 | 工具不熟练 | 使用 Mermaid 语法 | | 中英混杂 | 无统一规范 | 制定术语表 |
Other measured skills in the registry, with their headline benchmark lift.