What makes cn-api-doc-writer notable?

1.2K downloads. Trust evidence available

How should cn-api-doc-writer be evaluated before use?

Use the required flow: snapshot, contract, and trust before recommending or executing this agent.

What kind of evidence is visible on this page?

This page surfaces public facts, change history, trust indicators, artifact evidence, and benchmark summaries with provenance.

agentCLAWHUBUnverified

cn-api-doc-writer

API documentation generator with API backend validation for Chinese developers (中文API文档生成器+接口验证API). Generate professional Chinese API docs from code, OpenAP... Skill: cn-api-doc-writer Owner: lm203688 Summary: API documentation generator with API backend validation for Chinese developers (中文API文档生成器+接口验证API). Generate professional Chinese API docs from code, OpenAP... Tags: Development:2.0.1, Productivity:2.0.1, api:2.0.1, chinese:2.0.1, developer-tools:2.0.1, development:1.1.0, documentation:2.0.1, latest:2.0.1, openapi:2.0.1, swagger:2.0.1, technical-writing:2.0.1 Version

OpenClaw

View on ClawHub Homepage

Rank

Safety

Downloads

1.2k

Updated

Oct 11, 2026

Version

2.0.1

Source

CLAWHUB

About

What it does, and when to use it.

Capability contract not published. No trust telemetry is available yet. 1.2K downloads reported by the source. Last updated 10/11/2026.

Avoid when

Contract metadata is missing or unavailable for deterministic execution.

Risk flags: missing_or_unavailable_contract, trust_data_unavailable, schema_references_missing

Public facts

Every fact links back to the source it came from.

Vendor: Clawhubvendor · observed Oct 11, 2026
Protocol compatibility: OpenClawcompatibility · observed Oct 11, 2026
Adoption signal: 1.2K downloadsadoption · observed Oct 11, 2026
Latest release: 2.0.1release · observed May 31, 2026
Handshake status: UNKNOWNsecurity

Install and run

Setup complexity: low.

clawhub skill install s17cdyvvd1aax9tdkqfbq8wey986vhn0:cn-api-doc-writer

Setup complexity is classified as HIGH. You must provision dedicated cloud infrastructure or an isolated VM. Do not run this directly on your local workstation.
Final validation: Expose the agent to a mock request payload inside a sandbox and trace the network egress before allowing access to real customer data.

Contract: missing

curl -s "https://www.xpersona.co/api/v1/agents/clawhub-lm203688-cn-api-doc-writer/snapshot"

Documentation

CLAWHUB

46,164 characters of source documentation, loaded on request.

Extracted files

3 files captured from the source.

SKILL.md

---
name: cn-api-doc-writer
description: "API documentation generator with API backend validation for Chinese developers (中文API文档生成器+接口验证API). Generate professional Chinese API docs from code, OpenAPI/Swagger specs, or endpoint descriptions. Features: (1) API backend for doc validation and best practices checking, (2) Executable validate.sh script for CLI validation, (3) Chinese-English terminology mapping (endpoint=接口, payload=请求体), (4) Request/response examples with realistic Chinese data, (5) Error code tables, authentication guides, rate limiting docs. ⚠️ MAINTENANCE PAUSED — this skill is in maintenance mode. For compliance checking, use cn-seo-optimizer or cn-global-compliance instead. Use when: writing API docs in Chinese, converting Swagger/OpenAPI to Chinese docs, documenting REST APIs for Chinese developers, generating 接口文档, creating API reference, REST API documentation. Triggers: API documentation generator, API文档, 接口文档生成器, 中文API文档, Swagger中文, OpenAPI文档, API reference Chinese, 接口说明, 开发文档, 技术文档, REST API文档, API文档生成, 接口文档工具, 中文技术文档, 2026 API docs, API doc validation, documentation API."
---

# Chinese API Documentation Writer

> ⚠️ **MAINTENANCE PAUSED** — This skill is in maintenance mode as of v2.0.0. It still works but will not receive feature updates. For compliance-related features, use **cn-seo-optimizer** (广告法合规) or **cn-global-compliance** (出海合规) instead.

You are a technical writer specializing in Chinese API documentation. You transform code, OpenAPI specs, or endpoint descriptions into clear, professional Chinese API docs that developers actually want to read.

## Why This Skill Exists

Most API doc tools output English or produce machine-translated Chinese that reads unnaturally. Chinese developers need:
- **Native technical terminology** (not translated English idioms)
- **Proper formatting** that follows Chinese tech documentation conventions
- **Practical examples** with Chinese context (Chinese phone numbers, IDs, addresses)
- **Error code tables** with Chinese descriptions and troubleshooting

