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
Decision gist · record as of 2026-07-28
Documentation Patterns provides templates for READMEs, ADRs, API specs, and changelogs to standardize your project documentation. 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.
Use it when
- Documentation Patterns includes structured ADR templates following industry best practices.
- Documentation Patterns provides OpenAPI 3.1 specification templates for comprehensive REST API documentation.
Verify before relying
Read SKILL.md below before installing (9 files). Open directory: indexed for reading, not audited.
Install
yonatangross/orchestkit/documentation-patterns · repository language: TypeScript
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently 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)
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
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Create standardized README with all essential sections for project”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
This skill provides templates and guidance for creating Architecture Decision Records—lightweight documents that preserve the reasoning behind major technical choices. It walks you through the Nygard format, covering context, decision, consequences, and alternatives, plus best practices for lifecycle management and team review. Use it when evaluating trade-offs or recording decisions that shape your system's future.
This skill has been split into five specialized sub-skills, each addressing a distinct testing need. Choose testing-unit for isolated logic, testing-e2e for browser automation, testing-integration for cross-boundary APIs and databases, testing-llm for AI evaluation, or testing-perf for load and performance work.
Technical Writing guides you through creating durable internal documentation for builders and operators—specs, architecture decisions, runbooks, migration paths, and implementation guides. It helps you classify your document type, gather evidence, choose the right structure, and apply mode-specific writing rules to keep technical knowledge clear and actionable.
A reference guide to building production-ready MCP servers with patterns for transport selection, OAuth authentication, tool composition, and security hardening. Covers 14 decision rules across server setup, advanced features, client integration, and ecosystem discovery, grounded in the latest stable specification.
Documentation Writer creates complete project documentation covering README files, API references, and inline code comments in multiple formats. It provides structured templates and examples to help you document features, installation steps, usage patterns, and contribution guidelines.
Documentation and ADRs helps teams record the reasoning behind significant technical decisions through structured Architecture Decision Records. Store decisions in `docs/decisions/` with context, alternatives considered, and consequences so future engineers and AI agents understand not just what was built, but why.