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
npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-codeWhat 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-code2Manually: put the files in place
~/.claude/skills/documentation-patterns/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/documentation-patterns/
1Skills CLI (Vercel)
npx skills add yonatangross/orchestkit --skill documentation-patterns -a codex2Manually: put the files in place
.agents/skills/documentation-patterns/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add yonatangross/orchestkit --skill documentation-patterns -a cursor2Manually: put the files in place
.cursor/skills/documentation-patterns/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install yonatangross/orchestkit src/skills/documentation-patterns2Manually: put the files in place
.github/skills/documentation-patterns/SKILL.md1Skills CLI (Vercel)
npx skills add yonatangross/orchestkit --skill documentation-patterns -a gemini-cli2Platform CLI
gemini skills install https://github.com/yonatangross/orchestkit --path src/skills/documentation-patternsManually: put the files in place
.devin/skills/documentation-patterns/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add yonatangross/orchestkit --skill documentation-patterns -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
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