Skip to main content
skill CX Codex

documentation-patterns — Claude Code skill for project docs

The documentation-patterns skill provides patterns for READMEs, ADRs, OpenAPI docs, changelogs, and technical writing. Use it when drafting project docs or recording an architecture choice.

MIT 150 installs ★ 305 updated 2026-11-14

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-code
Open on GitHub

What documentation-patterns does

The skill contains five sets of rules: README structure, ADR format, API documentation with OpenAPI 3.1, Keep a Changelog entries, and technical writing style. Each category has its own rule file, loaded when needed. The API guidance covers paths, schemas, and RFC 9457 error responses.

ADR guidance organizes context, decisions, and consequences. Writing rules favor active voice, present tense, and concise sentences. In Claude Code, the skill is marked unavailable for direct user invocation, and model invocation is disabled, so a prompt alone will not activate it.

What it helps with

  • draft a README with installation and usage sections
  • record an architecture decision and its consequences
  • document a REST API in OpenAPI 3.1
  • organize release history using Keep a Changelog
  • apply consistent style to technical documentation

Example prompts for the agent

  • Draft a README with sections for installation, usage, and configuration.
  • Record this architecture choice as an ADR, including its context and consequences.
  • Document the REST API in OpenAPI 3.1 and include error responses.

How to install documentation-patterns

1Skills CLI (Vercel)

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

2Manually: put the files in place

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

Copy the whole skill folder; for one project use .claude/skills/documentation-patterns/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about documentation-patterns

How do I install documentation-patterns in Claude Code?

Run npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-code. The skill file is located at ~/.claude/skills/documentation-patterns/SKILL.md.

What does documentation-patterns do?

It provides structures for READMEs and ADRs, guidance for OpenAPI 3.1 API docs and changelogs, and conventions for technical writing.

Can I invoke documentation-patterns directly in Claude Code?

No. Direct user invocation is disabled, and the skill is also marked as unavailable for model invocation.

Source text

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

Similar skills

All skills for Writing and docs →

From the same set86

The whole set →
help This skill scans the installed OrchestKit skills and sorts them into categories. It helps you find the workflow or skill that matches a task. CX Codex +1 166installs business-case business-case is a Claude Code skill that calculates ROI, NPV, IRR, payback period and TCO. It runs when an agent builds a financial case or compares build vs buy. CX Codex +1 162installs testing-e2e testing-e2e provides Playwright E2E standards, page object patterns, and axe-core accessibility checks. Activates when editing tests or playwright.config.*. CX Codex +1 160installs interaction-patterns interaction-patterns — a skill for Claude Code supplies UI interaction rules for loading, pagination, overlays and notifications. It comes into play while building these interface behaviors. CX Codex +1 160installs okr-design okr-design is a Claude Code skill for setting goals and defining success metrics. It helps structure OKRs, KPI trees, and experiment measures. CX Codex +1 140installs figma-design-handoff The figma-design-handoff Claude Code skill guides Figma-to-code handoff, from design tokens to component details. It comes into play when translating layouts, inspecting Dev Mode, or checking a built UI against a Figma frame. CX Codex +1 136installs user-research Skill for structured user research: personas, journey maps, interviews, usability testing, and card sorting. Learn what users actually need and build products grounded in evidence. CX Codex +1 134installs brainstorm The brainstorm skill explores a design question with parallel agents, filters ideas for feasibility, and compares trade-offs. It does not build or fix code. CX Codex +1 133installs

Project sponsors

Companies that keep this analytics open