Documentation
aiskillstore/marketplace
Comprehensive documentation specialist covering API documentation, technical writing, design documentation, migration guides, and changelog generation.
Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides.
Install Documentation Patterns
$ npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install yonatangross/orchestkit documentation-patterns --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/yonatangross/orchestkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/src/skills/documentation-patterns .claude/skills/documentation-patterns && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "documentation-patterns" agent skill from https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patterns into .claude/skills/documentation-patterns/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-patterns", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patternsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add yonatangross/orchestkit --skill documentation-patterns -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install yonatangross/orchestkit documentation-patterns --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/yonatangross/orchestkit.git skills-src && mkdir -p .agents/skills && cp -r skills-src/src/skills/documentation-patterns .agents/skills/documentation-patterns && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-patterns" agent skill from https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patterns into .agents/skills/documentation-patterns/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-patterns", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add yonatangross/orchestkit --skill documentation-patterns -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install yonatangross/orchestkit documentation-patterns --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/yonatangross/orchestkit.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/src/skills/documentation-patterns .cursor/skills/documentation-patterns && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "documentation-patterns" agent skill from https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patterns into .cursor/skills/documentation-patterns/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-patterns", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/yonatangross/orchestkit.git --path src/skills/documentation-patterns--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add yonatangross/orchestkit --skill documentation-patterns -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install yonatangross/orchestkit documentation-patterns --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/yonatangross/orchestkit.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/src/skills/documentation-patterns .gemini/skills/documentation-patterns && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "documentation-patterns" agent skill from https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patterns into .gemini/skills/documentation-patterns/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-patterns", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install yonatangross/orchestkit documentation-patternsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add yonatangross/orchestkit --skill documentation-patterns -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/yonatangross/orchestkit.git skills-src && mkdir -p .github/skills && cp -r skills-src/src/skills/documentation-patterns .github/skills/documentation-patterns && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "documentation-patterns" agent skill from https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patterns into .github/skills/documentation-patterns/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-patterns", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add yonatangross/orchestkit --skill documentation-patterns -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install yonatangross/orchestkit documentation-patterns --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/yonatangross/orchestkit.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/src/skills/documentation-patterns .opencode/skills/documentation-patterns && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "documentation-patterns" agent skill from https://github.com/yonatangross/orchestkit/tree/main/src/skills/documentation-patterns into .opencode/skills/documentation-patterns/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-patterns", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
documentation-patterns- GitHub stars
- 288
- Token cost
- ~830 tokens
- SKILL.md length
- 213 words
- Files
- 9
- Skills in repo
- 107
- Repo updated
- First seen
- Licence
- MIT
At a glance
Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides.
- Creating project documentation
- SKILL.md covers Quick Reference, Quick Start, README and Architecture Decision Records, plus 4 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Writing architecture decisions
What it does
Documentation Patterns is an agent skill from yonatangross/orchestkit. 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.
Its SKILL.md is about 830 tokens, which your agent loads only when the skill is triggered. The skill folder holds 9 other files (for example `rules/_sections.md`, `rules/_template.md` and `rules/docs-adr-template.md`). Compatibility notes: Claude Code 2.1.277+.
It sits in Development, covering Technical documentation, Architecture decision records and Changelog and release notes. It works with OpenAPI. The repository describes itself as: The Complete AI Development Toolkit for Claude Code. 106 skills, 36 agents, 171 hooks. Install ork for stable (v9.x), or ork-alpha for the v10 line, which ships daily. The licence is MIT.
When your agent uses it
- Creating project documentation
- Writing architecture decisions
- Documenting APIs
- Maintaining changelogs
Example prompts
- “/documentation-patterns”
Requirements
- Compatibility (from SKILL.md): Claude Code 2.1.277+.
- Pre-approved tools (allowed-tools): Read, Glob, Grep
What it can do on your machine
Read from SKILL.md and the folder at commit 1f8d8f3. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
ReadGlobGrep
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Compatibility
Claude Code 2.1.277+.
From compatibility in the SKILL.md frontmatter.
Context cost
Documentation Patterns loads about 830 tokens when it runs. Until then it costs about 64 tokens; SKILL.md has 213 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from yonatangross/orchestkit at commit 1f8d8f3, republished under its MIT licence (© yonatangross). 213 words, ~830 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-patterns/SKILL.md (or your agent's skills folder). This skill also uses 8 other files; get the full folder from GitHub.- name
- documentation-patterns
- 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.
- allowed-tools
- Read, Glob, Grep
- compatibility
- Claude Code 2.1.277+.
- license
- MIT
- user-invocable
- false
- disable-model-invocation
- true
- context
- inherit
- effort
- low
- metadata.version
- 1.0.0
- metadata.author
- OrchestKit
- metadata.complexity
- low
- metadata.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 | 1 | HIGH | Starting a project, onboarding contributors |
| ADR | 1 | HIGH | Recording architecture decisions |
| API Docs | 1 | HIGH | Documenting REST APIs with OpenAPI 3.1 |
| Changelog | 1 | MEDIUM | Maintaining release history |
| Writing Style | 1 | MEDIUM | Any technical writing task |
Total: 5 rules across 5 categories
Quick Start
## 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 sentenceREADME
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 lifecycleork:release-management-- Release process including changelog updates
Version: 1.0.0 (March 2026)
© yonatangross, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 8 other files in src/skills/documentation-patterns of yonatangross/orchestkit.
- SKILL.md
- rules/_sections.md
- rules/_template.md
- rules/docs-adr-template.md
- rules/docs-api-openapi.md
- rules/docs-changelog-format.md
- rules/docs-readme-structure.md
- rules/docs-writing-style.md
- test-cases.json
Open the folder on GitHubat commit 1f8d8f3
Compare with similar skills
Documentation Patterns next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Documentation Patterns this skillyonatangross/orchestkit | 288 | — | ~830 | Automated safety check: Pass | MIT | |
| Documentationaiskillstore/marketplace | 430 | 1 repos | ~2.7k | Automated safety check: Pass | None | |
| Generating Documentationancoleman/ai-design-components | 526 | — | ~3k | Automated safety check: Pass | MIT | |
| DocumentationEliasOulkadi/shokunin | 114 | — | ~2k | Automated safety check: Pass | MIT | |
| Technical Documentationkid-sid/claude-spellbook | 189 | — | ~3.4k | Automated safety check: Notes | MIT | |
| Docs Interfacesjh941213/my-cc-harness | 126 | — | ~863 | Automated safety check: Notes | None |
Similar skills
Generating Documentation
ancoleman/ai-design-components
Generate comprehensive technical documentation including API docs (OpenAPI/Swagger), code documentation (TypeDoc/Sphinx), documentation sites (Docusaurus/MkDocs), Architecture Decision Records…
Documentation
EliasOulkadi/shokunin
Generate READMEs, API docs, changelogs, and knowledge base articles.
Technical Documentation
kid-sid/claude-spellbook
A skill your agent uses when writing a README, documenting an API with OpenAPI, drafting a runbook for on-call engineers, authoring a technical spec or ADR, or setting up docs-as-code with…
Docs Interfaces
jh941213/my-cc-harness
Generate interface/API docs — OpenAPI 3.1/AsyncAPI 3.0 specs, API topology diagrams, interface flow (sequence) diagrams, API changelog.
Nacos API Doc Update
nacos-group/nacos-group.github.io
Updates Nacos API documentation from Swagger api.json. An agent skill from nacos-group/nacos-group.github.io.
More from yonatangross/orchestkit
All 107 skills in this repoAPI Design
yonatangross/orchestkit
API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows, RFC 9457 Problem Details error handling, and OpenAPI specs.
Architecture Decision Record
yonatangross/orchestkit
ADR templates in the Nygard format with context, decision, consequences, and alternatives.
Audit Full
yonatangross/orchestkit
Single-pass codebase analysis leveraging a 1M-token context window for comprehensive security scanning, architecture review, and dependency auditing.
Code Review Playbook
yonatangross/orchestkit
Structured review processes, conventional comments, language-specific checklists, and feedback templates.
Create PR
yonatangross/orchestkit
Creates GitHub pull requests with pre-flight validation, conventional title formatting, and structured summary generation.
Explore
yonatangross/orchestkit
Multi-angle codebase exploration spawning 3-5 parallel agents for code structure, data flow, architecture patterns, and health assessment.
Related
Works with
Categories
Questions about Documentation Patterns
What does Documentation Patterns do?
Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Documentation Patterns is an agent skill from yonatangross/orchestkit.1), changelogs, and writing style guides.
When should I use Documentation Patterns?
Documentation Patterns fits situations like: creating project documentation; writing architecture decisions; documenting APIs; maintaining changelogs.
How do I install Documentation Patterns in Claude Code?
Run `npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-code`. Or copy the skill folder (src/skills/documentation-patterns in yonatangross/orchestkit) into .claude/skills/documentation-patterns in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Patterns in Codex?
Run `npx skills add yonatangross/orchestkit --skill documentation-patterns -a codex`. Or copy the skill folder (src/skills/documentation-patterns in yonatangross/orchestkit) into .agents/skills/documentation-patterns in your project. Codex loads it when a task matches its description.
Can I use Documentation Patterns in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add yonatangross/orchestkit --skill documentation-patterns -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-patterns, .gemini/skills/documentation-patterns, .github/skills/documentation-patterns and .opencode/skills/documentation-patterns in your project.
What does Documentation Patterns need to run?
SKILL.md names no scripts, command-line tools or credentials: Documentation Patterns is instructions for the agent only. Its frontmatter pre-approves these tools: Read, Glob, Grep. Compatibility (from SKILL.md): Claude Code 2.1.277+..
Does Documentation Patterns access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Documentation Patterns safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Documentation Patterns use?
Documentation Patterns is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Documentation Patterns use?
About 830 tokens (SKILL.md is roughly 3.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Documentation Patterns?
Skills that share tags, products or a category with Documentation Patterns: Documentation (aiskillstore/marketplace, 430 stars), Generating Documentation (ancoleman/ai-design-components, 526 stars), Documentation (EliasOulkadi/shokunin, 114 stars) and Technical Documentation (kid-sid/claude-spellbook, 189 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation Patterns?
yonatangross (a GitHub user) maintains it in yonatangross/orchestkit, which has 288 GitHub stars. The repository holds 107 skills in this directory. The repository was last updated on October 6, 2026.
Source: yonatangross/orchestkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.