BC china-api-doc-generator
Generate API documentation in Chinese technical writing style for Chinese developer audiences. Teach AI agents how to write API docs that follow Chinese documentation conventions, include proper error codes, SDK examples in popular Chinese frameworks, and comply with Chinese open platform documentation standards. Covers: RESTful API doc generation, WeChat/Alipay open platform style docs, SDK example generation (Java/Python/Node/Go), error code system design, and interactive API playground setup. Triggers on: 中文API文档, chinese api documentation, API文档生成, api doc generator, 中国开发者文档, china developer docs, 接口文档, interface documentation, SDK示例, sdk examples china, 错误码设计, error code design, 开放平台文档, open platform docs, 微信开放平台文档风格, wechat open platform style, 中文技术写作, chinese technical writing
Generate API documentation in Chinese technical writing style for Chinese developer audiences.
As a process C 57/100 · Has gaps — weak spots: result and completion, inputs and preconditions, progress reporting
How to improve
- Say in the description WHEN to use the skill ("use when…", example requests): that is the agent's main cue.
- Your own cases (evals/evals.json, 4–6 real requests with expected answers): the full check would then run those instead of a model-drafted suite.
- A spec.yaml with trigger phrases and assertions — a behaviour contract for CI; `skilltest init` writes a template.
Guard findings · 0
✓ No critical or high findings
Files scanned: 2. Evidence is masked. Grey chips explain why severity was lowered.
Against the Agent Skills spec
- warning
description-no-whendescription does not say WHEN to use the skill (no "use when")
Process rating: all ten parameters 57/100
- 0Result and completion. Does not say what the result is
- 0Inputs and preconditions. Does not say what the process needs to start
- 0Progress reporting. Says nothing while it works
- 50Failures and branches. 0 branches, has a failure section
- 60Tools and files. Uses tools (python, node) that frontmatter does not declare
- 70When it triggers. States when to use, but not when not to
- 100Steps. 7 steps
- 100Consistency. Name and required fields are in place
- 100Execution cost. Instruction body is 1538 tokens
- 100Running it twice. No mutating operations
- medium Safety rules and hard prohibitions inside a skill: they belong in the system prompt, here they protect nothing
Everything here is measured from the skill text rather than judged by a model, so the numbers are checkable. A parameter weighs more when it is a more common reason for the process to stall.
Quality signals
- +5Description has no quoted example phrases that should trigger the skill
- +4Description does not say when NOT to use the skill (false activations)
- +3Output format is not stated: the model decides each time
- +1No license
- +2Single-language instructions
- +3Description length 794: enough signal without eating the budget
- +4Structure: 12 headings
- +3Step-by-step instructions: 7 items
- +4Has examples (5 code blocks)
Quality base 70; lint remarks subtract, signals add up to 100. Result: 72.