From ork
Provides templates and patterns for READMEs, ADRs, OpenAPI 3.1 API docs, changelogs, and technical writing styles. Use for project documentation, architecture decisions, API specs, and release notes.
npx claudepluginhub yonatangross/orchestkit --plugin orkThis skill is limited to using the following tools:
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.
Provides Markdown templates and guidelines for READMEs, API docs, JSDoc/TSDoc comments, changelogs, ADRs, and AI-friendly formats like llms.txt. Use for structuring project documentation.
Guides project documentation structure, file organization, content requirements by project phase, and best practices for README.md, ARCHITECTURE.md, API docs, and more.
Provides templates and best practices for writing README files, API documentation, user guides, changelogs, architecture docs, and inline code comments.
Share bugs, ideas, or general feedback.
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.
| 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
## 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
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, licenseStructured format for capturing architectural decisions with context and consequences.
docs-adr-template -- Status, context, decision, consequences (positive/negative), referencesOpenAPI 3.1 specification patterns for consistent, machine-readable API docs.
docs-api-openapi -- Path structure, operation definitions, schema components, error responses (RFC 9457)Keep a Changelog format for curated, human-readable release history.
docs-changelog-format -- Added, Changed, Deprecated, Removed, Fixed, Security sections with semverTechnical writing conventions for clear, scannable documentation.
docs-writing-style -- Active voice, present tense, concise sentences, API doc checklistork:api-design -- API design patterns (complements OpenAPI documentation)ork:architecture-decision-record -- ADR workflow and lifecycleork:release-management -- Release process including changelog updatesVersion: 1.0.0 (March 2026)