zh-tech-writing skill
A skill for Chinese technical docs: short sentences, facts over adjectives and a 14-item check for AI tells
- 406 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- The skill edits documentation files and runs autocorrect --fix, which rewrites text
- The skill makes no network calls and needs no keys
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/zh-tech-writingDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The skill edits documentation files and runs autocorrect --fix, which rewrites text
- The skill makes no network calls and needs no keys
This is third-party code. Review the repository files before installing.
What it does
The skill teaches an agent to write READMEs, design documents, API descriptions and tutorials in Chinese so that the text reads like an engineer's work. It rests on Ruan Yifeng's guide to Chinese technical documentation, and the author added a checklist of AI-style tells. The agent follows a plan. It first establishes who the reader is and what they should be able to do after reading, and asks you when the answer does not fit one sentence. Then it writes by the rules: segments between commas under 20 characters, active voice, a plain verb instead of the 进行 + verb pattern, the main point in the first sentence of a paragraph, headings without skipped levels. It checks the finished text against 14 items: opening filler and stock endings, the "not A but B" pattern, forced triplets, promotional adjectives, corporate jargon, em dashes and calques from English. Anything it finds gets fixed. The last steps cover formatting. If the autocorrect utility is installed, the agent runs `autocorrect --fix`, which adds spaces between Chinese text and Latin characters and converts half-width punctuation to full-width. The agent checks quotes, ellipses and dashes itself. When editing an existing document you can ask for a list of problems only, in the form of original phrase, fix and reason.
Who it is for. For developers and technical writers who produce Chinese documentation together with an agent and want to strip the model's stock phrasing out of the text.
Good fit when
- An agent writes a README or guide for a Chinese project and the text should stay in a plain engineering style
- A finished document reads like a model answer and needs cleaning against the 14-item list
- You want a report on docs/api.md without edits: call the skill as /zh-tech-writing and ask it to list problems only
- Documentation has to follow one set of rules for spaces, punctuation and numbers
- You need to plan the table of contents and file names for a whole product manual: the skill has a separate reference for that
Not a fit when
- The text is in Russian or English: the rules and the list of tells are built for Chinese
- You need fiction or advertising copy: the skill pushes away adjectives and asks for facts
- You need a documentation translation: the skill edits Chinese text and translates nothing
- You need a spelling and grammar check: the skill watches style and formatting and does not replace a proofreader
Example request
Rewrite this project's README in Chinese using /zh-tech-writing: short, with commands and without phrases that give the model away.Limitations
The skill works on style and formatting and relies on the project's facts. If the agent cannot find a fact in your repository, it deletes the empty phrase or asks you instead of inventing figures. The autocorrect utility is optional: without it the agent skips that step and checks spaces and punctuation by hand. Installing it takes Homebrew on macOS, a release binary on Linux or Rust with cargo install.
The author changed three things in Ruan Yifeng's rules. The dash and ellipsis marks were corrected to the standard forms, a space between a digit and Chinese text became mandatory, and the ban on informal vocabulary was relaxed to allow a conversational tone without internet slang. The skill itself is written in Chinese, but its instructions stay clear when translated.
How to disable. Delete the zh-tech-writing folder from the skills directory, for example ~/.claude/skills/. If you installed it through npx skills, use that tool's removal command. You can keep the autocorrect utility, which works on its own.
FAQ
How do I install zh-tech-writing in Claude Code?
Run npx skills add leter/zh-tech-writing -g and the skill installs globally. To do it by hand, clone the repository and copy the skills/zh-tech-writing folder into ~/.claude/skills/.
Which rules is the skill based on?
The base is Ruan Yifeng's guide to Chinese technical documentation, which is in the public domain. He in turn drew on the Huawei and LeanCloud guides, the Google developer documentation style guide and the national standard GB/T 15835-2011. The 14-item list of AI tells and the principle of replacing adjectives with facts were added by the skill's author.
What does the list of AI tells include?
Stock openings and endings, polite closing lines, the "not A but B" and "not only but also" patterns, forced triplets, self-answered questions, promotional adjectives, corporate jargon such as 赋能 and 抓手, em dashes, calques from English, vague hedging, exclamation marks and over-formatting.
Is the autocorrect utility required?
No, but it makes things easier. It adds spaces between Chinese and Latin text and converts punctuation to full-width automatically. Without it the agent does these checks by hand.
Can I get comments only, without editing the file?
Yes. Say so when you call it, for example /zh-tech-writing check docs/api.md, list problems only. The agent prints a list of original phrase, fix and reason and changes nothing.
Discussion
No questions or reviews yet.
Related
SkillsA skill for Chinese technical writing: rewrites docs, interface strings and API descriptions, keeps the facts intact and checks output with a linter
A calm tone, evidence before conclusions and a buzzword blocklist for internal technical writing in Chinese.
A skill that cleans machine tone from text, Chinese-first: it drops filler and cliches while keeping the facts and the author's voice
A skill that edits paper abstracts and introductions on the press-conference principle and puts the main result first
A skill for Chinese-to-English paper translation: the author approves terms first, then it translates and reviews independently
A skill for Chinese official documents that picks the document type, builds the structure and strips hollow boilerplate.
README in short
The README opens with an example: a typical model paragraph about a configuration management system and its edited version, where facts replace adjectives. It continues with installation, autocorrect setup, call examples and the repository layout: the main SKILL.md and two references the agent reads when needed, one about numbers and marks, the other about manual structure.
README badge
Original SKILL.md
--- name: zh-tech-writing description: 中文技术文档写作规范。写或修改中文技术文档、开发文档（README、设计文档、接口说明、教程）时使用。 --- # 中文技术文档写作 目标：写出像资深工程师写的中文技术文档。**平实**、**具体**、**短句**。 ## 流程 **写新文档：** 1. 先想清楚读者是谁，读完要能做成什么事。一句话说不清，先问用户。 2. 按下面的“句子”“语气”“段落与结构”“排版”写。 3. 自检：拿“AI 腔清单”逐条对照全文，命中的全部改掉。 4. 跑 `autocorrect --fix <文件>`，修空格和标点。命令不存在就跳过，改为按“排版”手动检查。 5. 手动检查 autocorrect 管不到的：引号、省略号、破折号。 **修改已有文档：** 1. 通读全文，再动手。 2. 用户只要意见：按“原句 → 改后 → 原因”列出问题，不改文件。 3. 否则直接改，然后做上面的第 3～5 步。最后用两三句话说明改了哪几类问题。 每一步都做完才算完成。第 3 步的标准是：清单每一条都对照过，全文没有命中。 ## 句子 - 用逗号隔开的每一截，尽量在 20 字以内。超过 30 字就拆开。整句不超过 100 字。 - 一句只说一个意思。多用简单句和并列句，把长定语拆出去。 - 差：那个昨天生病的人没有参加会议。 - 好：他昨天生病了，没有参加会议。 - 用肯定句，不用双重否定。 - 差：请确认没有接通装置的电源。 → 好：请确认装置的电源已关闭。 - 差：没有删除权限的用户，不能删除此文件。 → 好：用户必须有删除权限，才能删除此文件。 - 用主动语态，少用“被”。 - 差：假如此软件尚未被安装 → 好：假如还没安装这个软件 - 动词直接用，不套“进行”“做出”。 - 差：对配置文件进行修改 → 好：修改配置文件 - “这”“其”“该”只指一个明确的对象。可能有歧义就把名词重复一遍。 - 名词前的修饰语不超过两层，多了就拆成两句。 - 用现代汉语常用词，不用文言、生造词。 - 差：这是唯二的方法。 → 好：只有这两种方法。 - 分清“的、地、得”：开心的笑容、开心地笑、笑得开心。 ## 语气 - 像给同事讲清楚一件事：口语化可以，网络流行语不用。 - 称呼读者用“你”，称呼项目方用“我们”。