documentation-patterns

documentation-patterns is a skill for Claude Code, Codex from yonatangross/orchestkit. It costs 53 tokens per session (795 once invoked), scanned A, original, MIT.

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.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/yonatangross/orchestkit/documentation-patterns
Any agent
npx skills add yonatangross/orchestkit --skill documentation-patterns
Clone the repo
git clone --depth 1 https://github.com/yonatangross/orchestkit

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-patterns

README.md
[![agentmods](https://agentmods.dev/badge/skills/yonatangross/orchestkit/documentation-patterns.svg)](https://agentmods.dev/skills/yonatangross/orchestkit/documentation-patterns)
Your own site
<a href="https://agentmods.dev/skills/yonatangross/orchestkit/documentation-patterns"><img src="https://agentmods.dev/badge/skills/yonatangross/orchestkit/documentation-patterns.svg" alt="Measured on agentmods" height="20"></a>
Per session 53 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 795 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin unknown No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00053 $0.00795
Opus 5 $0.00026 $0.00398
Sonnet 5 $0.00011 $0.00159
Haiku 4.5 $0.00005 $0.00080

Measured today against content hash 6b58b71e5604, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-patterns scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured today.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

plugins/ork/skills/documentation-patterns/SKILL.md · 97 lines

How it starts

The opening of the file, as written. The whole thing — 97 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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 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)

Read the full file on GitHub · 97 lines

Files

What ships with it

8 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. today First seen · 97 lines · 53 tokens per session scan A 6b58b71e5604

Subscribe to this mod's changes

documentation-patterns is a skill published in the GitHub repository yonatangross/orchestkit (225 stars, last pushed today), licensed MIT. It adds 53 tokens to every session and 795 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

documentation

Technical writing, API docs, and documentation best practices.

miles990/claude-software-skills · 12 tokens

technical-documentation

AI-powered technical documentation creation, maintenance, and auditing across README, ADR, API docs, runbooks, onboarding guides, changelogs, knowledge bases, and AI agent context files (AGENTS.md/CLAUDE.md). Primary keywords: technical documentation writing automation, ADR architecture decision record, API docs…

JPeetz/agent-skills · 115 tokens

scribe

Tactical documentation specialist ensuring all intelligence is properly logged and accessible. README, API docs, ADRs, changelogs, and runbooks.

Rikinshah787/clawarmy · 31 tokens

document-writer

Write or update technical documentation grounded in the real codebase. Use when the user asks for README, API docs, architecture guides, user guides, CONTRIBUTING docs, migration notes, or JSDoc/code comments, or wants technical docs rewritten into natural Chinese with correct terminology. Not for general prose…

bahayonghang/my-ai-cli-toolkit · 75 tokens

documentation-and-adrs

Writes technical documentation and Architecture Decision Records. Use when creating READMEs, API docs, ADRs, or any documentation that needs to explain a system, a decision, or how to use something.

vanja-emichi/a0_agent_skills · 45 tokens

doc-generator

Generate accurate, useful documentation for code — README files, API docs, inline docstrings, and changelogs. Use when user needs to document code, write a README, or generate API reference docs.

chandrudp29/skillhub · 44 tokens