About

Imported from yonatangross/orchestkit (src/skills/documentation-patterns/SKILL.md). Install upstream with npx skills add yonatangross/orchestkit --skill documentation-patterns. Copyright stays with the author (MIT).

Documentation Patterns

Name: documentation-patterns
Author: yonatangross

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)

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:release-management -- Release process including changelog updates

Version: 1.0.0 (March 2026)

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/yonatangross-orchestkit-documentation-patterns/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

yonatangross-orchestkit-documentation-patterns.ocm.jsonjson

{
  "ocm": "1",
  "id": "yonatangross-orchestkit-documentation-patterns",
  "kind": "skill",
  "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.",
  "publisher": "yonatangross",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "documentation",
      "readme",
      "adr",
      "api-docs",
      "openapi",
      "changelog",
      "writing-style",
      "technical-writing",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "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."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/yonatangross/orchestkit",
      "path": "src/skills/documentation-patterns/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/yonatangross/orchestkit/blob/HEAD/src/skills/documentation-patterns/SKILL.md",
      "key": "yonatangross/orchestkit/src/skills/documentation-patterns/SKILL.md"
    },
    "compatibility": "Claude Code 2.1.251+.",
    "allowed_tools": [
      "Read",
      "Glob",
      "Grep"
    ],
    "license": "MIT"
  },
  "instructions": "# Documentation Patterns\n\nTemplates 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.\n\n## Quick Reference\n\n| Category | Rule | Impact | When to Use |\n|----------|------|--------|-------------|\n| [README](#readme) | 1 | HIGH | Starting a project, onboarding contributors |\n| [ADR](#architecture-decision-records) | 1 | HIGH | Recording architecture decisions |\n| [API Docs](#api-documentation) | 1 | HIGH | Documenting REST APIs with Ope",
  "cost": {
    "context_tokens": 672
  }
}

Fetch it by URL: GET /api/v1/registry/yonatangross-orchestkit-documentation-patterns/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.