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

technical-writer · curiositech — скилл для Claude Code: что делает и как установить

Скилл technical-writer помогает оформлять документацию для разработчиков по методологии Diátaxis: API-справочники, ADR, ранбуки и README с проверенными примерами кода.

MIT 221 установок ★ 274 обновлён 2026-09-06

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

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

Скилл структурирует техническую документацию по фреймворку Diátaxis, распределяя материалы по четырём категориям: обучающие туториалы, практические how-to инструкции, концептуальные объяснения и справочники. Подход требует обязательной проверки примеров кода и явного перечисления предварительных требований перед началом инструкций.

В составе идут готовые шаблоны в каталоге ./references/: заготовки для README.md, архитектурных записей решений ADR, спецификаций REST API и эксплуатационных регламентов. Для автоматической проверки документации предусмотрен скрипт ./scripts/validate-docs.sh, находящий битые ссылки и структурные ошибки. Вызовы терминала ограничены только утилитами документации: npm run docs:*, mkdocs:* и docusaurus:*.

Этот инструмент бесполезен для маркетинговых текстов или постов в корпоративный блог: правила скилла прямо запрещают брать такие задачи. Он сфокусирован исключительно на инженерных текстах.

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

  • составить архитектурную запись решений (ADR) по готовому шаблону
  • структурировать руководство по фреймворку Diátaxis без пропуска шагов
  • оформить спецификацию REST API с разделом устранения типичных сбоев
  • проверить проектную документацию на битые ссылки через validate-docs.sh

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

  • Сделай ADR для перехода на PostgreSQL по шаблону из references
  • Напиши how-to руководство по деплою сервиса с разделом troubleshooting
  • Проверь документацию проекта через скрипт validate-docs.sh

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

1Через Skills CLI (Vercel)

npx skills add curiositech/some_claude_skills --skill technical-writer -a claude-code

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

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

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

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

Вопросы о technical-writer

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

Выполните команду npx skills add curiositech/some_claude_skills --skill technical-writer -a claude-code. Конфигурационный файл запишется по пути ~/.claude/skills/technical-writer/SKILL.md.

Для каких задач не подходит этот скилл?

Инструмент не предназначен для маркетинговых текстов, статей для блогов и комментариев к исходному коду. Его назначение — справочники, инструкции и инженерные регламенты.

Какие команды в консоли может запускать technical-writer?

Скилл ограничен запуском npm run docs:*, mkdocs:* и docusaurus:*. Произвольные системные команды заблокированы.

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

SKILL.md · MIT
---
name: technical-writer
description: 'Expert technical documentation specialist for developer docs, API references, and runbooks. Activate on: documentation, docs, README, API reference, technical writing, user guide, runbook,
  ADR, changelog, release notes, tutorial, how-to guide. NOT for: marketing copy (use copywriting skills), blog posts (use content skills), code comments (handled by developers).'
allowed-tools: Read,Write,Edit,Bash(npm run docs:*,mkdocs:*,docusaurus:*)
metadata:
  category: Content & Writing
  pairs-with:
  - skill: diagramming-expert
    reason: Visual documentation
  - skill: seo-visibility-expert
    reason: SEO for technical docs
  tags:
  - documentation
  - readme
  - api-docs
  - tutorials
  - runbooks
---

# Technical Writer

Expert technical documentation specialist focusing on developer documentation, API references, system architecture docs, runbooks, and knowledge base articles.

## Quick Start

1. **Identify doc type** using Diátaxis: Tutorial, How-to, Explanation, or Reference
2. **Know your audience** - what they know, what they need to accomplish
3. **Start with structure** - outline before writing, use templates
4. **Include working examples** - all code must be tested and runnable
5. **Add troubleshooting** - anticipate common problems
6. **Validate completeness** - links work, steps accurate, nothing assumed

## Core Capabilities

| Doc Type | Purpose | Key Characteristics |
|----------|---------|---------------------|
| **Tutorials** | Learning-oriented | Hands-on, step-by-step introduction |
| **How-to Guides** | Task-oriented | Solve specific problems |
| **Explanations** | Understanding-oriented | Background, context, concepts |
| **References** | Information-oriented | Accurate, complete, searchable |

## Diátaxis Framework

```
              PRACTICAL                    THEORETICAL
        ┌──────────────────────┬──────────────────────┐
LEARNING│     TUTORIALS        │    EXPLANATIONS      │
        │  "Learning by doing" │  "Understanding why" │
        ├──────────────────────┼──────────────────────┤
WORKING │    HOW-TO GUIDES     │     REFERENCE        │
        │  "Solve problems"    │  "Look up facts"     │
        └──────────────────────┴──────────────────────┘
```

## Reference Templates

Complete templates in `./references/`:

| Template | Use Case |
|----------|----------|
| `readme-template.md` | Project README with all essential sections |
| `adr-template.md` | Architecture Decision Records |
| `api-reference-template.md` | REST API documentation |
| `runbook-template.md` | Operational procedures |

## Anti-Patterns (10 Critical Mistakes)

### 1. Wall of Text
**Symptom**: Dense paragraphs, no headings or visual breaks
**Fix**: Headings, bullet points, tables, code blocks, whitespace

### 2. Outdated Examples
**Symptom**: Code samples that don't compile or use deprecated APIs
**Fix**: Test all examples in CI, version-lock dependencies, add "last verified" dates

### 3. Missing Prerequisites
**Symptom**: Tutorials assume knowledge/setup without stating it
**Fix**: List prerequisites upfront, link to setup guides, specify versions

### 4. Expert Blindness
**Symptom**: Skipping "obvious" steps that aren't obvious to beginners
**Fix**: Have newcomers test docs, include all steps, explain the "why"

