Not in the top 1,000 by GitHub stars

leter/zh-tech-writing

写中文技术文档的 Agent Skill,基于阮一峰《中文技术文档的写作规范》:短句、平实、没有 AI 腔

History

Review weekly changes to SKILL.md before updating. Dates mark the weeks in which we observed each version; checks apply to the recorded commits.

View weekly changes

skills/zh-tech-writing/SKILL.md

Week of Nov 2, 2026 · +0 / −0 lines

Before Instructions only → After Instructions only

ffda9353768d → ffda9353768d

Compare on GitHub

Week of Oct 26, 2026 · Line counts unavailable

Before Not checked yet → After Instructions only

First observation → ffda9353768d

No earlier version was observed for comparison.

Compare on GitHub

View on GitHubAdd to my skills

Verified commit ffda9353768dece8aabd26ccb3a4978025e9437c

407GitHub stars
10stars in 7 days
1skill in this repository
0commits in 30 days

Heat

5.8
  • Star growth, last 7 daysNot available
  • Star growth, last 24 hoursNot available
  • Rank movement, last 7 daysNot available
  • Commits, last 30 daysNot available
  • Accounts asking about it through MCP, last 7 daysNot available
  • Hot votes this weekNot available

Heat never changes the order by stars, and sponsorship never touches it. How heat works

Stars over time

Oct 25, 2026Nov 6, 2026407

30-day change not yet available: not enough history.

Individual skills in this repository

How it works

zh-tech-writing

When your agent uses it

中文技术文档写作规范。写或修改中文技术文档、开发文档(README、设计文档、接口说明、教程)时使用。

What it loads into context

Frontmatter

42 tokens

Always available to the agent

SKILL.md

1,836 tokens

When the skill is activated

Reference documents

1,155 tokens

Loaded on request

Token counts are estimates. Scripts run separately; they are not counted as reference context.

The playbook

  1. 流程
  2. 句子
  3. 语气
  4. 段落与结构
  5. 排版
  6. AI 腔清单

Files

  • SKILL.mdcore6,359 bytes
  • references/manual-structure.mddoc1,362 bytes
  • references/typography.mddoc2,379 bytes
Read SKILL.md

# 中文技术文档写作

目标:写出像资深工程师写的中文技术文档。**平实**、**具体**、**短句**。

## 流程

**写新文档:**

1. 先想清楚读者是谁,读完要能做成什么事。一句话说不清,先问用户。
2. 按下面的“句子”“语气”“段落与结构”“排版”写。
3. 自检:拿“AI 腔清单”逐条对照全文,命中的全部改掉。
4. 跑 `autocorrect --fix <文件>`,修空格和标点。命令不存在就跳过,改为按“排版”手动检查。
5. 手动检查 autocorrect 管不到的:引号、省略号、破折号。
View the complete source on GitHub

Skills included

  • zh-tech-writing

Repository facts

License
MIT
Created
Sep 24, 2026
Last pushed
Sep 24, 2026
Forks
20
Open issues
0
Project activity
Active

Before you install

Instructions only

Automated signals, not a guarantee

Checked Nov 5, 2026

  • No broad tool permissions
  • No dangerous shell commands
  • No hidden or obfuscated text
  • No instruction overrides
  • No executable scripts
  • No access to secrets
  • No requests to vote in Hot
Show the signal with its line

skills/zh-tech-writing/references/manual-structure.md

  • Network accessline 20
    参考范例:[Redux 文档](https://redux.js.org/introduction/getting-started)。

How the signals fit together

Facts from a static read of the files at the pinned commit. They describe what the code does, not why.

Signal confidence: 1 fact

Works with

Agent compatibility, from the files in this repository
AgentStatusEvidenceInstall to
Claude CodeCompatibleStandard SKILL.md skills/zh-tech-writing/SKILL.md.claude/skills/<skill-name>/
CodexCompatibleStandard SKILL.md skills/zh-tech-writing/SKILL.md.agents/skills/<skill-name>/
CursorCompatibleStandard SKILL.md skills/zh-tech-writing/SKILL.md.cursor/skills/<skill-name>/
Gemini CLICompatibleStandard SKILL.md skills/zh-tech-writing/SKILL.md.gemini/skills/<skill-name>/
GitHub CopilotCompatibleStandard SKILL.md skills/zh-tech-writing/SKILL.md.github/skills/<skill-name>/
OpenCodeCompatibleStandard SKILL.md skills/zh-tech-writing/SKILL.md.opencode/skills/<skill-name>/
  • Native The repository ships a manifest, folder or frontmatter field for this agent.
  • Compatible A standard SKILL.md that this agent can read.
  • Unknown No evidence either way.

Derived automatically from paths, manifests and frontmatter. Not tested on each agent.