documentation-patterns
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.
来源信息
- 仓库
- yonatangross/orchestkit
- 最近来源活动
- 2026年9月29日 15:03
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 285
- 分支
- 35
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
文件资源管理器
9 个文件正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- documentation-patterns
- license
- MIT
- compatibility
- Claude Code 2.1.277+.
- 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.
- user-invocable
- false
- disable-model-invocation
- true
- context
- inherit
- effort
- low
- allowed-tools
- Read Glob Grep
- metadata
- {"version":"1.0.0","author":"OrchestKit","complexity":"low","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](#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`** -- 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)
在 GitHub 查看