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

documentation-patterns — скилл для Claude Code

Скилл documentation-patterns для Codex даёт шаблоны README, ADR, OpenAPI-документации и changelog. Помогает оформлять документацию проекта и записывать архитектурные решения.

MIT 150 установок ★ 305 обновлён 2026-11-14

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

Что делает documentation-patterns

Внутри пять наборов правил: для структуры README, записей ADR, API-документации по OpenAPI 3.1, changelog в формате Keep a Changelog и технического стиля. Правила лежат в отдельных файлах и загружаются по мере необходимости. Для API описаны схемы, пути и ответы об ошибках RFC 9457.

Скилл также задаёт формат ADR с контекстом, решением и последствиями, а для текстов рекомендует активный залог, настоящее время и короткие предложения. В Claude Code скилл помечен как недоступный для пользовательского вызова и отключён для вызова моделью, поэтому не рассчитывайте запускать его обычной командой или одним промптом.

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

  • составить README с разделами для установки и использования
  • зафиксировать архитектурное решение вместе с последствиями
  • описать REST API в OpenAPI 3.1
  • оформить историю релизов по Keep a Changelog
  • привести технический текст к единому стилю

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

  • Подготовь README проекта с разделами для установки, использования и конфигурации.
  • Запиши это архитектурное решение в формате ADR: добавь контекст и последствия.
  • Опиши REST API в OpenAPI 3.1 и включи ответы об ошибках.

Как установить documentation-patterns

1Через Skills CLI (Vercel)

npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-code

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

~/.claude/skills/documentation-patterns/SKILL.md

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

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

Вопросы о documentation-patterns

Как установить documentation-patterns в Claude Code?

Выполните npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-code. Файл скилла находится по пути ~/.claude/skills/documentation-patterns/SKILL.md.

Что делает documentation-patterns?

Помогает создавать README, ADR, документацию API по OpenAPI 3.1 и changelog, а также задаёт правила технического стиля.

Можно ли вызвать documentation-patterns командой в Claude Code?

Нет: скилл помечен как недоступный для пользовательского вызова, а вызов моделью отключён.

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

SKILL.md · MIT
---
name: documentation-patterns
license: MIT
compatibility: "Claude Code 2.1.277+."
description: Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.
user-invocable: false
context: inherit
effort: low
allowed-tools: "Read Glob Grep"
metadata:
  version: "1.0.0"
  author: "OrchestKit"
  complexity: "low"
  tags: "documentation, readme, adr, api-docs, openapi, changelog, writing-style, technical-writing, ci-cd"
---

# Documentation Patterns

Templates and opinionated structures for technical documentation -- READMEs, Architecture Decision Records, OpenAPI specs, changelogs, and writing style. Each category has individual rule files in `rules/` loaded on-demand.

## Quick Reference