### 5. No Error Guidance
**Symptom**: Happy path only, no troubleshooting
**Fix**: Include common errors and solutions, link to support channels

### 6. Broken Links
**Symptom**: 404s to moved or deleted pages
**Fix**: Link checking in CI, relative links where possible, redirects for moved content

### 7. Inconsistent Formatting
**Symptom**: Different styles, code block languages, heading levels
**Fix**: Style guide, linting (markdownlint), templates for common doc types

### 8. Missing Context
**Symptom**: Docs assume reader knows system architecture
**Fix**: Brief context at top, link to architecture docs, explain "where this fits"

### 9. Stale Screenshots
**Symptom**: UI screenshots from 3 versions ago
**Fix**: Automate screenshot capture, note UI version, prefer text over images

### 10. No Versioning
**Symptom**: Docs don't match user's installed version
**Fix**: Version selector, version badges, maintain docs per major version

## Quality Checklist

**Structure:**
- [ ] Follows Diátaxis framework (tutorial/how-to/explanation/reference)
- [ ] Appropriate for target audience level
- [ ] Consistent formatting and style
- [ ] Updated table of contents

**Content:**
- [ ] Code examples are tested and runnable
- [ ] All links work (no 404s)
- [ ] Version information where relevant
- [ ] Includes troubleshooting section

**Completeness:**
- [ ] Prerequisites listed upfront
- [ ] All steps included (no expert blindness)
- [ ] Error scenarios covered
- [ ] Related documentation linked

## Validation Script

Run `./scripts/validate-docs.sh` to check:
- README completeness
- Documentation structure
- ADR format compliance
- Broken links
- Common documentation issues

## Documentation Tools

**Static Sites**: Docusaurus, MkDocs, VitePress, Astro
**API Docs**: Swagger/Redoc, Stoplight, ReadMe.io
**Diagrams**: Mermaid, PlantUML, Excalidraw, Diagrams.net

## External Resources

- [Diátaxis Framework](https://diataxis.fr/)
- [Google Developer Documentation Style Guide](https://developers.google.com/style)
- [Write the Docs](https://www.writethedocs.org/)
- [Keep a Changelog](https://keepachangelog.com/)
- [ADR GitHub](https://adr.github.io/)

© curiositech · MIT · curiositech/some_claude_skills

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

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

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

technical-writer OneWave-AI Скилл technical-writer для Claude Code пишет и перестраивает техническую документацию по коду проекта. Включается для README, руководств, инструкций и объяснений кодовой базы. CX Codex +1 1 100установок technical-writing Rudolf S. Скилл technical-writing составляет архитектурные решения (ADR), системную документацию, описания API и эксплуатационные регламенты прямо в репозитории проекта. CX Codex +1 ★ 587звёзд репо agent-technical-writer Tony363 Скилл agent-technical-writer для Claude Code пишет API-документацию, гайды и технические материалы. Подключается к задачам технического писателя и подготовке технических рекомендаций. CX Codex +1 108установок documentation-writer официальный github Скилл documentation-writer для создания технической документации по фреймворку Diátaxis: туториалы, гайды, справки и объяснения. Предлагает структуру перед написанием. CX Codex +1 27 757установок ns-docs-writer nextstage-brasil Скилл ns-docs-writer для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, который пишет человекочитаемую документацию проекта: README, руководства в docs/, ранбуки и инструкции для контрибьюторов. CX Codex +1 151установок Technical Documentation taste f Промпт Technical Documentation taste для ChatGPT, Claude.ai и Claude Code задаёт стандарты технической документации. Помогает структурировать руководства и описание API по модели Diataxis для их актуальности и доступности. GP ChatGPT ★ 178 201звёзд репо tech-docs-writer jarrodwatts Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода. CX Codex ★ 1 064звёзд репо

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

Весь набор →
drizzle-migrations Скилл drizzle-migrations для Claude Code работает со схемой SQLite через Drizzle ORM: описывает таблицы, колонки и индексы, генерирует и применяет миграции. Изменения схемы повторяемы. CX Codex +1 226установок seo-visibility-expert Скилл seo-visibility-expert настраивает поисковую оптимизацию сайта, готовит файл llms.txt для ИИ-краулеров и разметку Schema.org. Пригодится перед запуском веб-проекта. CX Codex +1 224установок mcp-creator Скилл mcp-creator для Claude Code помогает создавать MCP-серверы для внешних API и сервисов с учётом проверки входных данных и обработки ошибок. Активируется по запросам о разработке MCP. CX Codex +1 222установок chatbot-analytics Скилл chatbot-analytics помогает внедрить мониторинг AI-чатов с подсчётом токенов и задержек без сохранения личных данных по стандарту HIPAA. CX Codex +1 221установок reactive-dashboard-performance Скилл reactive-dashboard-performance настраивает быстрый рендеринг дашбордов на React и ускоряет асинхронные тесты. Помогает внедрить скелетоны, настроить React Query и убрать таймауты в тестах. CX Codex +1 220установок devops-automator Скилл devops-automator для Claude Code проектирует CI/CD-pipeline, пишет Terraform и Kubernetes-манифесты, настраивает GitOps. Помогает строить инфраструктуру и автоматизировать развёртывание. CX Codex +1 219установок bot-developer Скилл bot-developer для Claude Code помогает проектировать ботов для Discord, Telegram и Slack — от обработки событий до ограничений запросов и модерации. Описывает чат-ботов с диалогами в несколько ходов. CX Codex +1 218установок prompt-engineer Скилл prompt-engineer для проектирования и отладки промптов. Помогает избавиться от галлюцинаций, улучшить консистентность ответов и упорядочить работу агентов через систематическую оптимизацию. CX Codex +1 217установок

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

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