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

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

Скилл technical-docs для Claude Code помогает писать и обновлять техническую документацию, строить диаграммы Mermaid и сверять документацию с кодом. Помогает вести doc-as-code и проверять покрытие.

MIT 177 установок ★ 29 обновлён 2026-08-17

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

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

Скилл задаёт рабочий процесс для документации рядом с кодом: изменения хранятся в системе контроля версий, проходят линтинг и CI-проверки. Он помогает описывать функции, готовить руководства и проверять, не отстала ли документация от экспорта и изменений в коде. Для рекламных текстов и блогов этот подход не предназначен.

Для диаграмм используются Mermaid: последовательности вызовов, ERD по схемам Drizzle или Prisma, git-графы и блок-схемы. В рекомендациях есть шаблоны ADR и runbook, правила Markdown и процесс черновика с последующей проверкой человеком. Сложные диаграммы предлагается делить на подграфы, ограничивая их 15–20 узлами.

API-справочник скилл советует генерировать по аннотациям JSDoc или TSDoc, а не писать вручную. Проверка покрытия опирается на сравнение изменений в git diff main...HEAD со сканированием экспортов, поэтому этот способ аудита рассчитан на проект с Git и веткой main.

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

  • сверить экспорты кода с покрытием документацией
  • построить диаграмму последовательности вызовов в Mermaid
  • сгенерировать ERD по схеме Drizzle или Prisma
  • подготовить ADR с контекстом и последствиями решения
  • составить runbook по симптомам и устранению сбоя

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

  • Проверь изменения в main...HEAD и найди экспорты без документации.
  • Построй Mermaid-диаграмму последовательности для вызовов между сервисами.
  • Подготовь ADR для этого решения: опиши контекст, статус и последствия.

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

1Через Skills CLI (Vercel)

npx skills add oakoss/agent-skills --skill technical-docs -a claude-code

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

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

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

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

Вопросы о technical-docs

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

Выполните npx skills add oakoss/agent-skills --skill technical-docs -a claude-code. Файл скилла находится по пути ~/.claude/skills/technical-docs/SKILL.md.

Что делает скилл technical-docs?

Помогает вести техническую документацию как код, создавать Mermaid-диаграммы и проверять соответствие документации изменениям в коде. Также содержит рекомендации по Markdown, ADR и runbook.

Как скилл предлагает строить ERD?

Диаграмму ERD можно выводить из схем Drizzle или Prisma и описывать синтаксисом Mermaid erDiagram с обозначениями Crow’s Foot.

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

SKILL.md · MIT
---
name: technical-docs
description: 'Technical documentation writing and diagram generation. Use when creating docs, syncing documentation with code changes, building Mermaid diagrams, running doc coverage audits, or establishing writing style guides. Use for doc-as-code workflows, ERD generation, sequence diagrams, documentation gap analysis, and AI-assisted drafting.'
license: MIT
metadata:
  author: oakoss
  version: '1.2'
---

# Documentation

Technical writing, diagram-as-code, and documentation lifecycle management. Treats docs as code: version-controlled, linted, and CI-verified.

**When to use**: Creating or updating technical documentation, generating Mermaid diagrams (flowcharts, ERDs, sequence diagrams), auditing documentation coverage against code, or establishing style guides.

**When NOT to use**: Writing marketing copy, blog posts, or content that does not live alongside code.

## Quick Reference

| Task                 | Approach                                        | Key Point                                    |
| -------------------- | ----------------------------------------------- | -------------------------------------------- |
| Doc sync audit       | `git diff main...HEAD` + export scan            | Compare symbols against doc coverage         |
| Sequence diagram     | Mermaid `sequenceDiagram` + `autonumber`        | Map messages to function calls               |
| ERD                  | Mermaid `erDiagram` + Crow's Foot               | Derive from Drizzle/Prisma schemas           |
| Gitgraph             | Mermaid `gitGraph`                              | Standardize on main/develop/feature branches |
| Feature release doc  | Overview + Config + Examples + Troubleshooting  | Checklist for every new feature              |
| API reference        | Generate from JSDoc/TSDoc annotations           | Never write API refs manually                |
| Style guide          | Active voice + present tense + direct address   | Conversational but precise                   |
| AI-assisted drafting | Inventory + gap analysis + draft + human review | AI drafts, humans verify accuracy            |
| Markdown standard    | YAML frontmatter + language-tagged code blocks  | Always specify code block language           |
| Complex diagrams     | Split into focused sub-diagrams + subgraphs     | Limit to 15-20 nodes per diagram             |
| README template      | Badges + description + quick start + API link   | First thing users see; keep under 200 lines  |
| ADR format           | Status, context, decision, consequences         | Numbered, immutable once accepted            |
| Runbook              | Symptoms, diagnosis, resolution, escalation     | Written for 3 AM incidents; no ambiguity     |

## Common Mistakes

