Chinese Tech Doc Style — скилл
Скилл для китайских технических текстов: правит документацию, интерфейсные строки и описания API, держит факты и проверяет выдачу линтером
- 1 540 ★ репозитория
- Последний коммит
- MIT
Минимальный доступ
Почему такой уровень
- Скилл меняет только текст, который вы ему дали, и ничего не запускает; линтер читает файлы и ничего не пишет
Установка
- Работает в
В терминале, через SkillFoxx CLI
npx skillfoxx add skills/chinese-tech-doc-styleОпределит агенты на машине, покажет уровень доступа и зафиксирует версию.
Другие способы установки
Доступ и проверки
Как мы проверяемМинимальный доступИнструмент ничего не запускает и не ходит в сеть.
- Скилл меняет только текст, который вы ему дали, и ничего не запускает; линтер читает файлы и ничего не пишет
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
Chinese Tech Doc Style — скилл для письма, правки и вычитки технических текстов на китайском: главных страниц документации, описаний API, инструкций по установке, разбора неисправностей, интерфейсных строк и кнопок. Правила нацелены на сдержанный, точный и легко читаемый текст без рекламного тона. Рецепты вычищают пустые обороты, повторы и интернет-жаргон вроде 赋能, 抓手, 闭环, 打通. Скилл ставит факты выше стиля. Он не добавляет в текст даты, цифры, сроки и условия, которых не было, и не убирает ограничения, предупреждения и степень уверенности. Код, ключи JSON, адреса URL, пути API и поля баз данных остаются нетронутыми. Среди правил: угловые кавычки 「」, пробелы между китайским текстом, латиницей и цифрами, один абзац на строку исходника и осторожный перевод англоязычных статусов вроде Success, Invalid и Bad Request. Для инструкций, диагностики и операционной документации в репозитории есть модуль контролируемого технического китайского. Он берет из ASD-STE100 идеи единого термина, одного действия на шаг и предупреждений перед действием. Рядом лежит `scripts/lint_copy_rules.py`: проверка без зависимостей с уровнями `error`, `warning` и `style`.
Для кого. Для технических писателей, разработчиков документации и продуктовых команд, которые выпускают китайскоязычные документы и интерфейс.
Подходит, если
- Надо переписать главную страницу документации или посадочную, где текст вышел рекламным и расплывчатым
- Нужно привести к одному виду описания параметров, кодов ошибок и журнала изменений в китайской документации
- В интерфейсе встречаются дословно переведенные статусы вроде Success или Bad Request, и нужны естественные формулировки
- Пошаговая инструкция по установке или разбору неисправности путает исполнителя и условия, и ее надо перестроить по принципам контролируемого языка
- Требуется автоматическая проверка китайского Markdown в CI: линтер ловит типовые ошибки, а сомнительные места помечает предупреждениями
Не подходит, если
- Текст не на китайском: правила, термины и пробелы рассчитаны на китайский с латиницей и цифрами
- Нужен творческий или рекламный текст: скилл убирает пафос и держится технического тона
- Нужна официальная сертификация по ASD-STE100: автор оговаривает: модуль только заимствует идеи стандарта, соответствия он не подтверждает ни результатом линтера, ни иначе
- Фраза взята из закона, договора или текста ошибки: такие фрагменты скилл оставляет без правки, а предложения выносит отдельным списком
Пример запроса к агенту
Перепиши по правилам tech-doc-style-chinese главную страницу китайской документации и список кодов ошибок, факты и ограничения не меняйОграничения
Скилл знает только китайский язык и китайские технические тексты. Он не заменяет редактора: правила приоритетов ставят факты, ограничения и безопасность выше стиля, и при нехватке данных он оставляет исходный смысл или помечает место как «待确认», то есть требующее уточнения.
Модуль контролируемого китайского заимствует подход ASD-STE100, но автор оговаривает: проект только заимствует подход стандарта, соответствия ему не обещает, и результат линтера соблюдения не доказывает. Правила STE для английского, например словарь, времена и длина предложений, к китайскому напрямую не применимы. Линтер делит находки на `error`, `warning` и `style`. Только первые считаются точными ошибками и по умолчанию дают ненулевой код выхода, остальные требуют решения человека. Для проектных терминов и тона предусмотрен отдельный файл переопределений, шаблон лежит в `references/project-overrides-example.md`; примеры оттуда не работают как правила проекта.
Как отключить. Удалите папку `tech-doc-style-chinese` из `~/.claude/skills/` или из `.claude/skills/` проекта, затем перезапустите агента. Для установки через `npx skills` в Codex тот же путь — каталог скиллов Codex.
Частые вопросы
Как поставить Chinese Tech Doc Style в Claude Code?
Командой `npx skills add https://github.com/Fenng/tech-doc-style-chinese -a claude-code`. Ключ `-g` кладет скилл в `~/.claude/skills/`, без него он попадет в `.claude/skills/` проекта. После установки перезапустите Claude Code, дальше скилл включается по описанию в SKILL.md.
Что скилл не трогает в тексте?
Литералы кода, ключи JSON, адреса URL, пути API, поля баз данных, команды и параметры конфигурации. Это записано в самом SKILL.md и в README. Правила пробелов и замен действуют только на видимый текст.
Какие кавычки и пробелы он ставит?
Для китайского текста — угловые кавычки 「」. Между китайскими иероглифами, латиницей и цифрами в видимом тексте выставляется пробел. Каждый абзац Markdown остается одной строкой без жесткого переноса, а для разворачивания уже сломанных абзацев есть скрипт `unwrap_md_paragraphs.py`.
Как проверить текст автоматически?
Запустите `scripts/lint_copy_rules.py`. Он не требует зависимостей, защищает блоки кода, строки в обратных апострофах, адреса и пути, а находки делит на `error`, `warning` и `style`. В репозитории есть сценарий `skill-lint.yml` для CI и тесты в папке `tests`.
Это китайская версия ASD-STE100?
Нет. Модуль контролируемого китайского заимствует идеи STE: единый термин для понятия, одно действие на шаг, предупреждения до действия. Стандарт он не воспроизводит и соответствия не обещает.
Обсуждение
Вопросов и отзывов пока нет.
Похожие
СкиллыСкилл для чистки текста от машинного тона, прежде всего на китайском: убирает штампы и воду, сохраняет факты и голос автора
Скилл переписывает плотный и двусмысленный английский по правилам упрощенного технического языка ASD-STE100, чтобы текст не мог прочитать неправильно другой аге
Скилл учит агента писать документацию и ответы простым английским по правилам ASD-STE100: короткие фразы, один термин, условие перед командой
Набор LaTeX-шаблонов для китайских научных документов вместе со скиллами Claude Code и Codex, которые их заполняют и выверяют
Скилл, который учит агента писать комментарии, документацию и сообщения об ошибках по правилам УТР из ГОСТ Р 58049-2017, плюс линтер
Simplified Technical English Skill
simplified-technical-english
Скилл заставляет модель писать на Simplified Technical English (ASD-STE100), контролируемом английском для технической документации. Неофициальный
Сравнение с похожими
Записи с тем же главным запросом: чем они отличаются.
| Запись | Официальный | Звезды репозитория | Главное отличие |
|---|---|---|---|
| Chinese Tech Doc Style (эта запись) | нет | 1 540 | |
| Human Writing | нет | 4 184 | пишет и правит китайские тексты в живом разговорном голосе, а этот держит сдержанный тон технической документации |
| The Elements of Agent Style | нет | 724 | общие правила письма на английском для ИИ-агентов, без китайской типографики и линтера этого скилла |
Коротко о README
Описание на китайском объясняет задачу: сделать технические тексты сдержанными, точными и читаемыми. Сначала перечислены сценарии применения и что не трогать, затем ключевые правила, подход STE и структура репозитория с папками `references`, `scripts` и `tests`. Дальше идут способы установки для Codex и Claude Code, настройка переопределений для проекта и работа линтера с примером для CI.
Бейдж для README
Исходный SKILL.md
--- name: tech-doc-style-chinese description: 在撰写、改写、校对或审阅中文技术文档、产品文案、界面文案、Markdown 文档、API 说明、操作手册、故障排查或运维文档时使用。采用克制、准确、可扫读的中文技术写作风格；保留原文事实、限制和机器可读内容；按任务读取术语排版、API 状态文案、项目覆盖或受控中文技术写作参考。 --- # 中文技术文档与产品文案规范 <!-- 作者：Fenng（GitHub：@Fenng） --> ## 适用范围 将本 Skill 用于中文技术内容的撰写、改写、校对和审阅，包括： - 文档首页、产品介绍、解决方案页和更新日志 - API 文档、参数说明、错误码和常见问题 - 操作手册、故障排查、运维 Runbook 和安全说明 - 界面文案、按钮、导航、状态和提示信息 不要改写代码字面量、JSON 键名、URL、API 路径、数据库字段名、命令、配置项或其他机器可读标识符。 ## 规则优先级 发生冲突时，按以下顺序处理： 1. 保留事实、逻辑、限制、安全信息和法律含义。 2. 服从用户明确要求和目标项目约定。 3. 保持技术术语和机器可读内容准确。 4. 改善结构、语义、语气和可扫读性。 5. 最后处理标点、留白、大小写等排版细节。 不得为了句子更短、语气更确定或格式更统一而牺牲更高优先级的信息。 ## 事实保真 - 不新增原文或可靠上下文没有提供的日期、数字、时限、SLA、能力、条件、因果关系或结论。 - 不删除前置条件、适用范围、例外、风险、安全警告、兼容性说明或失败处理。 - 不把可能、计划、建议、通常等不确定表达改成确定事实。 - 信息不足时保留原意，或明确标记「待确认」；不要自行补全。 - 改写引用、法规、合同、错误原文或用户提供的固定文案时，优先保持原文并将建议单独列出。