| Category | Rule | Impact | When to Use |
|----------|------|--------|-------------|
| [README](#readme) | 1 | HIGH | Starting a project, onboarding contributors |
| [ADR](#architecture-decision-records) | 1 | HIGH | Recording architecture decisions |
| [API Docs](#api-documentation) | 1 | HIGH | Documenting REST APIs with OpenAPI 3.1 |
| [Changelog](#changelog) | 1 | MEDIUM | Maintaining release history |
| [Writing Style](#writing-style) | 1 | MEDIUM | Any technical writing task |

**Total: 5 rules across 5 categories**

## Quick Start

```markdown
## README Skeleton
# Project Name
Brief description -> Quick Start -> Installation -> Usage -> API -> Config -> Contributing -> License

## ADR Format
# ADR-001: Title
Status -> Context -> Decision -> Consequences (positive/negative) -> References

## OpenAPI Minimum
openapi: 3.1.0 with info, paths, components/schemas, error responses

## Changelog Entry
## [1.2.0] - 2026-03-05
### Added / Changed / Deprecated / Removed / Fixed / Security

## Writing Rule of Thumb
Active voice, present tense, second person, one idea per sentence
```

## README

Complete README template with all essential sections for open-source and internal projects.

- **`docs-readme-structure`** -- Project name, quick start, installation, usage, API reference, configuration, contributing, license

## Architecture Decision Records

Structured format for capturing architectural decisions with context and consequences.

- **`docs-adr-template`** -- Status, context, decision, consequences (positive/negative), references

## API Documentation

OpenAPI 3.1 specification patterns for consistent, machine-readable API docs.

- **`docs-api-openapi`** -- Path structure, operation definitions, schema components, error responses (RFC 9457)

## Changelog

Keep a Changelog format for curated, human-readable release history.

- **`docs-changelog-format`** -- Added, Changed, Deprecated, Removed, Fixed, Security sections with semver

## Writing Style

Technical writing conventions for clear, scannable documentation.

- **`docs-writing-style`** -- Active voice, present tense, concise sentences, API doc checklist

## Related Skills

- `ork:api-design` -- API design patterns (complements OpenAPI documentation)
- `ork:architecture-decision-record` -- ADR workflow and lifecycle
- `ork-extras:release-management` -- Release process including changelog updates

**Version:** 1.0.0 (March 2026)

© OrchestKit · MIT · yonatangross/orchestkit

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

Все скиллы по теме «Тексты и документация» →
code-documentation MoizIbnYousaf Скилл code-documentation задаёт структуру README, API-справки, комментариев и архитектурных заметок, чтобы агент писал документацию по одному шаблону. CX Codex +1 571установок make-documentation Callicrate Скилл make-documentation помогает писать README, архитектурные заметки, changelog, runbook и install-документацию. Он выбирает подходящий процесс и проверяет результат. CX Codex +1 1 500установок documentation официальный anthropics Скилл documentation для Claude Code готовит README, справочники API, ранбуки, архитектурные документы и гайды для новичков. Включается, когда код уже есть, а описания нет. CX Codex +1 10 800установок documentation-and-adrs addyosmani Скилл documentation-and-adrs для Claude Code фиксирует архитектурные решения и помогает находить устаревшую документацию. Подключается при изменении публичного API, выпуске функций и проверке соответствия документов коду. CX Codex +1 80 700установок technical-documentation wondelai Скилл technical-documentation для Claude Code, Codex, Cursor, GitHub Copilot и Gemini CLI, который проверяет, пишет и переписывает документацию по руководству Google Developer Documentation Style Guide. CX Codex +1 1 900установок markdown-documentation aj-geddes Скилл markdown-documentation для Claude Code задаёт агенту правила оформления Markdown: README, вики, страницы документации. Приводит тексты, которые пишет модель, к единому виду. CX Codex +1 1 300установок

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

Весь набор →
help Скилл help ищет установленный набор OrchestKit и показывает навыки по категориям. Запускается для выбора workflow или подходящего скилла. CX Codex +1 166установок business-case Скилл business-case считает ROI, NPV, IRR, срок окупаемости и TCO для инвестиционных решений. Запускается, когда агент собирает финансовое обоснование проекта или сравнивает build vs buy. CX Codex +1 162установок testing-e2e Скилл testing-e2e задаёт правила E2E-тестов на Playwright: выбор семантических локаторов, Page Objects и проверки axe-core. Включается при работе с тестами и playwright.config.*. CX Codex +1 160установок interaction-patterns Скилл interaction-patterns для Claude Code помогает выбирать паттерны взаимодействия в интерфейсе. Подключается при работе с загрузкой данных, пагинацией, оверлеями и уведомлениями. CX Codex +1 160установок okr-design Скилл okr-design для Claude Code помогает ставить цели и выбирать метрики успеха. Он подключается при работе с OKR, KPI и дизайном экспериментов. CX Codex +1 140установок figma-design-handoff Скилл figma-design-handoff для Claude Code помогает переносить макеты Figma в код и описывать компоненты. Включается при подготовке дизайн-токенов, разборе Dev Mode или сравнении интерфейса с макетом. CX Codex +1 136установок user-research Скилл user-research для структурированного исследования пользователей: персоны, карты пути, интервью, тестирование юзабилити и card sorting. Помогает понять, что нужно пользователям, и обоснованно проектировать продукт. CX Codex +1 134установок brainstorm Скилл brainstorm собирает варианты решения через параллельных агентов, фильтрует их по реализуемости и помогает сравнить компромиссы. Код он не строит и не чинит. CX Codex +1 133установок

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

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