technical-writing · blockmatic-icebox — скилл для Claude Code: документация и установка
Скилл technical-writing для Claude Code помогает писать и проверять техническую документацию в репозиториях на Basilic. Включается при работе с Docu MDX, README и корневыми Markdown-файлами продукта.
MIT 108 установок ★ 1 обновлён 2026-10-02
npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a claude-codeЧто делает 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-code2Вручную: положить файлы
~/.claude/skills/technical-writing/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/technical-writing/
1Через Skills CLI (Vercel)
npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a codex2Вручную: положить файлы
.agents/skills/technical-writing/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a cursor2Вручную: положить файлы
.cursor/skills/technical-writing/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install blockmatic-icebox/basilic-skills skills/technical-writing2Вручную: положить файлы
.github/skills/technical-writing/SKILL.md1Через Skills CLI (Vercel)
npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a gemini-cli2Командой платформы
gemini skills install https://github.com/blockmatic-icebox/basilic-skills --path skills/technical-writingВручную: положить файлы
.devin/skills/technical-writing/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add blockmatic-icebox/basilic-skills --skill technical-writing -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в 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 от других авторов.