| Mistake                                     | Correct Pattern                                                   |
| ------------------------------------------- | ----------------------------------------------------------------- |
| Using static images for technical diagrams  | Write Mermaid syntax inline in Markdown                           |
| Generic participant names like `Agent1`     | Use specific service or role names matching the architecture      |
| Manually writing API reference docs         | Generate from JSDoc/TSDoc annotations in source code              |
| Diagrams with 20+ nodes and no grouping     | Use subgraphs to group related nodes; limit to 15-20              |
| Documentation referencing outdated defaults | Run doc sync audit comparing exports against coverage             |
| Using "Click here" link text                | Use descriptive anchor text for accessibility and clarity         |
| Skipping heading hierarchy levels           | Never go from H2 to H4; keep hierarchy sequential                 |
| Mixing wall-of-text paragraphs              | Use bullet points, tables, and diagrams for scannability          |
| No ADRs for architectural decisions         | Record decisions with context, status lifecycle, and consequences |

## Delegation

- **Scan codebase for undocumented exports and documentation gaps**: Use `Explore` agent
- **Generate a full documentation site with diagrams from an existing codebase**: Use `Task` agent
- **Plan documentation architecture and information hierarchy for a new project**: Use `Plan` agent

> If the `mermaid-diagrams` skill is available, delegate complex diagram creation and advanced Mermaid syntax questions to it.
> Otherwise, recommend: `npx skills add oakoss/agent-skills --skill mermaid-diagrams`
> If the `tldr-expert` skill is available, delegate summary and brief generation to it.

## References

- [Writing Style](references/writing-style.md) -- Voice, tone, formatting rules, error message guidelines, and structural standards
- [Mermaid Diagrams](references/mermaid-diagrams.md) -- Sequence, ERD, gitgraph, flowchart patterns with anti-patterns and troubleshooting
- [Doc Coverage](references/doc-coverage.md) -- Feature inventory, gap analysis, code-first and doc-first audit workflows
- [AI Collaboration](references/ai-collaboration.md) -- AI-human doc workflow, hallucination handling, documentation-as-code practices
- [Markdown Standards](references/markdown-standards.md) -- Frontmatter, headings, code blocks, tables, callouts, and link conventions
- [Runbooks and Onboarding](references/runbooks-and-onboarding.md) -- Incident runbook templates, escalation paths, and developer onboarding guides

© oakoss · MIT · oakoss/agent-skills

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

Все скиллы по теме «Тексты и документация» →
technical-writer curiositech Скилл technical-writer помогает оформлять документацию для разработчиков по методологии Diátaxis: API-справочники, ADR, ранбуки и README с проверенными примерами кода. CX Codex +1 221установок agent-technical-writer Tony363 Скилл agent-technical-writer для Claude Code пишет API-документацию, гайды и технические материалы. Подключается к задачам технического писателя и подготовке технических рекомендаций. CX Codex +1 108установок technical-writing Rudolf S. Скилл technical-writing составляет архитектурные решения (ADR), системную документацию, описания API и эксплуатационные регламенты прямо в репозитории проекта. CX Codex +1 ★ 587звёзд репо project-docs jezweb Скилл project-docs сканирует репозиторий и создаёт актуальные файлы ARCHITECTURE.md, API_ENDPOINTS.md и DATABASE_SCHEMA.md. Он полезен при онбординге новичков или после масштабного рефакторинга. CX Codex +1 1 300установок tech-docs-writer jarrodwatts Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода. CX Codex ★ 1 064звёзд репо figure-docs u-ichi Плагин figure-docs для Claude Code создаёт документы, где основную мысль передают диаграммы. Он подключает скилл к просьбам подготовить отчёт, бизнес-материал или объяснение разработки. ★ 65звёзд репо

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

Весь набор →
icon-design Скилл icon-design помогает выбрать подходящие по смыслу иконки из Lucide, Heroicons или Phosphor и настроить чистый импорт без поломки tree-shaking. CX Codex +1 187установок pdf-tools Скилл pdf-tools для Claude Code, Codex, Cursor, GitHub Copilot и Gemini CLI, который покрывает весь цикл работы с PDF: извлечение текста и таблиц, генерацию, изменение и заполнение форм. CX Codex +1 186установок ssh-remote Скилл ssh-remote помогает ассистенту настраивать SSH-подключения, генерировать ключи Ed25519, пробрасывать порты и безопасно передавать файлы. CX Codex +1 183установок tanstack-hotkeys Скилл для агента: подсказывает, как собрать горячие клавиши в React на TanStack Hotkeys — от одиночных комбинаций до записи пользовательских шорткатов. CX Codex +1 179установок mermaid-diagrams Скилл mermaid-diagrams помогает создавать Mermaid-диаграммы в Markdown: от блок-схем и ERD до графиков, mindmap и архитектурных схем. CX Codex +1 177установок motion Скилл обучает ИИ-агента правильно применять библиотеку Motion (framer-motion) в React и Next.js. Помогает настроить жесты, скролл-эффекты и избежать просадок FPS. CX Codex +1 176установок shadcn-ui Учит агента работать с shadcn/ui: добавлять компоненты через CLI, настраивать темы на oklch и собирать формы с проверкой через Zod. CX Codex +1 176установок local-first Скилл local-first помогает решить, нужна ли веб-приложению локальная база с синхронизацией, и выбрать движок и стратегию разрешения конфликтов. CX Codex +1 173установок

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

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