Ready to supercharge your AI agents?

Install any skill in seconds. Free to start, no credit card required.

Get Started Free →

Tech Doc Cn · yangge521 | DecimalAI

documentationby yangge521

Tech Doc Cn

yangge521/tech-doc-cn

Source yangge521/dev-skills-zh ↗License MIT

中文技术文档写作规范，包含 API 文档、架构文档、部署文档的写作模板与最佳实践

SkillScore82Maintained

Automatic

Doc Ops pack

Last verified 8/3/2026

What it changes

Passed 18 of 22 test cases with the skill, and 14 of 22 without it.

Without skill64%

With skill82%

Checks it passed that the model alone missed

The document contains a dedicated section or header for health checks (健康检查).
The recommended solution requires actual execution validation of code examples.
The troubleshooting section presents problem, cause, and solution structured in a table.

and 1 more in the full report

4 fixed14 passed either way4 still failing0 broke

Pass-rate lift: +18 pp
Tokens: +12%
Agent turns: 0%
Response time: -13%

Model gemini-3.6-flashMeasured 8/3/2026v118 of 22 cases passed with skill

Tokens, turns and time describe resource use, not a dollar price.

Use this skill

Save it into your project's skills folder. Claude Code picks it up in its next session.

curl -fsSL --create-dirs -o .claude/skills/yangge521-tech-doc-cn/SKILL.md https://app.decimal.ai/s/yangge521-tech-doc-cn/SKILL.md

Want it pinned and updatable? pip install "decimalai>=0.15", then decimalai skills add yangge521-tech-doc-cn, and start Claude Code with claude --plugin-dir "$(git rev-parse --show-toplevel)/.agents"

1 · One-time — install the CLI (docs ↗)

pip install "decimalai>=0.15"

2 · Get the skill — writes .agents/skills/yangge521-tech-doc-cn/ and pins it in .decimal/skills.lock

decimalai skills add yangge521-tech-doc-cn

No CLI? Get the same file — curl · raw file

curl -fsSL --create-dirs -o .claude/skills/yangge521-tech-doc-cn/SKILL.md https://app.decimal.ai/s/yangge521-tech-doc-cn/SKILL.md

Raw file: /s/yangge521-tech-doc-cn/SKILL.md ↗ · machine-readable summary at /s/yangge521-tech-doc-cn.json ↗

Safety checks: 3 of 3 passed

Code scan CleanIntent PassedContent Clean

See it in action

One of 4 test cases the skill fixed. Same model, same prompt, with and without the skill.

1 of 4

Prompt

请为 Triton Inference Server 撰写部署文档中的常见故障排查章节，包含显存溢出与超时问题。

What was checked, without and with the skill
Checked	Without skill	With skill
The troubleshooting section presents problem, cause, and solution structured in a table.	Missed	Passed

case-12 · gemini-3.6-flash · 8/3/2026 · answers are capped and redacted

What's inside

The instructions your model reads when the skill loads.

SKILL.md73 linessingle file

中文技术文档写作

概述

提供中文技术文档的写作规范和模板，涵盖 API 文档、架构设计文档、部署运维文档，帮助团队产出高质量技术文档。

使用场景

API 接口文档：为推理 API 编写接口文档
架构设计文档：系统设计方案评审
部署运维手册：GPU 推理服务部署文档
技术方案：项目立项和方案评审
事故复盘：故障分析和复盘报告
用户指南：产品使用说明

写作规范

1. 文档结构

技术文档应包含：标题、版本历史、概述、目录、正文、附录。正文按"是什么-为什么-怎么做"组织。

2. API 文档模板

API 文档包含：接口名称、请求方法、URL、请求参数（表格：参数名/类型/必填/说明）、响应格式（JSON 示例）、错误码表、curl 和 Python 调用示例。

3. 架构文档模板

架构文档包含：系统背景、架构图（Mermaid）、模块说明、数据流图、技术选型理由、性能指标、扩展方案。

4. 部署文档模板

部署文档包含：环境要求、依赖安装、配置说明、启动命令、健康检查、常见问题排查。每步提供可复制命令。

5. 写作风格

简洁中文，避免翻译腔
技术术语保留英文（GPU、FPS、Batch Size）
代码示例确保可运行
表格优于长段落
关键信息加粗

Track record

Benchmark

18 / 22

test cases passed, vs 14 / 22 without

Adoption

Users: 3
Times used: 20

Safety and source details

SkillSafety

✓ 3 of 3 passed

Code scan15 of 15 checks clean

0 critical · 0 warning · 0 info — scanner v4 — 8/1/2026

View 15 scanner checks

live_secretremote_code_executionreverse_shelldata_exfiltrationssrf_metadataagent_snoopinganti_refusaldestructive_commandsobfuscated_unicodeunicode_homoglyphopaque_blobsuspicious_urltool_overreachtrigger_abuseprompt_injection_phrasing

IntentSafe

LLM judge · does the skill do what it claims

ContentClean

LLM judge · policy & harmful-content review

Source

Imported

yangge521 / dev-skills-zh

skills/productivity/tech-doc-cn/SKILL.md

View on GitHub ↗

License MITImported 8/1/2026Version v1

More skills from the same source and nearby in the registry, with their headline benchmark lift.