mcpField
D
documentation-patterns

documentation-patterns

github.com/yonatangrossDevelopment299144 installsUpdated today
Repository

About documentation-patterns

documentation-patterns is a skill for technical writers and developers who need consistent project documentation. It provides on-demand rules and structures for READMEs, ADRs, OpenAPI 3.1 API docs, changelogs, and writing style.

Key features

  1. 01README structure template
  2. 02Architecture decision record format
  3. 03OpenAPI 3.1 documentation patterns
  4. 04Keep a Changelog format
  5. 05Technical writing conventions

Use cases

  1. 01Starting a project README
  2. 02Recording architecture decisions
  3. 03Documenting REST APIs
  4. 04Maintaining release histories

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/yonatangross/orchestkit --skill documentation-patterns

After installing, type/documentation-patternsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

test-cases.json
rules/
_sections.md
_template.md
docs-api-openapi.md
docs-readme-structure.md
docs-changelog-format.md
docs-adr-template.md
docs-writing-style.md

Details

From the project README

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

CategoryRuleImpactWhen to Use
README1HIGHStarting a project, onboarding contributors
ADR1HIGHRecording architecture decisions
API Docs1HIGHDocumenting REST APIs with OpenAPI 3.1
Changelog1MEDIUMMaintaining release history
Writing Style1MEDIUMAny 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)

Comments

Markdown supported