К основному содержанию
скилл CX Codex

technical-writing · blockmatic-icebox — скилл для Claude Code: документация и установка

Скилл technical-writing для Claude Code помогает писать и проверять техническую документацию в репозиториях на Basilic. Включается при работе с Docu MDX, README и корневыми Markdown-файлами продукта.

MIT 108 установок ★ 1 обновлён 2026-10-02

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a claude-code
Открыть на GitHub

Что делает technical-writing

Скилл помогает создавать и редактировать документацию, сверяя факты с кодом, типами и тестами репозитория. Он работает с Docu MDX, README и корневыми файлами вроде PRODUCT.md, ARCHITECTURE.md и DESIGN.md, если AGENTS.md задаёт для них правила.

Перед правками нужно прочитать AGENTS.md; правила в .cursor/rules/ имеют приоритет. Для выбора слоя документации скилл направляет к /w-docs, а для проверки готовых изменений в Docu запускает pnpm --filter @repo/docu checktypes. Не придумывает флаги, конечные точки или значения по умолчанию, а неподтверждённые утверждения исключает.

Какие задачи решает

  • проверить утверждения в документации по исходникам и тестам
  • обновить README с учётом правил репозитория
  • отредактировать страницы Docu MDX без дублирования существующих тем
  • подготовить корневой Markdown-файл продукта по архитектурным источникам

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

  • Обнови README по правилам репозитория и проверь факты по исходникам.
  • Отредактируй страницу Docu MDX и проверь изменения командой pnpm --filter @repo/docu checktypes.
  • Проверь ARCHITECTURE.md по AGENTS.md и источникам архитектуры.

Как установить technical-writing

1Через Skills CLI (Vercel)

npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a claude-code

2Вручную: положить файлы

~/.claude/skills/technical-writing/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/technical-writing/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о technical-writing

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

Выполни npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a claude-code. Файл скилла находится по пути ~/.claude/skills/technical-writing/SKILL.md.

Что делает technical-writing?

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

Что нужно для работы technical-writing?

Нужен репозиторий на Basilic и его AGENTS.md с правилами документации. Для проверки изменений Docu MDX используется pnpm --filter @repo/docu checktypes.

Исходный текст

SKILL.md · MIT
---
name: technical-writing
description: Write, edit, and review technical docs in Basilic-based repos—Docu MDX, READMEs, and root product markdown—verifying every claim against source and keeping prose direct, accurate, and free of AI patterns.
---

# Technical writing

Write accurate, task-focused documentation for developers and coding agents. Each section should be easy to scan, retrieve, and act on without unstated context.

## Consuming repo

Read the repo's `AGENTS.md` before you write: doc layers, public one-liner, capability names, banned copy, and where `DESIGN.md` lives. Glob rules in `.cursor/rules/` override this skill. For which layer to update (MDX vs README vs rules), use `/w-docs`—do not duplicate its routing table here.

## Voice

- Address the reader as `you`; use imperative verbs for steps. Active voice, present tense, concrete nouns.
- American English, Oxford comma. Write `eve` lowercase when naming the runtime.
- Lead each page and section with the answer or outcome. One primary job per page.
- Preserve the author's supported meaning, nuance, and uncertainty. Make the minimum effective edit; leave strong prose alone.
- Use `we` only when describing a deliberate team action documented in the repo.

Ban filler and hype: `easy`, `simple`, `quick`, `just`, `obviously`, `utilize`, `facilitate`, `leverage`, `robust`, `seamless`, promotional adjectives, rhetorical questions, engagement bait.

Ban AI tells: summary transitions (`With this setup complete…`), stop-start fragments, datasheet verbs (`provides`, `is configurable`), cold opens with no antecedent, template closers and closing proverbs, manufactured specificity to sound human.

Cadence. Bad: "The API is flexible. It supports many use cases. That is the value. You will like it." Good: "Register the route in `apps/api`, expose it in OpenAPI, then run the client generator so the web app picks up typed calls."

## Sources of truth

Do not rely on training data for behavior. Verify in this order:

1. Owning source, public types, and tests in the repo
2. CLI help and package scripts named in the nearest README
3. Existing MDX or markdown in the doc layer `AGENTS.md` names
4. ADRs and architecture pages—proposed intent until merged behavior matches
5. Issues and user reports—to learn the reader's problem, not to establish product truth

If a claim cannot be verified, omit it or name the missing owner. Never leave `[VERIFY]` in finished copy. Do not document proposed behavior as shipped.

## Method

1. Name the piece's one job and the reader's task.
2. Find the page that already owns the topic; extend it before creating a new page.
3. Outline: outcome → prerequisites → happy path → alternatives → failures → related links.
4. Draft and verify claims together against source.
5. Self-edit for retrieval: repeat full nouns in key statements; put the critical fact locally, not only behind a link.
6. Review passes: purpose and structure, accuracy, completeness, style and retrieval, diff discipline (no drive-by rewrites).

## Modes

**Docu MDX** (when the repo has `apps/docu/content/docs/`): `title` and `description` frontmatter; folder `meta.json` when navigation changes; inbound body link from a related hub (no orphan pages); permanent redirects in doc app config when a route moves; MDX components only where nearby pages already use them. Finish with `pnpm --filter @repo/docu checktypes` when preparing to ship doc changes.

