technical-writing — скилл

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

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

Минимальный доступ

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

  • Скилл состоит из текстовых правил: ничего не запускает и не обращается к сети, меняется только стиль текстов, которые правит агент.
Все причины и проверки

luoling8192/technical-writing

Установка

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

npx skillfoxx add skills/technical-writing

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

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

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

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

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

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

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

Что делает

technical-writing правит внутренние технические тексты на китайском: проектные документы, рецензии, постмортемы и доклады. Агент получает тон технического отчета вместо рекламы и эссе: сначала наблюдение, затем обобщение, затем оценка, без поспешных выводов. Правила лежат в `SKILL.md`: порядок длинного текста (фон, разбор текущего состояния, гипотеза, ответы по разделам, возврат к гипотезе, влияние, наблюдаемость и оценки), угловые кавычки `「」` и отказ от тире и дефиса как разделителей фраз, блок-лист жаргона вроде `赋能`, `闭环` и `抓手` с заменой на конкретное действие, одиннадцать разборов «плохо и хорошо» и чек-лист редактуры. Фразы, которые лишь ведут читателя по тексту, скилл вычеркивает, а оценочные слова заменяет ограничениями и цифрами.

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

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

  • Пишется внутренний дизайн-документ или рецензия, и тон должен подходить коллегам и руководителю.
  • Черновик статьи перегружен стилем: выводы стоят впереди доказательств.
  • Переписка и итоги обсуждения превращаются в документ, который можно переслать.
  • Объясняются границы модулей, эволюция архитектуры, наблюдаемость или метод оценки.
  • Руководителю нужен TL;DR из трех частей: причина, гипотеза, решение.

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

  • Нужны тексты интерфейса, подписи кнопок или маркетинг: автор исключил эти жанры.
  • Пишется справка для внешних пользователей или механический справочник API.
  • Текст на русском или английском: правила построены на китайских оборотах, кавычках и блок-листе китайского жаргона.
  • Требуется художественный или публицистический стиль: скилл подавляет метафоры и яркие обороты.

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

Перепиши этот дизайн-документ по скиллу technical-writing: убери оценочные слова и поставь доказательства перед выводами.

Ограничения

Все правила и примеры в `SKILL.md` написаны для китайского: отказ от тире и дефиса как разделителей, кавычки `「」` и блок-лист жаргона не переносятся на русский или английский. Скилл меняет тон и структуру, но факты не проверяет: коды, метрики и ссылки на задачи автор текста подставляет сам. Файл большой, около 600 строк, с одиннадцатью разборами примеров. Для Codex в репозитории лежит `agents/openai.yaml`, скилл там нужно зарегистрировать по документации Codex. Отдельных скриптов и линтера нет: проверка идет по чек-листу в самом файле.

Как отключить. Удалите папку или симлинк `technical-writing` из `~/.claude/skills/` либо из каталога скиллов другого агента. Упоминание в `CLAUDE.md` или `AGENTS.md`, если вы его добавили, уберите вручную.

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

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

Выполните `npx skills add luoling8192/technical-writing`: установщик сам находит агента. Вручную: `git clone https://github.com/luoling8192/technical-writing.git ~/repos/technical-writing` и симлинк в `~/.claude/skills/technical-writing`.

Для каких текстов он подходит?

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

Какие агенты поддерживаются?

Claude Code, Cursor, Codex, GitHub Copilot, Windsurf, Gemini, Cline, AMP и другие. Для Codex в репозитории лежит `agents/openai.yaml`.

Что запрещает блок-лист?

Слова, которые изображают информацию без содержания: `生态`, `赋能`, `闭环`, `抓手`, `沉淀`, `落地`, а также оценочные `极致` и `丝滑`. Вместо них скилл просит назвать действие, объект или метрику.

Какова структура длинного текста?

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

Обсуждение

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

Скиллы

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

СкиллРасширенный доступ406Звезды репозитория

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

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

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

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

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

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

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

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

Пакет из 58 скиллов для юристов по праву КНР: консультации, суд, уголовная защита, договоры, комплаенс и проверка источников.

СкиллРасширенный доступ113Звезды репозитория

Сравнение с похожими

Карточки с тем же главным запросом: чем они отличаются.

ИнструментОфициальныйЗвезды репозиторияГлавное отличие
technical-writing (эта карточка)нет220
Chinese Tech Doc Styleнет1 574правит документацию, строки интерфейса и описания API с проверкой линтером; здесь внутренние проектные документы, рецензии и постмортемы
zh-tech-writingнет406чистит 14 примет ИИ-текста в китайской документации; здесь порядок аргументации, блок-лист жаргона и структура длинного документа

Коротко о README

Автор благодарит @nekomeowww за идеи и отзывы. Установка через skills.sh рассчитана на основные агенты, а ручной вариант кладет репозиторий симлинком в `~/.claude/skills/`. Лицензия MIT.

Бейдж для README

Исходный SKILL.md

---
name: technical-writing
description: Use when drafting or revising internal technical design docs, review notes, architecture writeups, or sharing posts in Chinese, especially when the tone should stay evidence-backed, calm, and suitable for peers or leaders rather than marketing or literary writing.
---

# Internal Technical Writing

## Overview

Use this skill when the writing target is an internal技术方案、评审稿、架构说明、分享文稿,重点在于把背景、猜想、证据、抽象、实现影响面讲清楚。

这类写作更接近技术汇报,不是宣传稿,也不该写成散文。语气要平稳,判断要有来路,段落要能顺着问题往下读。

## When to Use

- 在写内部技术方案、设计说明、评审文档、分享稿
- 在改一篇已经有内容、但文风过满、结论过快、证据不足的技术文章
- 在解释代码、模块边界、架构演进、可观测性、评测方法
- 在把聊天记录、讨论结论整理成可传播的技术文档

**When not to use**

- UI 文案、按钮文案、产品营销稿
- 面向外部用户的帮助文档
- 纯粹的 API reference 或机械说明书

## Core Stance

先接住读者,再往下解释。

常见写法是作者替读者抢先下判断,像 `很清楚`、`说明了`、`显然`、`真正`。这里更适合换成三步:

1. 我们观察到了什么
2. 基于这些观察,可以归纳出什么
3. 这些归纳暂时更适合落在哪类实现或组织方式里

如果要给出更强的判断,至少满足下面任一条件:

- 前文已经提出了对应的猜想,这一段是在 callback
- 同一段上下文里已经有交叉验证的 evidence
- 已经引用了具体模块、代码、issue、trace、指标或实验结果

这些 bad case 往往有同一种共性:

- 句子承担的是“主持文章”的功能,不是“推进论证”的功能

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

Foxx AItechnical-writing
Foxx AI

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