documentation-patterns

Solid

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.

AI & Automation 188 stars 15 forks Updated today MIT

Install

View on GitHub

Quality Score: 86/100

Stars 20%
76
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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`...

Details

Author
yonatangross
Repository
yonatangross/orchestkit
Created
5 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category