**README** (`**/README.md`): follow `.cursor/rules/base/readme.mdc`—root owns the product story; apps and packages stay lean with links to technical docs.

**Root product markdown** (e.g. `PRODUCT.md`, `ARCHITECTURE.md`, `DESIGN.md` when `AGENTS.md` says so): same voice; capability names match that repo's architecture source; upstream hosted docs win only where `AGENTS.md` says they override local project docs.

## Constraints

- NEVER invent flags, endpoints, defaults, examples, metrics, or user reactions.
- NEVER turn one support thread into a new page without deciding docs vs product scope.
- NEVER duplicate a broad guide when a section or cross-link fixes the gap.
- NEVER contradict the consuming repo's public one-liner, banned copy, or capability names for narrative convenience.
- Support evidence identifies confusion; implementation and tests establish behavior.

## Not this skill

- `/w-docs` — which layer to patch
- `/w-api-docs` — OpenAPI and generated clients
- `/w-deslop` — code slop on branches
- `/w-architecture` — ADR and boundary planning
- Personal or marketing voice catalogs (e.g. gabo)

© blockmatic-icebox · MIT · blockmatic-icebox/basilic-skills

Похожие скиллы

Все скиллы по теме «Тексты и документация» →

Сначала — technical-writing от других авторов.

technical-writing backnotprop Скилл technical-writing для Claude Code задаёт правила для документации, RFC, README и сообщений коммитов. Вызывается командой /technical-writing. CX Codex +1 10 700установок technical-writing riekelt Скилл technical-writing для Claude Code задаёт правила структуры, проверки фактов и стиля технических документов. Помогает писать README, спецификации, отчёты и планы. CX Codex +1 27 800установок technical-writing frappe Скилл technical-writing заставляет агента писать прозу в стиле Simplified Technical English: короткие предложения, активный залог, одно слово — одно значение. Для документации, README и коммитов. CX Codex +1 766установок technical-writing Mindrally Скилл technical-writing задаёт правила для написания подробных руководств и документации для разработчиков. Помогает создавать технические статьи без клише и воды. CX Codex +1 1 200установок technical-writing proffesor-for-testing Скилл technical-writing задаёт правила технического текста: вести с пользы, подтверждать примерами и числами, резать лишние слова. Включается при написании постов, документации и туториалов. CX Codex +1 209установок technical-blog-writing 101-skills Скилл technical-blog-writing для Claude Code задаёт каркас технических статей: типы постов, правила примеров кода и глубину объяснения. Описывает структуру туториалов и разборов архитектуры. CX Codex +1 237установок writing-simplified-technical-english PostHog Скилл writing-simplified-technical-english переписывает английский текст по стандарту ASD-STE100: одно значение на слово, активный залог, короткие предложения. Для отчётов, PR-описаний, промптов и сообщений об ошибках. CX Codex +1 138установок reviewing-technical-prose riekelt Скилл reviewing-technical-prose для вычитки чужих технических текстов: находит запрещённые конструкции, слабые утверждения и структурные дефекты, а перед сдачей документа прогоняет чек-лист. CX Codex +1 26 900установок technical-video-script Samuel Berthe Скилл technical-video-script для Claude Code пишет и редактирует сценарии технических видео и скринкастов. Также он помогает превратить статью, changelog или документацию в видеосценарий. CX Codex +1 14 000установок create-technical-spike официальный github Скилл create-technical-spike для GitHub Copilot оформляет исследование технического решения в ограниченный по времени спайк. Запускается, когда перед разработкой нужно разрешить критический вопрос. CX Codex +1 9 000установок technical-article-writer samber Скилл technical-article-writer помогает писать технические статьи, туториалы и разборы багов для разработчиков. Скилл проводит интервью по теме и предлагает десять вариантов заголовков. CX Codex +1 5 600установок

Из того же набора45

Весь набор →
w-push Скилл w-push для Claude Code проверяет изменения и отправляет нужную ветку в удалённый репозиторий. Запускается по запросу отправить текущую задачу. CX Codex +1 647установок w-commit Скилл w-commit для Claude Code проверяет изменения задачи и готовит коммит по правилам репозитория. Запускается по запросу на коммит. CX Codex +1 647установок w-retro Скилл w-retro для Claude Code разбирает завершённую задачу и предлагает улучшения для следующей похожей работы. Он включается после выполнения задачи. CX Codex +1 647установок w-build Скилл w-build для Claude Code, который по согласованной задаче вносит изменения небольшими частями и проверяет результат. Подключается к работе по готовому плану или достаточно ясному запросу на реализацию. CX Codex +1 647установок w-council Скилл w-council для Claude Code исследует кодовую базу с помощью параллельных агентов. Он собирает архитектурные сведения и передаёт найденные факты для дальнейшей работы. CX Codex +1 647установок w-plan Скилл w-plan для Claude Code составляет упорядоченный план работ по изменению проекта. Он проверяет контекст и зависимости задач, не трогая реализацию. CX Codex +1 647установок w-wayfinder Скилл w-wayfinder для Claude Code превращает расплывчатую задачу на несколько сессий в карту решений. Агент отмечает открытые вопросы и разбирает по одному билету за сессию. CX Codex +1 543установок w-grill Скилл w-grill для Claude Code, который проверяет план или решение через дерево проектных решений. Он задаёт вопросы по текущему «фронтиру» и ждёт подтверждения общего понимания. CX Codex +1 543установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой