zh-tech-writing — скилл

Скилл для китайской технической документации: короткие фразы, факты вместо эпитетов и чистка 14 примет ИИ-текста по правилам Жуань Ифэна

  • 406 ★ репозитория
  • Последний коммит
  • MIT
Скилл

Расширенный доступ

Почему такой уровень

  • Скилл правит файлы документации и запускает команду autocorrect --fix, которая перезаписывает текст
  • Сетевых вызовов и ключей у скилла нет
Все причины и проверки

leter/zh-tech-writing

Установка

Работает в

В терминале, через SkillFoxx CLI

npx skillfoxx add skills/zh-tech-writing

Определит агенты на машине, покажет уровень доступа и зафиксирует версию.

Другие способы установки

Доступ и проверки

Как мы проверяем

Расширенный доступИнструмент запускает код или ходит в сеть, а внешние данные только читает.

  • Скилл правит файлы документации и запускает команду autocorrect --fix, которая перезаписывает текст
  • Сетевых вызовов и ключей у скилла нет

Это чужой код. Посмотрите файлы в репозитории перед установкой.

Что делает

Скилл учит агента писать README, дизайн-документы, описания интерфейсов и руководства на китайском так, чтобы текст читался как работа инженера. За основу взяты правила Жуань Ифэна из «Норм китайской технической документации», к ним автор добавил список примет ИИ-стиля. Агент идет по плану. Сначала выясняет, кто читатель и что он должен суметь сделать после прочтения, и спрашивает вас, если ответ не складывается в одну фразу. Затем пишет по правилам: отрезки между запятыми до 20 знаков, активный залог, прямой глагол вместо оборота «进行» с глаголом, первая фраза абзаца с главной мыслью, заголовки без пропусков уровней. Готовый текст агент сверяет со списком из 14 пунктов: вступительные штампы и дежурные концовки, шаблонные противопоставления, искусственные тройки, рекламные эпитеты, корпоративный жаргон, длинное тире, калька с английского. Найденное он исправляет. Последние шаги касаются оформления. Если установлена утилита autocorrect, агент запускает `autocorrect --fix`: она ставит пробелы между китайским текстом и латиницей и меняет полуширинные знаки препинания на полноширинные. Кавычки, многоточие и тире агент проверяет сам. В режиме правки готового документа можно попросить только список замечаний в виде «исходная фраза, исправление, причина».

Для кого. Для разработчиков и технических авторов, которые пишут документацию на китайском вместе с агентом и хотят убрать из текста шаблонные обороты нейросети.

Подходит, если

  • Агент пишет README или руководство по китайскому проекту, и текст нужно держать в простом инженерном стиле
  • Готовый документ выглядит как ответ нейросети, и его нужно вычистить по списку из 14 пунктов
  • Нужен отчет по файлу docs/api.md без правок: скилл вызывают командой /zh-tech-writing с просьбой только перечислить проблемы
  • Документацию надо привести к единым правилам пробелов, знаков препинания и написания чисел
  • Нужно спланировать оглавление и имена файлов для целого руководства по продукту: для этого у скилла есть отдельная справка

Не подходит, если

  • Текст на русском или английском: правила и список примет рассчитаны на китайский язык
  • Нужна художественная или рекламная проза: скилл отучает от эпитетов и требует фактов
  • Нужен перевод документации: скилл редактирует китайский текст и ничего не переводит
  • Нужна проверка орфографии и грамматики: скилл следит за стилем и оформлением и не заменяет корректора

Пример запроса к агенту

Перепиши README этого проекта на китайском по /zh-tech-writing: коротко, с командами и без оборотов, которые выдают нейросеть.

Ограничения

Скилл работает со стилем и оформлением и опирается на факты проекта. Если агент не находит факт в вашем репозитории, он удаляет пустую фразу или спрашивает вас и цифры не придумывает. Утилита autocorrect необязательна: без нее агент пропускает шаг и проверяет пробелы и знаки препинания вручную. Для ее установки нужны Homebrew на macOS, бинарный файл из релизов на Linux или Rust с командой cargo install.

Автор изменил в правилах Жуань Ифэна три места. Он исправил знаки тире и многоточия на стандартные, обязал ставить пробел между цифрой и китайским текстом, а запрет на неформальную лексику смягчил до разрешения разговорного тона без интернет-сленга. Сам скилл написан на китайском, но инструкции понятны и в переводе.

Как отключить. Удалите папку zh-tech-writing из каталога скиллов, например из ~/.claude/skills/. Если ставили через npx skills, повторите команду управления скиллами с удалением. Утилиту autocorrect можно оставить: она работает отдельно.

Частые вопросы

Как поставить zh-tech-writing в Claude Code?

Выполните npx skills add leter/zh-tech-writing -g, и скилл встанет глобально. Вручную достаточно клонировать репозиторий и скопировать папку skills/zh-tech-writing в ~/.claude/skills/.

На каких правилах основан скилл?

Основа — «Нормы китайской технической документации» Жуань Ифэна, проект находится в общественном достоянии. Сам Жуань Ифэн опирался на руководства Huawei и LeanCloud, документацию по стилю Google и государственный стандарт GB/T 15835-2011. Список из 14 примет ИИ-текста и принцип замены эпитетов фактами добавил автор скилла.

Что входит в список примет ИИ-текста?

Вступления и концовки-штампы, дежурные пожелания, шаблонные противопоставления и градации, искусственные тройки, самоответы на собственные вопросы, рекламные эпитеты, корпоративный жаргон вроде «赋能» и «抓手», длинное тире, калька с английского, расплывчатые оговорки, восклицательные знаки и чрезмерное форматирование.

Нужна ли утилита autocorrect?

Нет, но с ней проще. Она автоматически расставляет пробелы между китайским и латиницей и приводит знаки препинания к полноширинным. Без нее агент выполнит эти проверки вручную.

Можно ли получить только замечания, без правки файла?

Да. Скажите об этом при вызове, например /zh-tech-writing проверь docs/api.md, только перечисли проблемы. Агент выведет список в виде «исходная фраза, исправление, причина» и ничего не изменит.

Обсуждение

Вопросов и отзывов пока нет.

Скиллы

Скилл для китайских технических текстов: правит документацию, интерфейсные строки и описания API, держит факты и проверяет выдачу линтером

СкиллМинимальный доступ1,6 тыс.Звезды репозитория

Ровный тон, доказательства перед выводами и блок-лист жаргона для внутренних технических текстов на китайском.

СкиллМинимальный доступ219Звезды репозитория

Скилл для чистки текста от машинного тона, прежде всего на китайском: убирает штампы и воду, сохраняет факты и голос автора

СкиллМинимальный доступ2,5 тыс.Звезды репозитория

Скилл правит аннотации и введения научных статей по принципу пресс-конференции и ставит вперед главный результат

СкиллМинимальный доступ5,2 тыс.Звезды репозитория

Скилл перевода научных статей с китайского на английский: согласует термины с автором, переводит и независимо проверяет рукопись

СкиллМинимальный доступ280Звезды репозитория

Скилл для текстов китайских госорганов: определяет вид документа, строит структуру и убирает пустые штампы.

СкиллМинимальный доступ431Звезды репозитория

Коротко о README

README показывает пример: типичный абзац нейросети про систему управления конфигурациями и его правку, где проявляются факты вместо эпитетов. Дальше идут установка, настройка autocorrect, примеры вызова и структура репозитория: основной SKILL.md и две справки, которые агент читает по необходимости, одна про числа и знаки, другая про структуру руководств.

Бейдж для README

Исходный 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 字。
- 一句只说一个意思。多用简单句和并列句,把长定语拆出去。
  - 差:那个昨天生病的人没有参加会议。
  - 好:他昨天生病了,没有参加会议。
- 用肯定句,不用双重否定。
  - 差:请确认没有接通装置的电源。 → 好:请确认装置的电源已关闭。
  - 差:没有删除权限的用户,不能删除此文件。 → 好:用户必须有删除权限,才能删除此文件。
- 用主动语态,少用“被”。
  - 差:假如此软件尚未被安装 → 好:假如还没安装这个软件
- 动词直接用,不套“进行”“做出”。
  - 差:对配置文件进行修改 → 好:修改配置文件
- “这”“其”“该”只指一个明确的对象。可能有歧义就把名词重复一遍。
- 名词前的修饰语不超过两层,多了就拆成两句。
- 用现代汉语常用词,不用文言、生造词。
  - 差:这是唯二的方法。 → 好:只有这两种方法。
- 分清“的、地、得”:开心的笑容、开心地笑、笑得开心。

## 语气

- 像给同事讲清楚一件事:口语化可以,网络流行语不用。
- 称呼读者用“你”,称呼项目方用“我们”。

Сообщить о проблеме

Foxx AIzh-tech-writing
Foxx AI

Я Foxx AI и уже разобрал этот инструмент. Спросите про установку, настройку или что угодно еще, отвечу простыми словами.