documentation-patterns
Documentation Patterns offers structured templates for READMEs, Architecture Decision Records, OpenAPI 3.1 specifications, changelogs, and technical writing conventions. Use this skill when establishing documentation standards, onboarding contributors, recording architectural decisions, or maintaining consistent API and release documentation across your projects.
Documentation Patterns provides templates for READMEs, ADRs, API specs, and changelogs to standardize your project documentation.
AI-generated summary based on this skill's SKILL.md
Install
yonatangross/orchestkit/documentation-patterns · repository language: TypeScript
git clone https://github.com/yonatangross/orchestkit
cp -r orchestkit/src/skills/documentation-patterns ~/.claude/skills/documentation-patternsnpx skillfed install yonatangross/orchestkit/documentation-patternsFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How to write a good README with documentation-patterns?
Documentation Patterns provides a standardized README template with all essential sections for your project. The template ensures consistent structure across your documentation, making it easier for contributors and users to find information. Use the template to include overview, installation, usage, contribution guidelines, and licensing sections in a clear, organized manner.
What is the architecture decision record format in documentation-patterns?
Documentation Patterns includes structured ADR templates following industry best practices. ADRs document architectural decisions in a consistent format, capturing the decision context, alternatives considered, and consequences. This structured approach helps teams record and communicate important technical choices, making it easier for new team members to understand the reasoning behind your system design.
How do I document REST APIs using documentation-patterns?
Documentation Patterns provides OpenAPI 3.1 specification templates for comprehensive REST API documentation. These patterns help you structure endpoint definitions, request/response schemas, authentication methods, and error handling in a standardized format. The OpenAPI approach enables automatic documentation generation and API client creation from your specifications.
What changelog format best practices does documentation-patterns recommend?
Documentation Patterns includes changelog templates following semantic versioning conventions and Keep a Changelog standards. The templates help you organize release notes by version, categorizing changes as Added, Changed, Deprecated, Removed, Fixed, or Security updates. This consistent format makes it easy for users to track project evolution and understand what changed between releases.
How can documentation-patterns help establish writing style conventions?
Documentation Patterns provides technical writing style guidelines to maintain consistency across all project documentation. These conventions cover tone, terminology, formatting, and structure, ensuring your README, API docs, ADRs, and changelogs follow a unified voice. Applying these patterns helps onboard contributors and improves documentation quality across your projects.
What documentation standards does documentation-patterns provide?
Documentation Patterns offers comprehensive templates and standards for project documentation including README structure, ADR format, OpenAPI 3.1 specifications, changelog conventions, and technical writing style. Licensed under MIT, these patterns help teams establish consistent documentation practices, making it easier to maintain quality documentation as projects grow and teams expand.
SKILL.md
rendered from the published skill — quoted content, verbatim
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 | 1 | HIGH | Starting a project, onboarding contributors |
| ADR | 1 | HIGH | Recording architecture decisions |
| [API |
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 9 files
src/skills/documentation-patterns/SKILL.md
src/skills/documentation-patterns/rules/_sections.md
src/skills/documentation-patterns/rules/_template.md
src/skills/documentation-patterns/rules/docs-adr-template.md
src/skills/documentation-patterns/rules/docs-api-openapi.md
src/skills/documentation-patterns/rules/docs-changelog-format.md
src/skills/documentation-patterns/rules/docs-readme-structure.md
src/skills/documentation-patterns/rules/docs-writing-style.md
src/skills/documentation-patterns/test-cases.json