Individual skill

zh-tech-writing

0upvotes

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

skills/zh-tech-writing/SKILL.md

Read pinned source

Source commit ffda9353768dece8aabd26ccb3a4978025e9437c

What was checked

Matches the observed repository HEAD: Yes
Scanner rules are current: Yes
Repository scan complete: Yes
Skill scan complete: Yes
Observed behavior: Instructions only
Last checked: Nov 10, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

Claude Code

Destination .claude/skills/zh-tech-writing

(
  set -euo pipefail
  destination='./.claude/skills/zh-tech-writing'
  if [ -e "$destination" ] || [ -L "$destination" ]; then printf '%s\n' 'Destination already exists; nothing overwritten.' >&2; exit 1; fi
  work=$(mktemp -d)
  trap 'rm -rf -- "$work"' EXIT
  git clone --filter=blob:none --no-checkout -- 'https://github.com/leter/zh-tech-writing.git' "$work/repo"
  git -C "$work/repo" checkout --detach ffda9353768dece8aabd26ccb3a4978025e9437c
  git -C "$work/repo" archive --format=tar 'ffda9353768dece8aabd26ccb3a4978025e9437c:skills/zh-tech-writing' > "$work/skill.tar"
  mkdir -p -- './.claude/skills'
  mkdir -- "$destination"
  tar -xf "$work/skill.tar" -C "$destination"
)

Codex

Destination .agents/skills/zh-tech-writing

(
  set -euo pipefail
  destination='./.agents/skills/zh-tech-writing'
  if [ -e "$destination" ] || [ -L "$destination" ]; then printf '%s\n' 'Destination already exists; nothing overwritten.' >&2; exit 1; fi
  work=$(mktemp -d)
  trap 'rm -rf -- "$work"' EXIT
  git clone --filter=blob:none --no-checkout -- 'https://github.com/leter/zh-tech-writing.git' "$work/repo"
  git -C "$work/repo" checkout --detach ffda9353768dece8aabd26ccb3a4978025e9437c
  git -C "$work/repo" archive --format=tar 'ffda9353768dece8aabd26ccb3a4978025e9437c:skills/zh-tech-writing' > "$work/skill.tar"
  mkdir -p -- './.agents/skills'
  mkdir -- "$destination"
  tar -xf "$work/skill.tar" -C "$destination"
)

Cursor

Destination .cursor/skills/zh-tech-writing

(
  set -euo pipefail
  destination='./.cursor/skills/zh-tech-writing'
  if [ -e "$destination" ] || [ -L "$destination" ]; then printf '%s\n' 'Destination already exists; nothing overwritten.' >&2; exit 1; fi
  work=$(mktemp -d)
  trap 'rm -rf -- "$work"' EXIT
  git clone --filter=blob:none --no-checkout -- 'https://github.com/leter/zh-tech-writing.git' "$work/repo"
  git -C "$work/repo" checkout --detach ffda9353768dece8aabd26ccb3a4978025e9437c
  git -C "$work/repo" archive --format=tar 'ffda9353768dece8aabd26ccb3a4978025e9437c:skills/zh-tech-writing' > "$work/skill.tar"
  mkdir -p -- './.cursor/skills'
  mkdir -- "$destination"
  tar -xf "$work/skill.tar" -C "$destination"
)

Gemini CLI

Destination .gemini/skills/zh-tech-writing

(
  set -euo pipefail
  destination='./.gemini/skills/zh-tech-writing'
  if [ -e "$destination" ] || [ -L "$destination" ]; then printf '%s\n' 'Destination already exists; nothing overwritten.' >&2; exit 1; fi
  work=$(mktemp -d)
  trap 'rm -rf -- "$work"' EXIT
  git clone --filter=blob:none --no-checkout -- 'https://github.com/leter/zh-tech-writing.git' "$work/repo"
  git -C "$work/repo" checkout --detach ffda9353768dece8aabd26ccb3a4978025e9437c
  git -C "$work/repo" archive --format=tar 'ffda9353768dece8aabd26ccb3a4978025e9437c:skills/zh-tech-writing' > "$work/skill.tar"
  mkdir -p -- './.gemini/skills'
  mkdir -- "$destination"
  tar -xf "$work/skill.tar" -C "$destination"
)

GitHub Copilot

Destination .github/skills/zh-tech-writing

(
  set -euo pipefail
  destination='./.github/skills/zh-tech-writing'
  if [ -e "$destination" ] || [ -L "$destination" ]; then printf '%s\n' 'Destination already exists; nothing overwritten.' >&2; exit 1; fi
  work=$(mktemp -d)
  trap 'rm -rf -- "$work"' EXIT
  git clone --filter=blob:none --no-checkout -- 'https://github.com/leter/zh-tech-writing.git' "$work/repo"
  git -C "$work/repo" checkout --detach ffda9353768dece8aabd26ccb3a4978025e9437c
  git -C "$work/repo" archive --format=tar 'ffda9353768dece8aabd26ccb3a4978025e9437c:skills/zh-tech-writing' > "$work/skill.tar"
  mkdir -p -- './.github/skills'
  mkdir -- "$destination"
  tar -xf "$work/skill.tar" -C "$destination"
)

OpenCode

Destination .opencode/skills/zh-tech-writing

(
  set -euo pipefail
  destination='./.opencode/skills/zh-tech-writing'
  if [ -e "$destination" ] || [ -L "$destination" ]; then printf '%s\n' 'Destination already exists; nothing overwritten.' >&2; exit 1; fi
  work=$(mktemp -d)
  trap 'rm -rf -- "$work"' EXIT
  git clone --filter=blob:none --no-checkout -- 'https://github.com/leter/zh-tech-writing.git' "$work/repo"
  git -C "$work/repo" checkout --detach ffda9353768dece8aabd26ccb3a4978025e9437c
  git -C "$work/repo" archive --format=tar 'ffda9353768dece8aabd26ccb3a4978025e9437c:skills/zh-tech-writing' > "$work/skill.tar"
  mkdir -p -- './.opencode/skills'
  mkdir -- "$destination"
  tar -xf "$work/skill.tar" -C "$destination"
)

Repository context

Repository stars (not skill ratings): 412
Repository last updated: Sep 24, 2026
License: MIT

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

agent-skills Repository topic
chinese Repository topic
claude-code Repository topic
documentation Repository topic
style-guide Repository topic
technical-writing Repository topic
writing Derived category
docs Derived category

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files

SKILL.mdcore · 6,359 bytes
references/manual-structure.mddoc · 1,362 bytes
references/typography.mddoc · 2,379 bytes

Read excerpt


# 中文技术文档写作

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

## 流程

**写新文档：**

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