documentation-patterns

Name: documentation-patterns
Availability: InStock
Author: Yonatan

Generate technical documentation templates for READMEs, ADRs, and OpenAPI 3.1 APIs.

217|20|Updated Dec 31, 2025

Search Tags:#changelog #documentation #openapi #adr #readme #api-docs

Ready to run

npx skills add https://github.com/yonatangross/orchestkit --skill documentation-patterns-yonatangross

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-patterns
Source: https://github.com/yonatangross/orchestkit/tree/main/plugins/ork/skills/documentation-patterns
Command: npx skills add https://github.com/yonatangross/orchestkit --skill documentation-patterns-yonatangross

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating consistent, high-quality technical documentation across various formats, ensuring clarity and maintainability for projects.

Core Features & Use Cases

Standardized Templates: Provides structured formats for READMEs, Architecture Decision Records (ADRs), and API documentation (OpenAPI 3.1).
Consistent Formatting: Ensures changelogs follow the Keep a Changelog standard and promotes clear, concise writing style.
Use Case: When starting a new open-source project, use this Skill to generate a comprehensive README with all essential sections, ensuring new contributors have a clear onboarding path.

Quick Start

Use the documentation-patterns skill to generate a README template for a new project.

Frequently Asked Questions about documentation-patterns

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I standardize project documentation across different formats like READMEs and API docs?▼

You can standardize project documentation by using opinionated structures and templates for technical docs. This skill provides standardized formats for READMEs, API documentation, and changelogs to ensure clarity and maintainability.

What is the best way to structure Architecture Decision Records for a new software project?▼

The best way to structure Architecture Decision Records is by using a standardized template. This skill provides opinionated structures for ADRs, ensuring your technical decisions are documented consistently and are easy to maintain.

How do I generate an OpenAPI 3.1 specification template for my API documentation?▼

You generate OpenAPI 3.1 API documentation by loading specific on-demand rule files for API Docs. This skill supports structured formats for API documentation using OpenAPI 3.1 to ensure consistent technical documentation.

Does this approach support the Keep a Changelog standard for project changelogs?▼

Yes, this approach supports the Keep a Changelog standard. It ensures your changelogs follow consistent formatting rules by providing dedicated rule files for the Changelog category to maintain high-quality technical documentation.

Can I load specific writing style guides on demand instead of applying all documentation rules at once?▼

Yes, you can load specific rule files on demand. The skill supports on-demand loading for categories like README, ADR, API Docs, Changelog, and Writing Style, so you only apply the documentation patterns you need.

What should be included in a comprehensive README template for open-source contributors?▼

A comprehensive README template should include all essential sections for a clear onboarding path. This skill generates structured README formats that provide new contributors with the necessary project context and setup instructions.