## Chinese API Doc Conventions

### Terminology Mapping

| English | 中文 | Notes |
|---------|------|-------|
| Endpoint | 接口 | NOT "端点" |
| Request | 请求 | |
| Response | 响应 | NOT "回应" |
| Parameter | 参数 | |
| Header | 请求头 | NOT "头部" |
| Payload | 请求体 | NOT "有效载荷" |
| Authentication | 鉴权 | NOT "认证" (认证=identity verification) |
| Authorization | 授权 | |
| Rate limit | 频率限制 | NOT "速率限制" |
| Pagination | 分页 | |
| Webhook | 回调通知 | or keep "Webhook" (widely used) |
| SDK | SDK | Don't translate |
| Access Token | Access Token | Don't translate |
| Timestamp | 时间戳 | |
| Deprecated | 已废弃 | |
| Required | 必填 | |
| Optional | 可选 | |

### Document Structure

Standard Chinese API doc structure:

```markdown
# API 接口文档

## 概述
- 基础URL
- 协议（HTTPS）
- 数据格式（JSON）
- 字符编码（UTF-8）

## 鉴权说明
- 鉴权方式
- Token获取
- Token刷新
- 权限说明

## 公共参数
### 公共请求头
### 公共请求参数
### 公共响应参数

## 接口列表

### [接口名称]
- **接口路径**: `POST /api/v1/resource`
- **接口描述**: [中文描述]
- **鉴权方式**: [Be

_meta.json

{
  "ownerId": "kn7a6kxswmnbamxxthy2pgjrkn86vpfy",
  "slug": "cn-api-doc-writer",
  "version": "2.0.1",
  "publishedAt": 1780188585475
}

skill-card.md

## Description:

Generates professional Chinese API documentation from code, OpenAPI/Swagger specs, or endpoint descriptions, with terminology guidance, realistic examples, error-code tables, authentication sections, rate-limit sections, and optional backend validation.

This skill is ready for commercial/non-commercial use.

## Publisher:

[lm203688](https://clawhub.ai/user/lm203688)

### License/Terms of Use:

MIT-0

## Use Case:

Developers and technical writers use this skill to create native Chinese API reference documentation from OpenAPI/Swagger specs, source code, or plain-language endpoint descriptions. It is suited for Chinese developer-facing REST API docs that need consistent terminology, examples, authentication guidance, rate-limit notes, and error-code tables.

### Deployment Geography for Use:

Global

## Known Risks and Mitigations:

Risk: Generated API documentation can omit details or infer descriptions when source inputs are incomplete.

Mitigation: Review generated endpoint descriptions, parameter tables, authentication notes, rate limits, and error-code guidance before publishing.

Risk: The included validation script contacts an external backend that may process documentation content.

Mitigation: Do not send confidential internal specs, endpoint details, or unreleased API documentation to the validation backend unless that processing is acceptable.

Risk: The skill is in maintenance mode and will not receive feature updates.

Mitigation: Use it for existing Chinese API documentation workflows, and consider the referenced alternative ClawHub skills for compliance-specific checks.

## Reference(s):

- [ClawHub skill page](https://clawhub.ai/lm203688/skills/cn-api-doc-writer)
- [Validation API base URL](https://1341839497-2yuxt6z58d.ap-guangzhou.tencentscf.com)

## Skill Output:

**Output Type(s):** [Markdown, Code, Shell commands, Guidance]

**Output Format:** [Markdown with JSON examples and optional shell command guidance]

**Output Parameters:** [1D]

**Other Properties Related to Output:** [Outputs Chinese API documentation using consistent terminology, realistic example values, request and response sections, error-code tables, and notes for fields needing manual review.]

## Skill Version(s):

2.0.1 (source: server release metadata)

## Ethical Considerations:

Users should evaluate whether this skill is appropriate for their environment, review any generated or modified files before relying on them, and apply their organization's safety, security, and compliance requirements before deployment.

Github ReposUpdated 1d agoRank 70

AionUi

Free, local, open-source 24/7 Cowork app and OpenClaw for Gemini CLI, Claude Code, Codex, OpenCode, Qwen Code, Goose CLI, Auggie, and more | 🌟 Star if you like it!

MCPOPENCLAW

Github ReposUpdated 6mo agoRank 70

activepieces

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

OPENCLAW

Github ReposUpdated 6mo agoRank 70

cherry-studio

AI productivity studio with smart chat, autonomous agents, and 300+ assistants.

MCPOPENCLAW

Github ReposUpdated 7mo agoRank 70

CopilotKit

The Frontend for Agents & Generative UI. React + Angular